SCRIPTING

Introduction

You can add response to events during play with the scripting languaje of Ollvaror Caves. First of all you must assign a tag to an actor who is going to be the trigger of the event.

Then you have to create a text file with the same name of the map with the extension "olsc". For example, if your map's name is "Example map", the file must be named "Example map.olsc".

The following script is an simple "hello world" example triggered on the death of the creature tagged as "miner".

All the scripts go in this ".olsc" file, like in this example:

The list of the events are the following:

The onload event is different because does't need neither admit an actor in declaration.

The onplayerentermodule doesn't admit an actor in declaration, but has a player. It triggers everytime a player enter o reenter the game. Is intended only for mechanical purposes, like sending big textures.

Switches have onturnon and onturnoff events.

Areas have onenter, onexit and onturnonevents.

Actors have ondie and onplayertak events.

Conditionals

You can include conditionals that evaluates the truth of it's assignment each time, for example:

The conditionals must end with an "end;" command.

messagecontains

Checks if a message contains an specific portion of text. Only uses a parameter, the text to check, for example:

Checks the player (or npc) has sent "die" in the message. Will be true if the player says "die bastard" or "do diet".

conditionalequal

Checks if a local variable has an specific value. Local variables are assigned by the abstract command "assign". Have two parameters, as seen in the example.

conditionaldifferent

Exactly the opossed to conditionalequal.

conditionalplayer

Checks if the actor is a player. Have no parameters.

conditionalfaction

Checks if the actor is in a faction.

The faction can be chaos, players and no.

conditionalfaction:players; and conditionaplayer:; are not the same, as npc have players faction.

conditionaltagequals

Checks if the actor have an especific tag. Never true for players.

conditionalcounterequal,conditionalcounterdifferent,conditionalcountermorethan,conditionalcounterlessthan

Similar to conditionalequal, but with entire numbers. Have a name and a entire value.

conditionalactorequal,conditionalactordifferent

Similar to conditionalequal, but variables are assigned to a specific actor.

conditionalglobalchangeto

Only to be used with "onglobalchange" event.

conditionalsometagalive, conditionalalltagalive, conditionalsometagdead, conditionalalltagdead

Checks the status of tagged actor and furnitures.

Abstract commands

Have no perceptible effect, but are necesary for advanced effects.

assign

Assigns a value on a variable.

actorassign

The same, for an actor.

setcounter

Assign an entire value to a counter

increasecounter, decreasecounter

Increases or decreases the value of a counter, by one or a value

sendtexture

Send a texture skipping the normal flux. Created to be used with "onplayerentersmodule".

SetSight

Stablish the sight range in pixels. The server sends the players objects in their sight range. However only works in 400-pixels cells, so it will round other values.

By default the value is 800, and cannot be reduced.

Actually only makes sense to view moving visuals which begins far away, but would enter de sight range in their moves.

Don't use if you don't need. It overloads the data transmission.

Perceptible commands

Do a perceptible effect.

accomplish

Finish an objetive of the game. Have a parameter.

It's posible to repeate the name if they're equal.

pause

Pauses de game for a time

message

Sends a message to all player in the chatbox

bigmessage, bigmessageto

Sends a message in a position of the screen. Bigmessage send to all player, and bigmessageto send to the player that triggers the event.

The parameters are (in order):

1. Text
2. Duration
3. X coord
4. Y coord
5. Size
6. Red component
7. Green component
8. Blue component

showimage, showimageto

Shows an image to all players, or to a player.

The effect of this line is best seen on this image:

The parameters are (in order):

1. Image. Need to be included in the map.
2. Duration
3. X coord
4. Y coord
5. (optional) X size
6. (optional) Y size
7. (optional) X displacement
8. (optional) Y displacement

visual

Creates a movile (or not) visual effect. It can be animated.

The parameters are (in order):

1. X coord
2. Y coord
3. Duration
4. Direction (left means flip the texture)
5. Disappearing time
6. Angle (for moving)
7. Velocity
8. Texture

We can create a snow falling effect repeting the following line:

addtrap

The parameters are (in order):

1. Tag
2. Step duration
3. Animation steps
4. Starting damage step
5. End damage step
6. Damage
7. Damage tipe (dark,flesh,cont,perf,cort)
8. Cycles (-1 for infinite)
9. Waiting between cycles
10. Faction (opcional) (chaos,players,no)

starttrap

Start a stopped trap (0 cycles left). Must be prepared previously with "addtrap", but it is not required to start until stopped.

The parameters are (in order):

1. Tag of the trap
2. Cycles

stoptrap

Stops a trap. It will conclude it cycle.

The parameter is:

1. Tag of the trap

Fades to black or other color.

The parameters are (in order):

1. Duration
2. Speed
3. (optional) Red component
4. (optional) Green component
5. (optional) Blue component

move

Moves a tagged tile to a direction.

The parameters are (in order):

1. Tag
2. Direction (up,down,left,right)
3. Distance
4. Speed
5. Type of movement (optional)
   • once (default)
   • simple (same)
   • return
   • cyclic
6. Stop time (optional)

setswitchoption

Set a parameter on a switch.

The parameters are (in order):

1. Tag of the switch
2. Parameter
   • autoreturn
   • return
   • reuse
3. Value

actormove

Sends an actor an order to change its home in the X axis.

caoscontagion

Assing a contagion to a tagged object (actor, furniture...)

assignpenalty

Create penalty for actors. Intended for "onenter".

assignlimit

Create limits for actors. Intended for "onenter".

The parameters are (in order):

1. Variable
   • Move
   • Jump
2. Value

removelimits, removeeffects

Remove all limits and effects.

Intended for areas. Tag must be empty when used on "onexit" event.

summon

Summon a creature at a position.

The parameters are (in order):

1. ID of the creature
2. X cord
3. Y cord
4. Tag (optional)

actortalk

An actor sends a message

heal

Create a healing effect. If not tag wil heal the trigger of the event.

equip

Replaces the inventory of the trigger.

The parameters are (in order):

1. ID of the weapon in right hand
2. ID of the weapon in left hand
3. ID of armor

Any parameter can be 0.

music

Sends the player the order to preload music.

musicmode

Sends the player the order to load a section of the preload music.

delay, enddelay

Delays the execution of a portion of script.

Delays can't be delayed.

actorassignglobal

As actorassign, but the value is stored on the server for further reading.

Global variables are saved on the hard drive when assigned, and read when the player joins game in the server in an individual file for each character.

Shall not be abused.

conditionalglobalactorequal,conditionalglobalactordifferent

Similar to conditionalactorequal, but stored on a file on the server. The values are read from the program memory, so can be abused.

assignglobal

As assign, but the value is stored on the server for further reading.

Global variables are saved on the hard drive when assigned, and read when the server launches.

Triggers onglobalchange in all games in the server.

Shall not be abused.

conditionalglobalequal,conditionalglobaldifferent

Similar to conditionalequal, but stored on a file on the server. The values are read from the program memory, so can be abused.

conditionalcheckattribute

Cheks if a character has an attribute.

You can use basic logic operators (==, >=, <=, < and >) and some attributes:

• str: strength
• agi: agility
• end: endurance
• wil: will
• int: intelligence
• lea: leadership
• pot: otence
• def: defense
• ext: extension
• mut: number of chaos mutations

proyectile

Creates a proyectile.

1. Faction
2. X coord
3. Y coord
4. Damage
5. Damage type
6. Width
7. Height
8. Speed
9. Lifetime
10. Angle in degrees
11. Direction (left means flip the texture)
12. Texture
13. Personaliced texture (only if Texture is "pers")

animate

Set the animation of a map surface.

1. Tag
2. Speed of the movement.

useswitch

Turn a tagged switch, if posible.

1. Tag

conditionalswitchon

Checks if tagged swith is on.

If multiple switch are tagged, checks if all are on.

conditionalswitchoff

Same as conditionalswitchoff.

conditionalrandom

Checks random circunstances.

1. Favorable cases.
2. Possible cases.

conditionalswitchon, conditionalswitchon

Cheks if a switch is on a position.

1. Tag of the switch.

playeroptionequal

Cheks if a player choose a particular option on an election. Only in "onplayerchoose" event.

1. Election
2. Option