Divinity Engine Wiki - User contributions [en]

Scripting

2018-12-11T18:20:05Z

Rimevan: /* CHECK or IF */

=Introduction=
The scripting system is currently used for the behaviour of characters and items. For characters this is only part of the behaviour, as many more systems influence this in the following priority:
<ul>
<li>Story: executing Osiris Tasks</li>
<li>Dialogs: dialog behaviour and animations</li>
<li>Statuses: dying, frozen, petrified, ...</li>
<li>Scripts: executing the current reaction or scriptframe</li></ul>
Scripts are the lowest priority and will only execute if none of the other systems want to do something. For items it's a lot simpler, as the scripting system is the only thing
that influences the items behaviour.

To create and modify scripts, use the [[Script_editor|script editor]]. Make sure to also [[Activating_Scripts|activate them]] so they can be checked for errors and actually apply to objects.

 
=Object Naming=
When you with to refer to objects/local instances from script or elsewhere, make sure to follow the [[Templates_explanation#Local_instances.2Ftemplates|correct naming convention]].
=Sections=
Before any section in a script, we can INCLUDE files. When you INCLUDE a file, you're telling the system to parse that file first.
 
===INIT===
In the INIT section you can declare global variables and inherit from other scripts. Global variables always start with % and can be accessed and modified everywhere (including other scripts, osiris, and in code). There are also EXTERN variables, which are exposed when you assign a script to an object so you can change the value for local instances of the script. The INIT section also contains the special variable '__Me', which contains the owner of the script. This is a character or item depending on the script type. Code will automatically fill this variable. 
Inheritance is done with the USING keyword and copies everything from the other script into the current script. This includes all global variables, reactions, scriptframes, and events. You can use USING SHARED if you intend to overwrite reactions, events, or scriptframes. 
An example INIT section:
<pre>
INIT
USING SHARED Base
CHARACTER:__Me
CHARACTER:%AnotherCharacter=null
FLOAT3:%CurrentPosition=null
EXTERN INT:%CanRun=1
</pre>

If you want to override a specific reaction, event, or scriptframe you have to specify this with the OVERRIDE keyword:
<pre>
REACTION TestReaction, 5 OVERRIDE
EVENT TestEvent OVERRIDE
SCRIPTFRAME TestFrame OVERRIDE
</pre>
If needed, you can also only inherit specific reactions, events, or scriptframes:
<pre>
USING ScriptName REACTION ReactionName,NewPriority
USING ScriptName EVENT EventName
USING ScriptName SCRIPTFRAME ScriptFrameName
</pre>
 
===BEHAVIOUR===
This section contains the actual behaviour of the object. It solely consists of a whole bunch of reactions, of which only 1 reaction can be active at the same time. The current reaction gets selected based on its priority and its CHECK. The priority defines how much it wants to be executed and the CHECK decided whether its possible to be executed. The reaction with the highest priority whose CHECK succeeds will be selected for execution:
<ul>
<li>The whole list of reactions is always sorted from HIGH to LOW priorities.</li>
<li>We then check in that order all the reactions with a higher priority of the current reaction and see if their CHECK succeeds.</li>
<li>As soon as a higher priority reaction's CHECK succeeds, it interrupts the current reaction and will start executing.</li>
</ul>
Important note: only the CHECKs of higher priority reactions are evaluated every frame. This means that the current reaction's CHECK is NOT reevaluated while it's executing! It could become invalid during the execution. This is also true when calling Reset(): execution simply restarts at the beginning of the current reaction without evaluating the CHECK conditions again.
On top of the priority and CHECKs there's also the USAGE keyword. A reaction needs to specify a USAGE context. You can pick the following USAGE contexts:
<ul>
<li>USAGE COMBAT: can only be executed during combat when its the turn of the object</li>
<li>USAGE WAITING: can only be executed during combat when waiting for its turn</li>
<li>USAGE PEACE: can only be executed when not in combat</li>
<li>USAGE ALL: can always be executed</li>
</ul>
A reaction can have its own local variables. These variables have to start with an underscore and can only be accessed within the reaction itself. 
As soon as a reaction is interrupted, the INTERRUPT event will be called immediately and you can execute some code to for example Reset the reaction. You can catch all INTERRUPTS or only specific interrupts (like the movement failed interrupt) and execute actions on the interrupt. If you catch a specific interrupt event you have the possibility to fill in variables for the event:
<ul>
<li>An underscore ('_'): this variable is not relevant for the event, it will not prevent the event from firing</li>
<li>A constant (e.g. "TestString") or a global variable: the variable has to be equal to this constant, otherwise the event will not be executed</li>
<li>A local variable: this variable will get filled with the variable from the event</li>
</ul>
Some examples:
<pre>
OnEnteredCombat(__Me, _) // Only catch the event when __Me entered combat, the second variable one is irrelevant
OnEnteredCombat(_, %GlobalItemVariable) // Only catch the event when %GlobalItemVariable entered combat, the first variable is irrelevant
OnEnteredCombat(_LocalCharacterVariable, _) // Always catches the event, and _LocalCharacterVariable contains the character that entered combat. BEWARE: _LocalCharacterVariable can be null if an item entered combat
</pre>
The actions during an interrupt are limited to immediate/simple actions, which can be executed immediately (e.g. CharacterMoveTo() is not allowed). Keep in mind though that a reaction can be interrupted for many reasons:
<ul>
<li>Higher priority reaction takes over.</li>
<li>Other system takes over: statuses/dialog/story</li>
<li>An exception was thrown in the script: e.g. pathfinding failed, ...</li>
<li>The object got culled (more details on culling can be found later on this page)</li>
</ul>
Important note: if a reaction gets interrupted and later gets resumed, it will continue executing where it got interrupted! (unless "Reset" was called in the INTERRUPT handler, in which case it will begin from the start again) 
An example BEHAVIOUR section:
<pre>
BEHAVIOUR
REACTION TestReaction, 5 // Priority 5
USAGE PEACE
VARS
CHARACTER:_TestCharacter
CHECK "(c1|c2)&!c3" // Reaction can be executed when one of the first 2 conditions passes, and the third condition doesn't pass
IsInSurface(__Me, SurfaceOil)
IsInDangerousSurface(__Me)
CharacterIsFloating(__Me)
ACTIONS
CharacterFleeFromSurface()
INTERRUPT
ON
OnMovementFailed(_) // Only when interrupted by a failed movement
ACTIONS
Reset()
</pre>
 
===STORY===
There are specific story "reactions" called scriptframes. These are almost exactly the same as reactions, but they don't have a priority or CHECK block. They are managed by Story (Osiris) and can be SET or INJECTED. We keep a stack of all currently set scriptframes. If something is on the stack, the current REACTION always gets interrupted! The stack is the highest priority and comes before BEHAVIOUR reactions! Example of stack behaviour:
<ul>
<li>When you push something, it is put on the top of the stack.</li>
<li>When you pop, the top scriptframe is removed (happens when it finished executing)</li>
</ul>
In our case: 
If you SET a scriptframe the stack gets cleared (Abort!) and the new scriptframe gets pushed on the stack. 
If you INJECT a scriptframe, it will just push a copy of it on the stack. You can keep injecting the same scriptframe on the stack and it will be executed multiple times. 
As soon as the TOP scriptframe is finished, it pops from the stack and the one below it starts/resumes executing. 
Just like with reactions, if you INJECT a new scriptframe and there was already a scriptframe on the stack active, it will get interrupted and later resume where it was before. The syntax for writing a SCRIPTFRAME is exactly the same as a REACTION (except for the lack of priority and CHECK, and the fact that they need to be in the STORY section).
 
===EVENTS===
This section contains all the events that we want to catch. Events are always immediately and completely executed! It cannot take multiple frames: it's a blocking call and will execute and return immediately when it's done. Even when the object is culled or offstage will it execute its events. Events are always thrown to all objects in the current level. An event can be thrown from code, osiris, or from script itself. 
In a reaction or scriptframe, each frame only 1 action gets executed at most. Let's take a piece of script from a REACTION:
<pre>
Set(%TargetPos,%Enemy)
CharacterEvent(%Enemy,"Attack!")
CharacterMoveTo(%TargetPos)
</pre>
In the example above, the first 2 lines will take 2 frames (1 frame per line). The third one will take as long as it takes for the character to move to the target position. However, in an event the actions get executed immediately. Even if it was 100 actions with IFs and WHILEs, it would be executed as it was 1 action. For that reason, you cannot use actions in events that need time (Sleep, CharacterMoveTo, ...). Additionally, the number of actions an event can execute is limited. If you exceed the limit, Osiris will log an error and exit the event. In fact, let me amaze you even more. If you throw a CharacterEvent in an event, that spawns a new event and is thrown on every character and item... even all those events are executed immediately before it gets to the next line. 
Just like INTERRUPTs in REACTIONs, EVENTs have to react on something (INTERRUPTs can and EVENTs must). The syntax is equal as well (more information on the event variables can be found in the REACTION INTERRUPT section). 
An example EVENTS section:
<pre>
EVENT TestInitEvent
ON
OnInit()
ACTIONS
IF "!c1"
IsEqual(%StartTrigger, null)
THEN
TeleportTo(__Me, %StartTrigger)
ENDIF
</pre>
 
=Variables=
===Types===
<ul>
<li>INTEGER and INTEGER64: 'whole' numbers. The difference between INTEGER and INTEGER64 is not relevant for the scripter (unless you care about really, really big numbers), as long as you make sure to pass the right type in actions. For example: -10, 0, 8, 102324, ...</li>
<li>FLOAT: all other numbers. For example: 0.1, -0.323, 8.3, ...</li>
<li>STRING and FIXEDSTRING: the difference between STRING and FIXEDSTRING is not important when scripting, just make sure to pass the correct type in actions. For example: "", "testString", "testing123", ... . Important note: do not start a string with the characters '%' or '_', as they will get recognized as a variable instead (it's not intended, it's a bug).</li>
<li>CHARACTER, ITEM, TRIGGER, and SPLINE: objects that are currently loaded in the game. This includes globals and locals of the curently loaded level. The script will assert if the script uses an object that isn't currently loaded. It will also warn you if the character's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_GLO_Dallis, S_MyFirstItem, ...</li>
<li>RELATION_TYPE: only used in a handful actions. A list of possible relation types can be found [[scripting_relation_types|here]].</li>
<li>SKILL_ID: the name/id of a skill as it can be found in [[skill_creation|SkillData]]. For example: Target_Bless, Projectile_Fireball, ...</li>
<li>SURFACE_TYPE: surface types can be found [[scripting_surface_types|here]].</li>
<li>STATUS_TYPE: status types can be found [[Scripting_status_types|here]].</li>
<li>CHARACTERSTAT_TYPE: characterstat types can be found [[Scripting_characterstat_types|here]].</li>
<li>ITEMSTAT_TYPE: itemstat types can be found [[Scripting_itemstat_types|here]].</li>
<li>WEAPON_TYPE: weapon types can be found [[Scripting_weapon_types|here]].</li>
<li>DAMAGE_TYPE: damage types can be found [[Scripting_damage_types|here]].</li>
<li>TALENT_TYPE: talent types can be found [[Scripting_talent_types|here]].</li>
<li>COMPARE_TYPE: compare types can be found [[Scripting_compare_types|here]].</li>
<li>COMPARE_FUNCTION: compare functions can be found [[Scripting_compare_functions|here]].</li>
<li>FLOAT3: floats are written as {number;number;number}, and can contain integers as well</li>
<li>CHARACTERTEMPLATE, ITEMTEMPLATE, and PROJECTILETEMPLATE: the script will warn you if the template's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_Chair_A, S_Human_Male_B, ...</li>
<li>POTION_ID: all loaded potions from stats</li>
<li>ABILITY_TYPE: ability types can be found [[Scripting_ability_types|here]].</li>
<li>DEATH_TYPE: death types can be found [[Scripting_death_types|here]].</li>
<li>STATUS_ID: all loaded statuses from stats</li>
<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[CombatAi_Archetypes_And_Modifiers|here]].</li>
<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types|here]].</li>
</ul>
 
===Lists===
Lists are a special parameter type and contain multiple parameters of a single type. 
Important note: Lists are more convenient, but they are slower than normal parameters. They also have a limited size, so don't try to fill them with thousands of entries. 
Declaring a list:
<pre>
LIST<INT>:%TestListInt // Fine
LIST<CHARACTER>:%TestListCharacter // Fine
LIST<LIST<INT>>:%TestListNested // Error, can't nest lists
</pre>
Adding entries:
<pre>
ListAdd(%TestListInt, 0) // Fine
ListAdd(%TestListInt, {0;1;2}) // Error, trying to add a FLOAT3 to an INT LIST
</pre>
Removing entries: indices start at 1, and end at the list size. All entries after the removed entry will be shifted to the left:
<pre>
ListRemove(%TestListInt, 1) // Fine, assuming that the list has 1 or more entries
ListRemove(%TestListInt, 0) // Error, invalid index
</pre>
Setting or getting entries:
<pre>
ListSet(%TestListInt, 1, %AnInt) // Fine
ListGet(%TestListInt, 1, %AnInt)

ListSet(%TestListInt, 1, %ACharacter) // Error, trying to set a CHARACTER in an INT LIST
ListGet(%TestListInt, 1, %ACharacter)

ListSet(%TestListInt, 0, %AnInt) // Error, invalid index
ListGet(%TestListInt, 0, %AnInt)
</pre>
Getting the list size:
<pre>
ListGetSize(%TestList, %ListSize)
</pre>
Clearing a list:
<pre>
ListClear(%TestList)
</pre>
Important note: Lists currently do not support EXTERN, constants, and STRING , meaning that the following lines will not work in scripts and result in an error during script build:
<pre>
LIST<INT>:%TestList = {1, 2, 3, 4, 5} // Using a constant to initialize
ListGetSize({1, 2, 3, 4}, %ListSize) // Using a constant in an action call
EXTERN LIST<INT>:%TestList = {1, 2} // Using EXTERN and using a constant to initialize
LIST<STRING>:%TestString // Using STRING as the type
</pre>
Now, how would you use these lists?
 

=Important Events=
===OnInit and OnShutDown===
OnInit is called each time on all objects in the level when the level is loaded, and OnShutdown is called when the level is unloaded. This would be the place where you can create/destroy your looping effects that should always be on the object.
 
===OnLoaded===
OnLoaded is called when the savegame is loaded or when the levelcache is loaded (levelswap). The version of the savegame is passed so you can do your patching "hacks" if necessary.
 
===Interrupts===
Interrupts are only called on reactions and can only be caught on that reaction:
<ul>
<li>OnBetterReactionFound: a higher priority reaction succeeded its check</li>
<li>OnNoReactionFound: no reaction has succeeded its check</li>
<li>OnScriptDisabled: another system has taken control (dialogs, statuses, story)</li>
<li>OnManualInterrupt: the Interrupt action itself has caused the interrupt</li>
<li>OnMovementFailed: pathfinding has failed to find a path to the target</li>
<li>OnException: a character task has failed</li></ul>
 
===OnFunction===
You can create your own "functions' with CallFunction("functionName") and catching the event OnFunction("functionName"). This way you can share functionality between multiple events and reactions. You can not pass parameters directly, but you could set some function-specific global variables which the function uses and can even 'return' results in.
 
=Culling=
For performance reasons we only update a small set of all the characters & items in the level. 
The updating characters are:
<ul>
<li>Force updating (can be set in script/story, but should only be used in an emergency!)</li>
<li>In Combat</li>
<li>Executing Osiris Tasks</li>
<li>In range of the party (within 40m)</li>
</ul>
The updating items are:
<ul>
<li>Force updating (can be set in script/story using ItemSetForceSynch(), but should only be used in an emergency!)</li>
<li>In Combat</li>
<li>Moving</li>
<li>In range of the party (within 40m)</li>
</ul>
This means that in most cases objects far away from the party get culled and stop updating. When an object doesn't update anymore this means the behaviour is interrupted and won't be executed anymore. However, events always get executed, so culling has no impact on this. Another consequence of culling is that timers of that script are not ticking anymore and are basically paused.
 
=Debugging=
There are 4 ways to help you debug:
<ul>
<li>The script debugger in the script editor</li>
<li>CTRL+SHIFT+ClICK on the object you wish to debug to show the Script Screen, and CTRL+SHIFT+SCROLL to the Script and/or Variables screen to see what the current state is.</li>
<li>Add a whole bunch of DebugText output in your code to see which code is called in what order.</li>
<li>Start the script log for an object, which logs as much stuff as possible about the script (reactions, interrupts, events, ...)</li>
</ul>
 
===Script Debugger===
See the [[script_debugger|Script Debugger]] page for more information.
 
===Script Screen===
On the left side of the Script Screen it shows the script variables, the script reactions (ordered from high priority to low), and the current Event it catches. It colors the reactions gray (not checked), green (check passed), and red (check failed). At the right you can see the current reaction's conditions and actions. You can see which action is currently executing and you can see the return results of the conditions from the check: gray (not evaluated), green (TRUE), and red (FALSE). 
You can filter in the script variables through the [[console|console]] by using: "filtervar <filter>".
Tip: type "filtervar asdf" or something to remove all variables so you can see all the reactions! 
You can also change which reaction you want to see at the right, by entering the number of that reaction in the console. This way you can easily check why certain reactions are never succeeding their CHECK by checking the return values of the conditions. To do this first you must activate this mode, by entering "show server" in the console. Then you can type the number of the wanted reaction or type "0" to show the current reaction again.
 
===DebugText===
You can put DebugText in events/scriptframes/reactions to print text in the world on any object you want. This way you can easily see if you get in the code you wrote and you can also print any variable's value at that time. To print the variables we use the same syntax as translated strings: [1] [2] [3] ... 
For example:
<pre>
DebugText(__Me,"Target: [1], Speed is [2]",_Target,%Speed)
</pre>
For characters, items, triggers, splines, and templates the name will be shown in the debug text. Numbers will be shown in full, and all other variables will be directly converted to strings.
 
===ScriptLog===
You can also start/stop the scriptlog in console with:
<ul>
<li>"ai log all": Start the scriptlog for all character/items.</li>
<li>"ai log none": Stop the scriptlog for all character/items.</li>
<li>"ai log selected": Toggle the separate scriptlog for the selected (CTRL+SHIFT+CLICK) object</li>
</ul>
It will generate scriptlog file(s) right next to the executable.
 
=Common Mistakes=
===Reset()===
<pre>
REACTION CastSkill, 1000
USAGE COMBAT
VARS
FLOAT:_minRange
FLOAT:_maxRange
CHECK "!c1&c2&c3"
IsEqual(%SkillTarget,null)
CharacterCanCast(__Me,Projectile_Fireball,0)
CharacterGetSkillRange(_minRange,_maxRange,__MeProjectile_Fireball)
ACTIONS
CharacterMoveInRange(%SkillTarget,_minRange,_maxRange,1)
PlayEffectAt(__Me, "FX_GP_HugeFireball_A")
CharacterUseSkill(Projectile_Fireball,%SkillTarget)
</pre>
In this case we have a reaction that will move in range of the target and as soon as we are in range we will play an effect and cast a fireball. However, if this reaction gets interrupted during the playeffect, next time this reaction becomes active again we will just cast a fireball on the target even when we would not be in range and didn't play the effect. This is why in these cases you should add an INTERRUPT to Reset() the reaction.

===CHECK or IF===
<pre>
REACTION CastSkill,1000
USAGE COMBAT
VARS
FLOAT:_minRange
FLOAT:_maxRange
CHECK "!c1&c2"
IsEqual(%SkillTarget,null)
CharacterGetSkillRange(_minRange,_maxRange,__MeProjectile_Fireball)
ACTIONS
IF "c1"
CharacterCanCast(__Me,Projectile_Fireball,0)
THEN
CharacterMoveInRange(%SkillTarget,_minRange,_maxRange,1)
PlayEffectAt(__Me, "FX_GP_HugeFireball_A")
CharacterUseSkill(Projectile_Fireball,%SkillTarget)
ENDIF
INTERRUPT
ACTIONS
Reset()
</pre>
In this case we're checking something in the reaction when it's executing, but we don't do anything if the IF fails. There is no ELSE behaviour. This means that in combat this reaction could keep failing and not do anything, which will cause a ForceEndTurn for that character. Here we should have checked CharacterCanCast in the CHECK and not write a separate IF check. In general when the IF check in a REACTION is blocking the whole REACTION from executing it's probably better to place it in the CHECK instead.
 

===Check order===
<pre>
IF "c1&c2&!c3&c4"
CharacterGetStat(_Vitality, __Me, Vitality) // Fetch before checking
IsGreaterThen(_Vitality, 0.5)
IsEqual(_Character, null) // Null check before checking
CharacterIsPlayer(_Character)
THEN
// Do something
ENDIF
</pre>
Make sure to perform your checks in the right order. Before checking a stat make sure to fetch it. Before checking if the character is a player consider checking if it is a valid player. Could it be the player is off stage? Could it be dead? Is it even set?
 
===AD interrupts===

[[Category:Behaviour_Scripts]]

Talk:Scripting

2018-12-11T18:19:49Z

Rimevan: /* Mistakes/Typos */

=== Mistakes/Typos ===

In the section "CHECK or IF", ACTIONS needs to be declared after the INTERRUPT, above Reset().

[[User:LaughingLeader|LaughingLeader]] ([[User talk:LaughingLeader|talk]]) 19:10, 11 December 2018 (CET)

Well spotted, fixed :)

--[[User:Rimevan|Rimevan]] ([[User talk:Rimevan|talk]]) 19:19, 11 December 2018 (CET)

=== Misc ===

Some very useful information here. I'm slightly confused about the purpose of SCRIPTFRAMES. It would be nice to see an example of one, including the Osiris code. Also an example of a LIST in action would be nice. I also think the example EVENT is not super helpful, since most people aren't going to know what the archetypes are.

I also find the Behavior example confusing. It looks like maybe there's a ! on the second condition (for dangerous surfaces), that shouldn't be there?

Under common mistakes there's CHECK or IF. Are there situations where you would use IF over CHECK in behavior?

Another common mistake I think could be checking things in the wrong order. Something like:

IsGreaterThen(_Vitality,.5)
CharacterGetStat(_Vitality,__Me,Vitality)

(I mean, that is a mistake, right?)

Will DebugText print the text exactly as you put it in? Like printing out the float value 0.47 exactly as "0.47"?

Going over types of variables (INT, FLOAT, FIXEDSTRING, STATUS, CHARACTERTEMPLATE, etc.) here or somewhere else would be useful too.

Talk:Scripting

2018-12-11T18:19:40Z

Rimevan: /* Mistakes/Typos */

=== Mistakes/Typos ===

In the section "CHECK or IF", ACTIONS needs to be declared after the INTERRUPT, above Reset().

[[User:LaughingLeader|LaughingLeader]] ([[User talk:LaughingLeader|talk]]) 19:10, 11 December 2018 (CET)

Well spotted, fixed :)
--[[User:Rimevan|Rimevan]] ([[User talk:Rimevan|talk]]) 19:19, 11 December 2018 (CET)

=== Misc ===

Some very useful information here. I'm slightly confused about the purpose of SCRIPTFRAMES. It would be nice to see an example of one, including the Osiris code. Also an example of a LIST in action would be nice. I also think the example EVENT is not super helpful, since most people aren't going to know what the archetypes are.

I also find the Behavior example confusing. It looks like maybe there's a ! on the second condition (for dangerous surfaces), that shouldn't be there?

Under common mistakes there's CHECK or IF. Are there situations where you would use IF over CHECK in behavior?

Another common mistake I think could be checking things in the wrong order. Something like:

IsGreaterThen(_Vitality,.5)
CharacterGetStat(_Vitality,__Me,Vitality)

(I mean, that is a mistake, right?)

Will DebugText print the text exactly as you put it in? Like printing out the float value 0.47 exactly as "0.47"?

Going over types of variables (INT, FLOAT, FIXEDSTRING, STATUS, CHARACTERTEMPLATE, etc.) here or somewhere else would be useful too.

Talk:Scripting surface types

2018-04-04T11:00:21Z

Rimevan: /* Changing to ordered list */

=Can't Edit=
Apparently I can't edit, so here's an ordered list so you don't have to count to the surface you are curious about.

<ol start="-1">
<li>SurfaceNone</li>
<li>SurfaceFire</li>
<li>SurfaceFireBlessed</li>
<li>SurfaceFireCursed</li>
<li>SurfaceFirePurified</li>
<li>SurfaceWater</li>
<li>SurfaceWaterElectrified</li>
<li>SurfaceWaterFrozen</li>
<li>SurfaceWaterBlessed</li>
<li>SurfaceWaterElectrifiedBlessed</li>
<li>SurfaceWaterFrozenBlessed</li>
<li>SurfaceWaterCursed</li>
<li>SurfaceWaterElectrifiedCursed</li>
<li>SurfaceWaterFrozenCursed</li>
<li>SurfaceWaterPurified</li>
<li>SurfaceWaterElectrifiedPurified</li>
<li>SurfaceWaterFrozenPurified</li>
<li>SurfaceBlood</li>
<li>SurfaceBloodElectrified</li>
<li>SurfaceBloodFrozen</li>
<li>SurfaceBloodBlessed</li>
<li>SurfaceBloodElectrifiedBlessed</li>
<li>SurfaceBloodFrozenBlessed</li>
<li>SurfaceBloodCursed</li>
<li>SurfaceBloodElectrifiedCursed</li>
<li>SurfaceBloodFrozenCursed</li>
<li>SurfaceBloodPurified</li>
<li>SurfaceBloodElectrifiedPurified</li>
<li>SurfaceBloodFrozenPurified</li>
<li>SurfacePoison</li>
<li>SurfacePoisonBlessed</li>
<li>SurfacePoisonCursed</li>
<li>SurfacePoisonPurified</li>
<li>SurfaceOil</li>
<li>SurfaceOilBlessed</li>
<li>SurfaceOilCursed</li>
<li>SurfaceOilPurified</li>
<li>SurfaceLava</li>
<li>SurfaceSource</li>
<li>SurfaceWeb</li>
<li>SurfaceWebBlessed</li>
<li>SurfaceWebCursed</li>
<li>SurfaceWebPurified</li>
<li>SurfaceDeepwater</li>
<li>SurfaceFireCloud</li>
<li>SurfaceFireCloudBlessed</li>
<li>SurfaceFireCloudCursed</li>
<li>SurfaceFireCloudPurified</li>
<li>SurfaceWaterCloud</li>
<li>SurfaceWaterCloudElectrified</li>
<li>SurfaceWaterCloudBlessed</li>
<li>SurfaceWaterCloudElectrifiedBlessed</li>
<li>SurfaceWaterCloudCursed</li>
<li>SurfaceWaterCloudElectrifiedCursed</li>
<li>SurfaceWaterCloudPurified</li>
<li>SurfaceWaterCloudElectrifiedPurified</li>
<li>SurfaceBloodCloud</li>
<li>SurfaceBloodCloudElectrified</li>
<li>SurfaceBloodCloudBlessed</li>
<li>SurfaceBloodCloudElectrifiedBlessed</li>
<li>SurfaceBloodCloudCursed</li>
<li>SurfaceBloodCloudElectrifiedCursed</li>
<li>SurfaceBloodCloudPurified</li>
<li>SurfaceBloodCloudElectrifiedPurified</li>
<li>SurfacePoisonCloud</li>
<li>SurfacePoisonCloudBlessed</li>
<li>SurfacePoisonCloudCursed</li>
<li>SurfacePoisonCloudPurified</li>
<li>SurfaceSmokeCloud</li>
<li>SurfaceSmokeCloudBlessed</li>
<li>SurfaceSmokeCloudCursed</li>
<li>SurfaceSmokeCloudPurified</li>
<li>SurfaceExplosionCloud</li>
<li>SurfaceFrostCloud</li>
<li>SurfaceDeathfogCloud</li>
</ol>
[[User:Lofgren|Lofgren]] ([[User talk:Lofgren|talk]]) 06:52, 4 April 2018 (CEST)

== Changing to ordered list ==

That's actually really useful, I added the actual values of the surface types to the list :) However, I do advise to use the actual enumeration instead of the integer representation. The values might change after all.
:The integers are returned by some functions and used as inputs in others, so it's helpful to know. Hopefully they wouldn't change something so fundamental at this point, but I guess you never know.[[User:Lofgren|Lofgren]] ([[User talk:Lofgren|talk]]) 12:40, 4 April 2018 (CEST)
::Ah, but it's better to use e.g. 'SurfaceFire' instead of '0'. The value of 'SurfaceFire' might change its value from '0' to '1' for some reason and in that case it wouldn't break anything if you used 'SurfaceFire' as the value. 'SurfaceFire' represents a value in code, but you don't have to worry about what exactly that value is. When you start using actual numbers you certainly have to worry about possible changes. [[User:Rimevan|Rimevan]] ([[User talk:Rimevan|talk]]) 13:00, 4 April 2018 (CEST)

Scripting surface transform types

2018-04-04T07:32:24Z

Rimevan:

Scripting death types

2018-04-04T07:30:37Z

Rimevan:

Scripting ability types

2018-04-04T07:29:50Z

Rimevan:

Scripting compare functions

2018-04-04T07:27:26Z

Rimevan:

Scripting compare types

2018-04-04T07:26:24Z

Rimevan:

Scripting talent types

2018-04-04T07:25:35Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
It is advised to use the enumeration value instead of the integer representation because this list is subject to change. The following talent types can be used in script:
<ol>
<li>ItemMovement</li>
<li>ItemCreation</li>
<li>Flanking</li>
<li>AttackOfOpportunity</li>
<li>Backstab</li>
<li>Trade</li>
<li>Lockpick</li>
<li>ChanceToHitRanged</li>
<li>ChanceToHitMelee</li>
<li>Damage</li>
<li>ActionPoints</li>
<li>ActionPoints2</li>
<li>Criticals</li>
<li>IncreasedArmor</li>
<li>Sight</li>
<li>ResistFear</li>
<li>ResistKnockdown</li>
<li>ResistStun</li>
<li>ResistPoison</li>
<li>ResistSilence</li>
<li>ResistDead</li>
<li>Carry</li>
<li>Throwing</li>
<li>Repair</li>
<li>ExpGain</li>
<li>ExtraStatPoints</li>
<li>ExtraSkillPoints</li>
<li>Durability</li>
<li>Awareness</li>
<li>Vitality</li>
<li>FireSpells</li>
<li>WaterSpells</li>
<li>AirSpells</li>
<li>EarthSpells</li>
<li>Charm</li>
<li>Intimidate</li>
<li>Reason</li>
<li>Luck</li>
<li>Initiative</li>
<li>InventoryAccess</li>
<li>AvoidDetection</li>
<li>AnimalEmpathy</li>
<li>Escapist</li>
<li>StandYourGround</li>
<li>SurpriseAttack</li>
<li>LightStep</li>
<li>ResurrectToFullHealth</li>
<li>Scientist</li>
<li>Raistlin</li>
<li>MrKnowItAll</li>
<li>WhatARush</li>
<li>FaroutDude</li>
<li>Leech</li>
<li>ElementalAffinity</li>
<li>FiveStarRestaurant</li>
<li>Bully</li>
<li>ElementalRanger</li>
<li>LightningRod</li>
<li>Politician</li>
<li>WeatherProof</li>
<li>LoneWolf</li>
<li>Zombie</li>
<li>Demon</li>
<li>IceKing</li>
<li>Courageous</li>
<li>GoldenMage</li>
<li>WalkItOff</li>
<li>FolkDancer</li>
<li>SpillNoBlood</li>
<li>Stench</li>
<li>Kickstarter</li>
<li>WarriorLoreNaturalArmor</li>
<li>WarriorLoreNaturalHealth</li>
<li>WarriorLoreNaturalResistance</li>
<li>RangerLoreArrowRecover</li>
<li>RangerLoreEvasionBonus</li>
<li>RangerLoreRangedAPBonus</li>
<li>RogueLoreDaggerAPBonus</li>
<li>RogueLoreDaggerBackStab</li>
<li>RogueLoreMovementBonus</li>
<li>RogueLoreHoldResistance</li>
<li>NoAttackOfOpportunity</li>
<li>WarriorLoreGrenadeRange</li>
<li>RogueLoreGrenadePrecision</li>
<li>WandCharge</li>
<li>DualWieldingDodging</li>
<li>Human_Inventive</li>
<li>Human_Civil</li>
<li>Elf_Lore</li>
<li>Elf_CorpseEating</li>
<li>Dwarf_Sturdy</li>
<li>Dwarf_Sneaking</li>
<li>Lizard_Resistance</li>
<li>Lizard_Persuasion</li>
<li>Perfectionist</li>
<li>Executioner</li>
<li>ViolentMagic</li>
<li>QuickStep</li>
<li>Quest_SpidersKiss_Str</li>
<li>Quest_SpidersKiss_Int</li>
<li>Quest_SpidersKiss_Per</li>
<li>Quest_SpidersKiss_Null</li>
<li>Memory</li>
<li>Quest_TradeSecrets</li>
<li>Quest_GhostTree</li>
<li>BeastMaster</li>
<li>LivingArmor</li>
<li>Torturer</li>
<li>Ambidextrous</li>
<li>Unstable</li>
<li>ResurrectExtraHealth</li>
<li>NaturalConductor</li>
<li>Quest_Rooted</li>
</ol>

Scripting characterstat types

2018-04-04T07:19:22Z

Rimevan:

Scripting damage types

2018-04-04T07:16:58Z

Rimevan:

Scripting damage types

2018-04-04T07:15:57Z

Rimevan:

Scripting weapon types

2018-04-04T07:15:33Z

Rimevan:

Scripting itemstat types

2018-04-04T07:12:16Z

Rimevan:

Scripting characterstat types

2018-04-04T07:08:20Z

Rimevan:

Scripting status types

2018-04-04T07:07:40Z

Rimevan:

Talk:Scripting surface types

2018-04-04T07:06:15Z

Rimevan: /* Changing to ordered list */

Scripting relation types

2018-04-04T07:04:32Z

Rimevan:

Scripting surface types

2018-04-04T07:04:05Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
It is advised to use the enumeration value instead of the integer representation because this list is subject to change. The following surface types can be used in behavior scripts:
<ol start=-1>
<li>SurfaceNone</li>
<li>SurfaceFire</li>
<li>SurfaceFireBlessed</li>
<li>SurfaceFireCursed</li>
<li>SurfaceFirePurified</li>
<li>SurfaceWater</li>
<li>SurfaceWaterElectrified</li>
<li>SurfaceWaterFrozen</li>
<li>SurfaceWaterBlessed</li>
<li>SurfaceWaterElectrifiedBlessed</li>
<li>SurfaceWaterFrozenBlessed</li>
<li>SurfaceWaterCursed</li>
<li>SurfaceWaterElectrifiedCursed</li>
<li>SurfaceWaterFrozenCursed</li>
<li>SurfaceWaterPurified</li>
<li>SurfaceWaterElectrifiedPurified</li>
<li>SurfaceWaterFrozenPurified</li>
<li>SurfaceBlood</li>
<li>SurfaceBloodElectrified</li>
<li>SurfaceBloodFrozen</li>
<li>SurfaceBloodBlessed</li>
<li>SurfaceBloodElectrifiedBlessed</li>
<li>SurfaceBloodFrozenBlessed</li>
<li>SurfaceBloodCursed</li>
<li>SurfaceBloodElectrifiedCursed</li>
<li>SurfaceBloodFrozenCursed</li>
<li>SurfaceBloodPurified</li>
<li>SurfaceBloodElectrifiedPurified</li>
<li>SurfaceBloodFrozenPurified</li>
<li>SurfacePoison</li>
<li>SurfacePoisonBlessed</li>
<li>SurfacePoisonCursed</li>
<li>SurfacePoisonPurified</li>
<li>SurfaceOil</li>
<li>SurfaceOilBlessed</li>
<li>SurfaceOilCursed</li>
<li>SurfaceOilPurified</li>
<li>SurfaceLava</li>
<li>SurfaceSource</li>
<li>SurfaceWeb</li>
<li>SurfaceWebBlessed</li>
<li>SurfaceWebCursed</li>
<li>SurfaceWebPurified</li>
<li>SurfaceDeepwater</li>
<li>SurfaceFireCloud</li>
<li>SurfaceFireCloudBlessed</li>
<li>SurfaceFireCloudCursed</li>
<li>SurfaceFireCloudPurified</li>
<li>SurfaceWaterCloud</li>
<li>SurfaceWaterCloudElectrified</li>
<li>SurfaceWaterCloudBlessed</li>
<li>SurfaceWaterCloudElectrifiedBlessed</li>
<li>SurfaceWaterCloudCursed</li>
<li>SurfaceWaterCloudElectrifiedCursed</li>
<li>SurfaceWaterCloudPurified</li>
<li>SurfaceWaterCloudElectrifiedPurified</li>
<li>SurfaceBloodCloud</li>
<li>SurfaceBloodCloudElectrified</li>
<li>SurfaceBloodCloudBlessed</li>
<li>SurfaceBloodCloudElectrifiedBlessed</li>
<li>SurfaceBloodCloudCursed</li>
<li>SurfaceBloodCloudElectrifiedCursed</li>
<li>SurfaceBloodCloudPurified</li>
<li>SurfaceBloodCloudElectrifiedPurified</li>
<li>SurfacePoisonCloud</li>
<li>SurfacePoisonCloudBlessed</li>
<li>SurfacePoisonCloudCursed</li>
<li>SurfacePoisonCloudPurified</li>
<li>SurfaceSmokeCloud</li>
<li>SurfaceSmokeCloudBlessed</li>
<li>SurfaceSmokeCloudCursed</li>
<li>SurfaceSmokeCloudPurified</li>
<li>SurfaceExplosionCloud</li>
<li>SurfaceFrostCloud</li>
<li>SurfaceDeathfogCloud</li>
</ol>

Talk:Scripting surface types

2018-04-04T07:01:53Z

Rimevan: /* Changing to ordered list */ new section

Scripting surface types

2018-04-04T06:59:43Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following surface types can be used in behavior scripts:
<ol start=-1>
<li>SurfaceNone</li>
<li>SurfaceFire</li>
<li>SurfaceFireBlessed</li>
<li>SurfaceFireCursed</li>
<li>SurfaceFirePurified</li>
<li>SurfaceWater</li>
<li>SurfaceWaterElectrified</li>
<li>SurfaceWaterFrozen</li>
<li>SurfaceWaterBlessed</li>
<li>SurfaceWaterElectrifiedBlessed</li>
<li>SurfaceWaterFrozenBlessed</li>
<li>SurfaceWaterCursed</li>
<li>SurfaceWaterElectrifiedCursed</li>
<li>SurfaceWaterFrozenCursed</li>
<li>SurfaceWaterPurified</li>
<li>SurfaceWaterElectrifiedPurified</li>
<li>SurfaceWaterFrozenPurified</li>
<li>SurfaceBlood</li>
<li>SurfaceBloodElectrified</li>
<li>SurfaceBloodFrozen</li>
<li>SurfaceBloodBlessed</li>
<li>SurfaceBloodElectrifiedBlessed</li>
<li>SurfaceBloodFrozenBlessed</li>
<li>SurfaceBloodCursed</li>
<li>SurfaceBloodElectrifiedCursed</li>
<li>SurfaceBloodFrozenCursed</li>
<li>SurfaceBloodPurified</li>
<li>SurfaceBloodElectrifiedPurified</li>
<li>SurfaceBloodFrozenPurified</li>
<li>SurfacePoison</li>
<li>SurfacePoisonBlessed</li>
<li>SurfacePoisonCursed</li>
<li>SurfacePoisonPurified</li>
<li>SurfaceOil</li>
<li>SurfaceOilBlessed</li>
<li>SurfaceOilCursed</li>
<li>SurfaceOilPurified</li>
<li>SurfaceLava</li>
<li>SurfaceSource</li>
<li>SurfaceWeb</li>
<li>SurfaceWebBlessed</li>
<li>SurfaceWebCursed</li>
<li>SurfaceWebPurified</li>
<li>SurfaceDeepwater</li>
<li>SurfaceFireCloud</li>
<li>SurfaceFireCloudBlessed</li>
<li>SurfaceFireCloudCursed</li>
<li>SurfaceFireCloudPurified</li>
<li>SurfaceWaterCloud</li>
<li>SurfaceWaterCloudElectrified</li>
<li>SurfaceWaterCloudBlessed</li>
<li>SurfaceWaterCloudElectrifiedBlessed</li>
<li>SurfaceWaterCloudCursed</li>
<li>SurfaceWaterCloudElectrifiedCursed</li>
<li>SurfaceWaterCloudPurified</li>
<li>SurfaceWaterCloudElectrifiedPurified</li>
<li>SurfaceBloodCloud</li>
<li>SurfaceBloodCloudElectrified</li>
<li>SurfaceBloodCloudBlessed</li>
<li>SurfaceBloodCloudElectrifiedBlessed</li>
<li>SurfaceBloodCloudCursed</li>
<li>SurfaceBloodCloudElectrifiedCursed</li>
<li>SurfaceBloodCloudPurified</li>
<li>SurfaceBloodCloudElectrifiedPurified</li>
<li>SurfacePoisonCloud</li>
<li>SurfacePoisonCloudBlessed</li>
<li>SurfacePoisonCloudCursed</li>
<li>SurfacePoisonCloudPurified</li>
<li>SurfaceSmokeCloud</li>
<li>SurfaceSmokeCloudBlessed</li>
<li>SurfaceSmokeCloudCursed</li>
<li>SurfaceSmokeCloudPurified</li>
<li>SurfaceExplosionCloud</li>
<li>SurfaceFrostCloud</li>
<li>SurfaceDeathfogCloud</li>
</ol>

Combat AI

2018-03-13T13:21:54Z

Rimevan: /* Skills */

=Introduction=
Ai 2.0 or, as we'd like to call it, Jane (used to be an abbreviation, but we already forgot about it the next day) no longer uses a script for every single skill to reason about its usage. Almost all logic has been moved to code, and all that's left in script is starting the Ai calculation, stopping the Ai calculation, and executing the action that has been selected by Ai. This script logic can be found in DefaultBehaviour.charScript. The Ai now takes into account the properties of a skill, the statuses that are applied, the weapons that are used, the items nearby, etc. Besides being smarter in general it also fixes a lot of issues with Ai ending turns we had in D:OS. It (attempts) to simulate what's going to happen if it will use a certain skill at a certain target and assign a score to it. The action with the highest score will be executed. All this happens automatically, so a new skill or status can be used by Ai without any extra steps. Of course, there are exceptions, and you'd still like to guide or override the Ai from time to time. That's what this page tries to cover in detail.

=How does it work=
When trying to guide or override the Ai it's useful to know why the Ai is doing what it's doing. I'll try to explain the general approach the Ai takes in one turn to decide what action it will take, and try to refrain from using too many implementation details. First of all, let me explain a couple of terms up front that might also also be useful when touching [[CombatAi_Archetypes_And_Modifiers|archetypes and modifiers]]:
<ul>
<li>Action: walking to a position (if needed) and using a skill on one or multiple targets, or a fallback (finding a preferable position if no other action is viable)</li>
<li>ActionScore: the score of the use of a skill</li>
<li>PositionScore: the score of a position, based on surfaces that may be on that position, allies or enemies in the vicinity, etc.</li>
<li>MovementScore: the score of moving from A to B, based on PositionScores on the path from A to B</li>
<li>ActionCostModifier: the modifier combined from multiple modifiers that determines the total 'action cost' of an action, including AP and SP</li>
<li>CostModifier: the modifier combined from multiple modifiers that determines the total 'cost' of an action. Affected by e.g. items being used, cooldowns, etc.</li>
</ul>
 
Let's say the Ai has the Projectile_Fireball skill and go through the steps that the Ai takes to calculate the scores for possible actions:
# Check first: can we cast this skill? Skill conditions, cooldowns, difficulty mode, statuses preventing us from casting, etc. No need to calculate anything if we can't even cast.
# Find interesting targets to cast the skill on. Ai checks for characters, items (barrels could explode), and positions on the terrain. We run a simulation on each of these targets to see what effect it will have. This simulation on every target gives us damage scores, health scores, buff scores, etc. for every object we hit (the ActionScore).
# Calculate the 'final' score of every Action (at this point this is purely the skill being casted). The different scores are thrown together, affected by a whole bunch of target specific [[CombatAi_Archetypes_And_Modifiers|modifiers]], and balanced so that we end up with one single value for the score.
# Only the interesting Actions, based on the 'final' score in the previous step, will be investigated further. We start to find a good position to cast from. The character might not be able to cast from it's current position (out of sight, out of range, etc.), or the character might not like its current position due to nearby enemies. PositionScores will be calculated and we hope to find a good position for every action.
# After finding a good position we start calculating the MovementScore. Does the character need to walk through a fire surface? Could we jump instead of walking? Do I have enough AP to even walk there this turn?
# In the end only one Action will be on top. We have a skill (or default attack), a target, a position, and even the path has been checked. The action will be fetched from script and executed.
# What if we don't have any Action that is deemed positive? That's when the fallback action kicks in. The fallback action tries to find a good position for the character and walks there.

=Guiding Ai=
There are multiple ways to guide Ai into certain actions or behaviour. Skill conditions, archetypes and modifiers, and AiHints are all supported by Ai and are used by Ai during the score calculation. Any other way to guide Ai might result in incorrect behaviour (but you're welcome to try).
===Skill conditions===
[[File:CombatAi_SkillConditions.PNG|none]]
The skill conditions panel you get when adding a skill to a character

The skill conditions panel can be used to set conditions for casting a skill (e.g. prohibit using a skill if the caster is still full health), set flags for the skill, or apply a simple score modifier.
<ul>
<li>AiFlags: AiFlags can be set on a [[#AiFlags|skill on a global level]], but they can also be set in the skill conditions. A list of the flags and what they do can be found [[CombatAi_AiFlags|here]]. It is possible to use multiple flags by concatenating them with a semicolon (';')</li>
<li>MinimumImpact: The skill should impact at least this amount of characters in a positive way, or else it can not be used. Positive in this case means it's benefitial for the caster: e.g. healing an ally, or damaging an enemy</li>
<li>OnlyCastOnSelf: The skill can only be cast on self. Can be used, for example, to force a character to only use the bless skill on itself</li>
<li>StartRound: The skill can only be used from this round. Everything below and including 1 means it can be used from the start</li>
<li>HasNoMagicalArmor: The skill can only be used if the source/target has no magical armor</li>
<li>HasNoPhysicalArmor: The skill can only be used if the source/target has no physical armor</li>
<li>MaximumHealthPercentage: The skill can only be used if the source/target has a health percentage lower or equal to this value</li>
<li>MinimumHealthPercentage: The skill can only be used if the source/target has a health percentage higher or equal to this value</li>
<li>Tags: The skill can only be used if the source/target has these tags</li>
</ul>
You may have noticed that the italic conditions in above list are listed twice in the skill conditions. It's possible to set these for both the source (the caster of the skill) and the target of the skill (if the skill has a direct target).
Tip: Tags can be used for any skill condition that is not part of the standard skill conditions. You can create a custom tag and a script that assigns/removes a tag based on scripted conditions.
 
The last skill conditions are the difficulty modes. These are simple checkboxes to enable/disable a skill on a certain difficulty. The very last thing on the list, the score modifier, is exactly what it says it is: a score modifier. If you want the Ai to use a skill more often, even if it's not that good at all, you could increase the score modifier. You could also use to, for example, force Ai to cast a certain skill after an event: set a high score modifier and set a source tag condition for a tag that you apply via script.
 
===Archetypes and modifiers===
[[File:CombatAi_Archetype.PNG|none]]
The EXTERN script variable that sets the archetype

The EXTERN Archetype parameter in the DefaultBehaviour script allows you to set the archetype of a character. It can also be set using the CharacterSetArchetype call in script. Archetypes are linked to a text file that contain modifiers for Ai. These modifiers are used when calculating the scores for all the skills and are delicately balanced. And you can change them.
 
You can find the archetype files in: Public/YourMod/AI/Archetypes/ (if the directory doesn't exist you can just create it yourself). All .txt files in the Archetypes folder will be shown as options in script. The archetypes in this folder are used for Explorer and Classic mode. If you want to override modifiers from archetypes for Tactician and Hardcore mode you can place these in a folder called TACTICIAN inside the Archetypes folder. So, let's say we want to override a modifier in the base archetype (an already existing archetype in D:OS2). We'd have to create a new text file called base.txt and give it the following content:
<pre>
// We want self-healing to be more common in our mod -> yes, comments work in these files!
MULTIPLIER_HEAL_SELF_POS 10.0 // This will override the modifier MULTIPLIER_HEAL_SELF_POS located in the D:OS2 base archetype with our own value of 10.0. Only int and float values are allowed in these files
</pre>
Or we'd like to create a completely new archetype called myFirstArchetype. We'd have to create a text file called myFirstArchetype.txt and give it the following content:
<pre>
// We copy over all modifiers from the base archetype because we don't want to specify every single modifier
USING base

MULTIPLIER_HEAL_SELF_POS 10.0 // Because I'm unoriginal
</pre>
If you place a .txt file containing the above snippet in your Archetypes folder you'll have the archetype myFirstArchetype showing up in script.
 
The only information you're still missing now is a list of all the modifiers and archetypes and what they do. You can find that list right [[CombatAi_Archetypes_And_Modifiers|here]].
 
===AiHints===
[[File:CombatAi_AiHints.PNG|none]]
The EXTERN script variables AiHints and StayInAiHints

You can assign a tag to the EXTERN AiHint parameter in the DefaultBehaviour script for the Ai to use. Ai will find AiHintAreaTriggers with this tag and use these during the calculation. The AiHintAreaTriggers with the specified tag (referred to ai AiHints from now on) are areas where the Ai would prefer to stand when attacking. You could use this when you, for example, want a ranger to prefer standing on some platforms in the back instead of on the lower ground. Keep in mind that it does not force the Ai to stay in the AiHint. For that you also need to enable the StayInAiHints parameter in the same DefaultBehaviour script. This forces the Ai to always stand in the AiHint, even if it blocks it from attacking. There's only 2 exceptions to this rule:
# All of the AiHints are filled with dangerous surfaces (all of them full of fire for example)
# The character has been moved outside of the AiHint (started outside of it or has been teleported for example) and is not able to attack anyone from any AiHints. In this case it will try to attack anyone without moving.
 
===Tags===
Sometimes you'd like to make sure Ai prefers a target, or doesn't, or even totally ignores a target. There are some tags you can set on objects to make it work:
<ul>
<li>AI_PREFERRED_TARGET: boosts any score on this target. This will not only increase being attacked by enemies, but also being healed by allies</li>
<li>AI_UNPREFERRED_TARGET: decreases any score on this target. This will not only decrease being attacked by enemies, but also being healed by allies</li>
<li>AI_IGNORED_TARGET: completely ignored by Ai. Damage doesn't matter, healing doesn't matter, killing doesn't matter.</li>
</ul>

=Overriding Ai=
It's strongly advised to not override the Ai, but we understand that it's needed from time to time. Below are some supported ways to override the Ai and some tips and tricks you might want to use.
===Skills===
The skills in [[skill_creation|SkillData]] have several properties that affect the Ai in a special way.
====Skill overrides====
Several skill types have the possibility to be overwritten with the score of a specified Target skill (can not be of any other type) in the AiCalculationSkillOverride column. If a skill has an override it will calculate the score by simulating with the Target skill instead of the original skill. This can be used to make the Ai think a skill will do something that it won't actually do, but some skills actually need to have an override skill:
<ul>
<li>Summon skills: Ai does not know what kind of impact a summon will have. The AiCalculationSkillOverride skill will be used to calculate the impact of the summon.</li>
<li>Projectile skills with a filled in SpawnObject: Just like with Summon skills Ai does not know what kind of impact a summon will have. The AiCalculationSkillOverride skill will be used to calculate the impact of the summon.</li>
<li>Target skills: The AiCalculationSkillOverride skill will be used to calculate the score on the target.</li>
<li>Rain and Shout skills: The AiCalculationSkillOverride skill will be used on all targets that would get hit by the original skill to calculate the score on the target.</li>
</ul>
Next to Summon and Projectile skills it is also supported by Shout and Target skills.
 
The override skill can be fairly simple, just like the Target_DummyTargetSkill that we use in a couple of cases. However, it's advised to make the override skill as accurate as possible. E.g.: for a Summon skill that spawns a summon that does only fire damage you shouldn't use an override skill that only does physical damage. Ai might then cast the summon in the middle of a group of enemies that are all immune to fire damage. Use a target skill that represents the actual summon as accurate as you possibly can.

====AiFlags====
The AiFlags column is used to set flags specifically for Ai. A list of the flags and what they do can be found [[CombatAi_AiFlags|here]]. It is possible to use multiple flags by concatenating them with a semicolon (';').
===Scripting===
Overriding Ai with scripting is relatively easy: make sure the priority of your REACTION is higher than 60 (higher than all REACTIONs related to Ai) and the Ai won't execute anymore.

=Unsupported properties=
Some skill and status properties are not supported for Ai. If it's not supported Ai will ignore the property altogether and it might do unexpected things. Try to avoid these properties for Ai and use the CanNotUse [[#AiFlags|AiFlag]] to prevent the Ai from casting any skills with these properties.
===Skills===
<ul>
<li>Chaos damage type (random damage type)</li>
<li>Spawning multiple summons</li>
<li>Zone skills with a push distance</li>
<li>Shout skills with a push distance</li>
<li>Skills with the Sabotage property</li>
<li>Skills with the Equalize property</li>
<li>Teleportation skills with the SwapSurfaces property</li>
<li>Skills with the CreateConeSurface property</li>
<li>Projectile skills with an angle and multiple targets</li>
</ul>

===Statuses===
<ul>
<li>Surface absorption boostst</li>
<li>Adding skills</li>
<li>The statuses STANCE, SMELLY, CLEAN, DARK_AVENGER, REMORSE, UNHEALABLE, CHANNELING, INFUSED, LINGERING_WOUNDS, SPIRIT_VISION, FORCE_MOVE, DEMONIC_BARGAIN, FLOATING, CHALLENGE, and EXTRA_TURN</li>
<li>Consume statuses that set weapon overrides</li>
<li>Consume statuses that reset cooldowns</li>
</ul>

Character and Item Script Triggers, Calls, and Queries

2018-03-02T12:02:07Z

Rimevan: /* EVENTS */

This is a list of almost every character and item script event trigger, call, and query. An event is what triggers the script, and always begin with ''On''. Queries provide information and are always inside an ''IF'' or ''CHECK.'' Calls are actions that are always after THEN.

CharScript/ItemScript Functions

== CALLS ==

'''Set(OUT OBJECT:variable, OBJECT:value)'''

Set the value of a variable

'''SetVar(CHARACTER|ITEM:object, FIXEDSTRING:variableName, OBJECT:value)'''

Set the value of a global variable

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable

'''Print(OUT STRING:output, STRING:text)'''

Prints the text to the output with possible parameters: [1], [2], ...

'''Add(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Adds both values and stores it in the first variable

'''Subtract(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Subtracts both values and stores it in the first variable

'''Multiply(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Multiplies both values and stores it in the first variable

'''Divide(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Divides both values and stores it in the first variable

'''Abs(INOUT INT|FLOAT:variable)'''

Takes the absolute value of a variable

'''Clamp(INOUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Clamps a variable between min and max

'''GetRandom(OUT OBJECT:variable, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with random one of the values.

'''GetWeightedRandom(OUT OBJECT:variable, OBJECT:value, INT|FLOAT:weight, ...)'''

Gets a weighted random of the given values!

'''GetRandomBetween(OUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Gets a random value between min and max (both included)

'''GetRandomPositionInTrigger(OUT FLOAT3:variable, TRIGGER:areaTrigger)'''

Get a random position in a trigger area

'''GetElement(OUT OBJECT:variable, INT:index, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with the index one of the values (starting from 0)

'''SetPriority(FIXEDSTRING:reactionName, INT:priority)'''

Changes the priority of a reaction. Priority 0 and below are not executed!

'''DelayReaction(FIXEDSTRING:reactionName, FLOAT:timeInSeconds)'''

The reaction will not be chosen for the specified time

'''SetScriptFrame(CHARACTER:character, FIXEDSTRING:frame)'''

Sets the scriptframe on the character.

'''ClearScriptFrame(CHARACTER:character)'''

Clears the scriptframe on the character.

'''Goto(FIXEDSTRING:labelName)'''

Jumps to the label. Two label names are built-in: "Start" for the first instruction of the reaction, and "End" for the last one.

'''GotoIfEqual(OBJECT:variable, OBJECT:value, FIXEDSTRING:labelName)'''

Jumps to the label if the 2 objects are equal

'''GotoRand(FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName)'''

Jumps to a random label in the list

'''CreatePuddleAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, INT:cellAmountMin, INT:cellAmountMax, INT:growAmountMin, INT:growAmountMax, )'''

Spawn a puddle at the target's position for a certain lifetime (in turns)

'''CreateSurfaceAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, INT:lifeTime[, GAMEOBJECT:owner])'''

Spawn a surface at the target's position for a certain lifetime (in turns)

'''CreateSurfaceInPolygon(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, GAMEOBJECT|FLOAT3:point1, GAMEOBJECT|FLOAT3:point2, GAMEOBJECT|FLOAT3:point3, ...)'''

Spawn a polygon surface at the target's position. Grows <growStep> every <growTimer>.

'''CreateSurfaceInAreaTrigger(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, TRIGGER:areaTrigger)'''

Spawn a surface within <areaTrigger>. Grows <growStep> every <growTimer>.

'''CreateConeSurfaceAt(GAMEOBJECT|FLOAT3:start, GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, FLOAT:angle, FLOAT:duration)'''

Spawn a Cone surface at the target's position

'''PlayEffectAt(GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''PlayLoopEffectAt(OUT INT64:effectHandle, GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''ExplodeAt(GAMEOBJECT|FLOAT3:target, SKILL:projectileSkill, [INT:casterLevel=-1, CHARACTER|ITEM:cause])'''

Trigger an explosion of a projectile skill at the target's position. The cause will trigger NPC behavior as if the cause casted the projectile

'''DisplayText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''DisplayCombatInfoText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''StatusText(CHARACTER|ITEM:target, FIXEDSTRING:text)'''

Adds statustext above the character/item for a short amount of time. Will not replace texts or dialogtexts

'''DebugText(CHARACTER|ITEM:target, STRING:text)'''

Adds debugtext above the character/item for a short amount of time.

'''CombatLogText(CHARACTER|ITEM:target, FIXEDSTRING:text, INT:filterID, INT:broadcastID)'''

Adds combatlog text inside the combat log window. Color-/SizeFormatting should already be applied, if not color and size of the string will be NORMAL. filterID determines what filter shows/hides the text. broadcastID determines who will be able to see the message (0 hearingrange. 1 party. 2 all)

'''Log(STRING:text, ...)'''

Log's the the scriptlog. (for debugging purposes)

'''Output(STRING:text, ...)'''

Pass text with optional parameters to the output panel (e.g. Output("An int [1]", INT:10))

'''Assert(STRING:text, ...)'''

Pass text with optional parameters to display as an assert message (e.g. Assert("This number is wrong: [1]", INT:666))

'''Label(FIXEDSTRING:name)'''

Marks this line as a label where Goto actions can jump to

'''StartTimer(FIXEDSTRING:timerName, FLOAT:timeInSeconds, INT:repeatCount)'''

Start a timer which will throw the timer event. Set repeatcount < 0 for a permanent timer.

'''StopTimer(FIXEDSTRING:timerName)'''

Stop a timer which will throw the timer event

'''DialogStart(OUT INT:instanceId, STRING:dialog, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target)'''

Start a dialog between the targets. You can specify fewer targets than the maximum number.

{{warning|Starting a dialog from behaviour script will always start it as an [[Dialog_editor#Automated|Automated Dialog]]. Interactive dialogs can only be started from [[Osiris]].}}

'''DialogRequestStop(CHARACTER|ITEM:speaker, STRING:dialog)'''

Stops a certain dialog on a certain speaker

'''Check(-)'''

Reevaluate the conditions in the CHECK section of this reaction

'''Reset(-)'''

Resets the current reaction. It will start from the beginning again

'''Interrupt(FIXEDSTRING:reactionName)'''

Interrupt the reaction.

'''GlobalSetEvent(FIXEDSTRING:eventName)'''

Sets a global event. Scripts and Story can catch it.

'''GlobalClearEvent(FIXEDSTRING:eventName)'''

Clears a global event. Scripts and Story can catch it.

'''StopLoopEffect(INT64:fxHandle)'''

Stops a looping effect

'''IterateItems(FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item. If you pass a tag, it has to have that tag.

'''IterateItemsNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item in range. If you pass a tag, it has to have that tag.

'''IterateItemsOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item standing on the source. If you pass a tag, it has to have that tag.

'''IterateParty(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, CHARACTER:partyMember, FIXEDSTRING:tag])'''

Launch iterate event for each member of all parties. If you pass a party member only members of that party will be considered. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharacters(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in range. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''
Launch iterate event for each character standing on the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersInCombat(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in combat with the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateHostilesFor(CHARACTER:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character who is targetting the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''SpawnCharacter(OUT CHARACTER:result, CHARACTERTEMPLATE:rootTemplate, GAMEOBJECT|FLOAT3:position, INT:playSpawn, [INT:isSummon=0, CHARACTER:summonOwner=null, INT:overrideLevel=-1])'''

Spawns a character

'''SpawnItem(ITEMTEMPLATE:rootTemplate,GAMEOBJECT|FLOAT3:position, OUT ITEM:result)'''

Spawns an item

'''ShootLocalProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootLocalProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootWorldProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootWorldProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootLocalCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) in a direction

'''ShootLocalConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) at the target

'''ShootWorldCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Shoots a cone from worldPos in a direction. Source can be null.

'''ShootWorldConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Shoots a cone from worldPos at the target. Source can be null.

'''SetVisible(CHARACTER|ITEM:object, INT:visible)'''

Sets a character or item visible or not.

'''RotateY(INOUT FLOAT3:vector, FLOAT:degrees)'''

Rotate the vector around the Y-axis for a certain angle (in degrees)

'''SetHealth(CHARACTER|ITEM:target, FLOAT:percent)'''

Set a characters or items health on the given percentage. (percentage between 0 and 1)

'''PlaySound(CHARACTER|ITEM:target, STRING:soundEvent)'''

Plays a sound event at the target

'''PlayMusicForEveryone(STRING:musicEvent)'''

Plays a music event on all the clients

'''PlayMusicOnCharacter(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on a character for all peers (3D)

'''PlayMusicForPeer(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on the peer of the character

'''PlayMusicForPeerWithInstrument(CHARACTER:target, CHARACTER:charInstrument, STRING:musicEvent)'''

Plays a music event on the peer of the character concated with _INSTRUMENT

'''SetX(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the X component of the FLOAT3

'''SetY(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Y component of the FLOAT3

'''SetZ(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Z component of the FLOAT3

'''SetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID, FIXEDSTRING:atmosphere)'''

Changes the atmosphere of the trigger

'''ResetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID)'''

Resets the atmosphere of the trigger

'''AddStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1], [INT:force=1])'''

Adds the status influence strength on the object.

'''RemoveStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Removes the status influence strength on the object.

'''AddTemporaryStatusInfluence(CHARACTER|ITEM:source, CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Adds a temporary status influence strength on the object.. It will be gone in a few seconds if it's not set again

'''CallFunction(FIXEDSTRING:functionName)'''

Calls a function with the ID

'''SetMaterial(CHARACTER|ITEM:object, FIXEDSTRING:materialUUID, INT:duration, INT:applyOnBody, INT:applyOnArmor, INT:applyOnWeapon[)'''

Changes the material of the object for a set time (in turns), -1 is infinite. applyNormalMap: Copy the original materials normal map

'''TeleportTo(CHARACTER|ITEM:object, GAMEOBJECT|FLOAT3:target, [INT:Force=0])'''

Teleport object to or near the target

'''Transform(CHARACTER|ITEM:object, CHARACTERTEMPLATE|ITEMTEMPLATE:root [, FIXEDSTRING:fx, INT:replaceScripts=1, OUT FLOAT:currentHP])'''

Transforms <object> using <root>, returns <currentHP>, plays <fx>.

'''SaveGame(FIXEDSTRING:saveGameName)'''

Save the savegame with name <saveGameName>

'''LoadGame(FIXEDSTRING:saveGameName)'''

Load the savegame with name <saveGameName>

'''LoadLevel(FIXEDSTRING:levelName)'''

Load the level with name <levelName>

'''KillCombat(CHARACTER:character)'''

Kill all the enemies in the combat which contains <character>

'''SetTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Sets the Tag on the Object

'''ClearTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Clears the Tag on the Object

'''SetGlobalFlag(FIXEDSTRING:flagname)'''

Sets the Global Flag

'''ClearGlobalFlag(FIXEDSTRING:flagname)'''

Clears the Global Flag

'''SetFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the Object

'''ClearFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the Object

'''SetUserFlag(CHARACTER:object, FIXEDSTRING:flagname)'''

Sets the Flag on the user's characters

'''ClearUserFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the user's characters

'''SetPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the party's characters

'''ClearPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the party's characters

'''StartVoiceBark(STRING:barkName, CHARACTER:character)'''

Start a voicebark on character

'''ConfrontationDone(INT: CrimeID, CHARACTER:lead, CHARACTER:criminal, ...)'''

Resolve the crime with id CrimeID for the specified criminals

'''CrimesceneInvestigationDone(CHARACTER:investigator)'''

Crimescene is considered investigated by this NPC, start looking for culprits

'''ListAdd(LIST<OBJECT>:list, OBJECT:entry)'''

Add <entry> at the back of <list>

'''ListRemove(LIST<OBJECT>:list, INT:index)'''

Remove the entry at <index> of <list>

'''ListSet(LIST<OBJECT>:list, INT:index, OBJECT:entry)'''

Set the entry at <index> of <list> to <entry>

'''ListClear(LIST<OBJECT>:list)'''

Remove all entries of <list>

'''EndTurn(CHARACTER|ITEM:Target)'''

Ends the object's current turn

'''SetCanFight(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can fight. Optional for the whole group

'''SetCanJoinCombat(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can join combats. Optional for the whole group

'''SetIsBoss(CHARACTER|ITEM:entity, INT:enabled)'''

Enables/Disables the fact if the entity is a boss.

'''GetAIHintTriggers(OUT LIST<TRIGGER>:triggers[, [LIST]FIXEDSTRING:tags, INT:needsAllTags = -1)'''

Returns all AIHintAreaTriggers in <triggers>. Uses contraints if set.

'''SetCombatTimeout(CHARACTER|ITEM:entity, FLOAT:timer)'''

Overwrites the entity's combat timeout check.

'''ResetCombatTimeout(CHARACTER|ITEM:entity)'''

Resets the entity's combat timeout check.

'''EnterCombat(CHARACTER|ITEM:source, CHARACTER|ITEM:target)'''

Enters combat with target

'''LeaveCombat(CHARACTER|ITEM:source)'''

Leaves the combat

'''SetFaction(CHARACTER|ITEM:target, FIXEDSTRING:faction)'''

Changes the faction of a character or item

'''SetInvulnerable(CHARACTER|ITEM:target, INT:bool)'''

Makes the character or item invulnerable or not. (Allow damage)

'''JumpToTurn(CHARACTER|ITEM:Target)'''

Jumps to targets turn (ends the current turn)

'''Sleep(FLOAT:timeInSeconds)'''

Sleeps for a certain amount of time

'''CharacterAttack(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Moves in weapon range and attacks the target

'''CharacterAttackWithoutMove(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Attacks the target without checking weaponranges and without moving

'''CharacterMoveTo(GAMEOBJECT|FLOAT3:target, [INT:running=0, INT:shouldArrive=0, INT:longPath=0, FLOAT:minDistance=1.5, FLOAT:maxDistance=minDistance+2.5])'''

Move to the target. Set shouldArrive to 1 if you want a guaranteed move. (teleports on fail)

'''CharacterAiMove(FLOAT3:target, CHARACTER:targetCharacter, ITEM:targetItem)'''

Moves to the target, calculated by the AI. Should only be used with results from the AI!

'''CharacterMoveInRange(GAMEOBJECT|FLOAT3:target, FLOAT:rangeMin, FLOAT:rangeMax, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within a certain range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInWeaponRange(GAMEOBJECT|FLOAT3:target, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within weapon range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInSkillRange(GAMEOBJECT|FLOAT3:target, SKILL:skill, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within skill range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveOutOfSight(FLOAT:angle)'''

Move out of screen

'''CharacterPlayAnimation(FIXEDSTRING:animation [, INT:exitOnFinish=1, INT:waitForCompletion=1])'''

Plays a certain animation ExitOnFinish means if the exit will kill itself after it was played (revert back to still)

'''CharacterStopAnimation(-)'''

Stops all animations.

'''CharacterPickUpItem(ITEM:item)'''

Moves close enough to the item if necessary and picks it up

'''CharacterUseItem(ITEM:item [, INTEGER:LongPath])'''

Moves close enough to the item if necessary and uses it

'''CharacterMoveItem(ITEM:item, INTEGER:ignoreWeight, INTEGER:ignoreAPCost [, INTEGER:ignoreDangerousSurfaces=1, INT:amount=-1, GAMEOBJECT|FLOAT3:destination])'''

Moves close enough to the item if necessary and moves it to the destination. Will try to find a destination if not supplied.

'''CharacterAddSkill(CHARACTER:character, SKILL:skill[, INT:ShowNotification=0])'''

Adds <skill> to <character>

'''CharacterRemoveSkill(CHARACTER:character, SKILL:skill)'''

Removes <skill> from <character>

'''CharacterUseSkill(SKILL:skill, GAMEOBJECT|FLOAT3:target [, GAMEOBJECT|FLOAT3:target2, ITEM:skillItem, INT:ignoreHasSkill=0])'''

Cast a skill

'''CharacterAppearAt(GAMEOBJECT|FLOAT3:target, INT:playspawn)'''

Appear at the target

'''CharacterAppearOutOfSightTo(GAMEOBJECT:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players from a certain angle while being able to reach target

'''CharacterAppearOnTrailOutOfSightTo(CHARACTER:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players, on its previous locations, from a certain angle while being able to reach target

'''CharacterDisappear(FLOAT:angle[, INTEGER:isRunning=0])'''

Move out of screen and go of stage, will run if <isRunning> is not 0

'''CharacterSetOffStage(-)'''

Set Off Stage

'''CharacterSetOnStage(-)'''

Set On Stage

'''CharacterLookAt(GAMEOBJECT|FLOAT3|SPLINE:target[, INT:snapToTarget=0, INT:angleTolerance=0])'''

Rotates the character to look at the target (Closest spline point in case of a spline).

'''CharacterLookFrom(GAMEOBJECT|SPLINE:target[, INT:snapToTarget=0])'''

Rotates to the character so it has the same rotation as the target (Closest spline point in case of a spline).

'''CharacterFollow(CHARACTER:target, FLOAT:durationInSeconds, INT:run)'''

Follow the target for a certain time

'''CharacterFollowOwnerOrLeader(FLOAT:durationInSeconds, INT:run)'''

Follow the leader or owner for a certain time

'''CharacterWander(FLOAT|TRIGGER:range, FLOAT:durationInSeconds [, INT:run, GAMEOBJECT:anchor])'''

Wander around for a certain time

'''CharacterSwitchWeaponType(WEAPON:type)'''

If necessary switch to the new weapon type

'''CharacterFleeFrom(RELATION:relation, FLOAT:range)'''

Run away from certain characters if necessary
'''
CharacterFleeFromSurface(SURFACE:surface)'''

Run away from a certain surface if necessary

'''CharacterFleeFromDangerousSurface(-)'''

Run away from a dangerous surfaces if necessary

'''CharacterAddSourcePoints(CHARACTER:character, INT:amount)'''

Adds x source points (x can be negative to substract)

'''CharacterDie(CHARACTER:character[, DEATH:type=DoT])'''

Kills the character

'''CharacterHeal(CHARACTER:character, FLOAT:percentage)'''

Heals the character

'''CharacterConsume(CHARACTER:character, POTION:potion)'''

Makes the character consume a potion. Doesn't cost any AP and will just execute the result of the potion.

'''CharacterDisableAllCrimes(CHARACTER:target)'''

Disables all generic behaviours for <target>.

'''CharacterEnableAllCrimes(CHARACTER:target)'''

Enables all generic behaviours for <target>.
'''
CharacterEnableCrime(CHARACTER:target, STRING:crime, ...)'''

Enables the specified generic behaviours for <target>.

'''CharacterDisableCrime(CHARACTER:target, STRING:crime, ...)'''

Disables the specified generic behaviours for <target>.

'''CharacterSetLongInvestigationDuration(CHARACTER:target)'''

Doubles the time it takes for the investigation to time out. Use this when the character needs to move a long path before investigating.

'''CharacterAiCalculate(-)'''

Calculate the AI of the character

'''CharacterAiStopCalculate(-)'''

Stop the calculation of the AI of the character

'''CharacterAiFinishMoveSkill(-)'''

Finish the current MoveSkill.
'''
CharacterAiAddInterestingItem(CHARACTER:character, ITEM:item)'''

Make it interesting for the AI to destroy that Item

'''CharacterAiRemoveInterestingItem(CHARACTER:character, ITEM:item)'''

Make it no longer interesting for the AI to destroy that Item

'''CharacterSetArchetype(CHARACTER:character, ARCHETYPE:archetype)'''

Sets the archetype of the character, used in AI calculations

'''CharacterSetStoryNPC(CHARACTER:character, INT:bool)'''

Makes the character storyNPC or not.
'''
CharacterAddActionPoints(CHARACTER:character, INT:amount)'''

Give character some action points

'''CharacterSetImmortal(CHARACTER:character, INT:bool)'''

Makes the character immortal or not. (Allow dying)

'''CharacterPlayEffect(CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the character and it follows the character

'''CharacterPlayLoopEffect(OUT INT64:effectHandle, CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the character and it follows the character

'''CharacterEvent(CHARACTER:character, STRING:eventName)'''

Throw a character event which you can catch in scripts and story

'''CharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)'''

Throw a character/item event which you can catch in scripts and story

'''CharacterCharacterEvent(CHARACTER:character1, CHARACTER:character2, STRING:eventName)'''

Throw a character/character event which you can catch in scripts and story

'''CharacterSetRelationIndivToIndiv(CHARACTER:source, CHARACTER:target, INT:relation)'''

Changes the relationship between 2 characters.
'''
CharacterForceUpdate(INT:forceUpdate)'''

Makes sure the attached character is always being update or not.
'''
CharacterSetEnemy(CHARACTER:character, CHARACTER:enemy)'''

Sets the current enemy of character

'''CharacterApplyStatus(CHARACTER:character, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the character When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''CharacterRemoveStatus(CHARACTER:character, STATUS:statusId [, STATUS:reasonStatusID=null])'''

Removes the status from the character

'''CharacterDestroy(CHARACTER:character)'''

Destroys the character

'''CharacterSetCanSpotSneakers(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can spot sneaking characters.

'''CharacterSetAttackOfOpportunity(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can do attack of opportunities.

'''CharacterResurrect(CHARACTER:character [, INT:Percentage = 100])'''

Resurrects the character at [2]% health.

'''CharacterAddToInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount, INT:showInTrade=1])'''

Add the item to the character

'''CharacterRemoveFromInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount])'''

Remove the item from the character. If Amount is -1, then all are removed

'''CharacterDrinkPotion(FIXEDSTRING:statID)'''

Makes the character drink a potion from the inventory.

'''CharacterSetAnimationOverride(CHARACTER:character, FIXEDSTRING:animation)'''

Sets an animation override, only walk/run/die animations can override it.

'''CharacterUseActionPoints(CHARACTER:character, INT:amount [, OUT INT:succeeded])'''

Uses x action points

'''CharacterAddTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Adds <treasureTable> to the treasure list of <character>

'''CharacterRemoveTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Removes <treasureTable> from the treasure list of <character>

'''CharacterClearTreasureTables(CHARACTER:character)'''

Removes all treasure tables from <character>

'''CharacterSetTemporaryHostileRelation(CHARACTER:character, CHARACTER:otherCharacter)'''

Creates a temporary hostile relation between the 2 characters!

'''CharacterSetFightMode(CHARACTER:character, INT:fight [, INT:force=0])'''

Set the character in sheath/unsheated mode.

'''CharacterSetStats(CHARACTER:character, FIXEDSTRING:statsEntry [, INT:keepVitality=0, INT:keepAP=0, INT:keepLevel=0, OUT FLOAT:currentHP])'''

Applies <statsEntry> from character.xlsm to <character>, returns <currentHP>.

'''CharacterSetWalkSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:walkSpeed])'''

Sets walk speed override of <character>, removes it if <override> is 0

'''CharacterSetRunSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:runSpeed])'''

Sets run speed override of <character>, removes it if <override> is 0

'''CharacterSetHasDialog(CHARACTER:character, INTEGER:bool)'''

Enables/Disables the dialog of the character

'''CharacterInitPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStartPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStopPatrol(-)'''

Let the character stop patrolling whatever spline he's on!

'''CharacterInterruptPatrol(-)'''

Call when the patrol should interrupt so the guard stops moving to the next spline. If this is called when the character is deactivated, a caret will take his place.

'''CharacterSetAnimationSetOverride(CHARACTER:source, FIXEDSTRING:override)'''

Sets an animation set override for a character. Empty fixedstring clears the override.

'''CharacterSetFloating(CHARACTER:target, INTEGER:isFloating)'''

Sets <target> floating if <isFloating> is not 0

'''CharacterResetCooldowns(CHARACTER:target)'''

Resets the skill cooldowns for <target>

'''ItemEvent(ITEM:item, STRING:eventName)'''

Throw an item event which you can catch in scripts and story

'''ItemPlayAnimation(FIXEDSTRING:animation)'''

Plays an animation on the item

'''ItemPlayAnimationTo(FIXEDSTRING:animation, FLOAT:targetPercentage, [FLOAT:speed])'''

Plays an animation on the item to the target time (percentage of the total duration)

'''ItemPlayEffect(ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the item and it follows the item

'''ItemPlayLoopEffect(OUT INT:effectHandle, ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the item and it follows the item

'''ItemSetOnStage(ITEM:item, INTEGER:bool)'''

Sets an item on or offstage

'''ItemSetCanInteract(ITEM:item, INTEGER:bool)'''

Sets an item (not) interactible

'''ItemClose(ITEM:item)'''

Close an item

'''ItemOpen(ITEM:item)'''

Open an item

'''ItemDrop(ITEM:item)'''

Drop an item

'''ItemLock(ITEM:item, FIXEDSTRING:key)'''

Lock an item

'''ItemUnlock(ITEM:item)'''

Unlock an item

'''ItemApplyStatus(ITEM:item, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the item When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''ItemRemoveStatus(ITEM:item, STATUS:statusId)'''

Removes the status from the item

'''ItemDie(ITEM:item)'''

Kills the item

'''ItemMoveTo(GAMEOBJECT|FLOAT3:target, FLOAT:velocity, FLOAT:acceleration, INTEGER:matchTargetRotation)'''

Moves the item to the target

'''ItemToInventory(ITEM:item, CHARACTER|ITEM:target [,INT:amount=-1])'''

Moves the item to the target's inventory

'''ItemLookAt(GAMEOBJECT:target, FLOAT:degreesPerSecond)'''

Rotates the item to look at the target

'''ItemDestroy(ITEM:item)'''

Destroys the item

'''ItemSetAmount(ITEM:item, INT:amount)'''

Change the amount of the item

'''IterateItemsInInventory(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each iten in source's inventory. If you pass a tag, it has to have that tag.

'''ItemAddCharges(ITEM:TargetItem, INT:charges)'''

Add/subtract charges from an item

'''ItemResetChargesToInitial(ITEM:TargetItem)'''

Resets charges from item to initial state

'''MakePeace(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make peace between users of the characters

'''MakeWar(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make war between users of the characters

'''FindSurface(OUT FLOAT3:result, GAMEOBJECT|FLOAT3:source, FLOAT:minRange, FLOAT:maxRange, SURFACE:type [,CHARACTER:alignSource, INT:minEnemiesInSurface, INT:maxAlliesInSurface, INT:minimumCellCount])'''

Finds the closest surface of a specific type.

'''FindValidPosition(INOUT FLOAT3:position, FLOAT:radius[, CHARACTER|ITEM:object=null])'''

Finds the closest valid position (where the object can stand.)

'''FindPosition(INOUT FLOAT3:position, CHARACTER:source, INT:canStand, INT:checkSight, FLOAT:minRadius, FLOAT:maxRadius, FLOAT:rangeCheck, CHARACTER:alignSource, INT:minAllies, INT:maxAllies, INT:minEnemies, INT:maxEnemies [,FIXEDSTRING:AiHintTag=null, INT:forceHint=0, FLOAT3:SourcePosition])'''

Finds the closest position from the source (within radius) where the conditions are matched.

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable.

'''StringConcatenate(STRING:stringA, STRING:stringB, OUT STRING:resultingString)'''

Appends stringB to stringA. Resulting string is stored in the third parameter.

== QUERIES ==

GetPosition(GAMEOBJECT:object,OUT FLOAT3:src)

Get the current position of an object

GetForwardDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current forward direction of an object

GetRightDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current right direction of an object

GetUpDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current up direction of an object

GetDirection(GAMEOBJECT|FLOAT3:src,GAMEOBJECT|FLOAT3:target,OUT FLOAT3:direction[, OUT FLOAT:distance])

Get the direction from src to target (optional: returns the distance between the objects as well)

GetRotation(GAMEOBJECT:object, OUT FLOAT3:vector)

Get the rotation of an object

CharacterGetTargetSpline(INT: SplineIndex)

Returns the spline index the character is currently walking towards, or -1 if he is not active on a spline.

IsEqual(OBJECT:variable, OBJECT:variable)

Compares both objects and see if they are equal.

IsLessThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is smaller.

IsGreaterThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is bigger.

IsRandom(FLOAT:percentage)

Each time this condition is checked, it will succeed with a chance of the percentage (between 0 and 1)

IsRound(INT:roundNumber)

Checks if we are currently in combat in round x

IsInSurface(OBJECT|FLOAT3:target, SURFACE:type[, FLOAT:radius])

Check if the character, item, trigger or position is currently within the specific surface.

IsInDangerousSurface(OBJECT|FLOAT3:target[, CHARACTER:character, FLOAT:radius])

Check if <target> is currently in on a dangerous surface. Uses <character> for path influences if provided (is necessary with non-character targets)

IsInDialog(CHARACTER|ITEM:target[, INT:ignoreAutomatedDialogs=0])

Check if the character or item is currently in a dialog, optionally ignoring automated dialogs

IsInAutomatedDialog(CHARACTER|ITEM:target)

Check if the character or item is currently in an automated dialog

GetDistance(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)

Returns the distance between 2 positions

GetDistance2D(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)
Returns the 2D distance between 2 positions (ignores height)

GetInnerDistance(OUT FLOAT:distance, GAMEOBJECT:source, GAMEOBJECT:target)

Returns the distance between 2 gameobjects (character, item, trigger, ...) Their bounds are already subtracted.

GetPosition(GAMEOBJECT:object, OUT FLOAT3:position)

Returns the position of a gameobject (character, item, trigger, ...)

GetVar(OUT OBJECT:returnValue, CHARACTER|ITEM:target, FIXEDSTRING:varName)

Gets a global variable from the target

GetClosestPlayer(OUT CHARACTER:player, GAMEOBJECT|FLOAT3:source)

Gets the closest player near the source, default being being the object itself

GetPlayerCount(OUT INT:playerCount)

Gets the number of players in the party

GetPlayerByIndex(OUT CHARACTER:returnCharacter, INT:playerIndex)

Gets a player from the party by index

GetRandomCharacter(OUT CHARACTER:returnCharacter, [INT:canBeSelf=0, INT:canBePlayer=0])

Gets a random character in the current level

ContainsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if there is any surface of the type within a radius of the source

IsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if the whole radius around the source is the specified surface type

IsObjectOnObject(CHARACTER|ITEM:source,CHARACTER|ITEM:target)

Checks if the source is standing on the target

GetX(FLOAT3:vector, OUT FLOAT:value)

Returns the X component of the vector

GetY(FLOAT3:vector, OUT FLOAT:value)

Returns the Y component of the vector

GetZ(FLOAT3:vector, OUT FLOAT:value)

Returns the Z component of the vector

CanSee(GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target[, INT:addProjectileTargetGroundOffset=0])

Check if the sight is blocked between 2 points.

IsVisible(CHARACTER|ITEM:object)

Check if the object is set invisible or not with SetVisible.

GetTextDuration(CHARACTER|ITEM:object, FIXEDSRTING:key, OUT FLOAT:duration)

Gets how long a text needs to be displayed

IsCasual(-)

Returns if the current game mode is Casual

IsHardcore(-)

Returns if the current game mode is Hardcore

IsTagged(GAMEOBJECT:object, FIXEDSTRING:tag)

Check if the object is tagged.

TranslatedStringKeyExists(FIXEDSTRING:key)

Check if the TranslatedString key exists.

IsInCombat(CHARACTER|ITEM:object)

Returns true if the object is in combat.

IsInCombatWith(CHARACTER|ITEM:object, CHARACTER|ITEM:object)

Returns true if the objects are in combat with each other.

IsFacing(GAMEOBJECT:source, GAMEOBJECT|FLOAT3:target, [INT:angle=90])

Returns true if the object is facing the position within the given angle.

GameIsSaving(-)

Returns true if the game is saving.

GameIsLoading(-)

Returns true if the game is loading.

GetUserCount(OUT INT:userCount)

Returns the user count.

GetCurrentCharacter(OUT CHARACTER:character, INT:user)

Returns the character currently being controlled by the specified user.

GetCurrentLevel(OUT FIXEDSTRING:currentLevel)

Returns the current levelname

GetAIBounds(CHARACTER|ITEM:source, OUT FLOAT:bounds)

Returns AI bounds of <source> in <bounds>

HasGlobalFlag(FIXEDSTRING:flagName)

Returns if the Global Flag is set

HasFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the Object

HasUserFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the user's characters

HasPartyFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the party's characters

DialogExists(STRING:dialogue)

Returns true if the dialogue exists.

IsActive(CHARACTER|ITEM:Object)

Returns if the character or item is currently active.

ListGetSize(LIST<OBJECT>:list, out INT:size)

Returns the number of elements in <list>

ListGet(LIST<OBJECT>:list, INT:index, out OBJECT:entry)

Returns <entry> at <index> of <list>

ListGetRandom(LIST<OBJECT>:list, out OBJECT:entry)

Returns a random <entry> of <list>

IsBoss(CHARACTER|ITEM:Object)

Returns true if the entity is tagged as a boss

IsProjectileSkill(SKILL:skill)

Returns true if the skill is a ranged skill (uses a projectile)

IsValidSkillTarget(CHARACTER:source, OBJECT|FLOAT3:target, SKILLID:skill[, INTEGER:ignoreRangeCheck=0])

Checks whether <target> is a valid target for <skill> at <source>

GetFaction(OUT FIXEDSTRING:faction, CHARACTER|ITEM:character)

Returns the faction of the provided character or item

IsInActiveTurn(CHARACTER|ITEM:target)

Returns true if it's the character's or item's turn in combat.

IsSkillActive(CHARACTER:character, SKILL:skillId)

Returns true if <character> has <skillId> active (in memory).

HasSkillAi(SKILLID:skillId)

Returns true if the skill is using the new Ai system

IsInArena(CHARACTER::character)

Returns true if the character is in an arena fight

CrimeGetType(INTEGER:crimeId, OUT STRING:crimeType)

Returns the type of the crime with this id.

CrimeGetCriminals(INTEGER:crimeId, OUT CHARACTER:criminal1, OUT CHARACTER:criminal2, OUT CHARACTER:criminal3, OUT CHARACTER:criminal4)

Returns the criminals of that crime. They might all be null.

IsSourceSkill(SKILL:skill)

Returns true if the skill is a source skill.

IsInGameMasterMode(-)

Returns true if the game in game master mode.

CharacterGet(OUT CHARACTER:character, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo, COMPAREFUNC:compareFunc[, RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf, FIXEDSTRING:tag])

Get a character within a certain range conforming to the filled in restraints.

CharacterCount(OUT INT:count, GAMEOBJECT|FLOAT3:src, FLOAT:range, [RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf])

Counts the characters within a certain range conforming to the filled in restraints.

CharacterGetOwner(OUT CHARACTER:owner, CHARACTER:source)

Get the character's owner

CharacterGetFollow(OUT CHARACTER:to follow, CHARACTER:source)

Get the character to follow

CharacterGetEnemy(OUT CHARACTER:current enemy, CHARACTER:source)

Get current enemy of character

CharacterCanCast(CHARACTER:source, SKILL:skillId, [ITEM:skillItem=null, INT:ignoreActionPoints=0])

Check if the character source can cast the skill: will check cooldown, actionpoints

CharacterCanSitOnItem(CHARACTER:source, ITEM:item)

Check if the character source can sit or lie on an item.

CharacterCanDrinkPotion(CHARACTER:source, FIXEDSTRING:potionID[, INT:ignoreActionPoints=0])

Check if the character source can drink the potion: will check inv and actionpoints

CharacterCanUseItem(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in the world

CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in his inventory

CharacterCanSee(CHARACTER:watchingChar, CHARACTER|ITEM:target [, INT:forceUpdate=0])

Check if character has target in his line of sight.

CharacterCanShoot(CHARACTER:source, GAMEOBJECT|FLOAT3:target)

Check if the character can shoot the target.

CharacterIsPlayer(CHARACTER:character)

Check if the character is a player

CharacterIsInParty(CHARACTER:character)

Check if the character is in the party

CharacterIsEnemy(CHARACTER:source, CHARACTER:target)

Check if target is enemy of source

CharacterIsAlly(CHARACTER:source, CHARACTER:target)

Check if target is ally of source

CharacterIsNeutral(CHARACTER:source, CHARACTER:target)

Check if target is neutral of source

CharacterIsDead(CHARACTER:character)

Check if character is dead

CharacterIsMoving(CHARACTER:character)

Check if character is moving (speed > 0)

CharacterIsSummon(CHARACTER:character)

Check if character is a summon

CharacterIsPartyFollower(CHARACTER:character)

Check if character is a party follower

CharacterIsStoryNPC(CHARACTER:character)

Check if character is a story NPC

CharacterInWeaponRange(CHARACTER:character, CHARACTER:target)

Check if target is in the current's weapon range

CharacterInTouchRange(CHARACTER:character, CHARACTER:targetChar)

Check if target is in the character's touch range

CharacterHasStatus(CHARACTER:character, STATUS:statusId[, FIXEDSTRING:extraData])

Check if character currently has the status. ExtraData can be filled in for some statuses: - Consume: statsid of the item - Shield: skillid of the shield

CharacterGetStatusSourceCharacter(CHARACTER:character, STATUS:statusId, OUT CHARACTER:source[, FIXEDSTRING:extraData])

Get the source character of a status

CharacterGetStatusSourceItem(CHARACTER:character, STATUS:statusId, OUT ITEM:source[, FIXEDSTRING:extraData])

Get the source item of a status

CharacterHasTalent(CHARACTER:character, TALENT:talent)

Check if character currently has the talent

CharacterHasSkill(CHARACTER:character, SKILL:skillId)

Check if character currently has the skill

CharacterHasWeaponType(CHARACTER:character, WEAPON:weaponTYPE [, INT:equipped])

Check if character currently has a weapon of this type in his inventory or equipped

CharacterGetStat(OUT FLOAT:statValue, CHARACTER:character, CHARACTERSTAT:statType)

Returns the current value of the stat (Vitality, ...)

CharacterGetSightRange(OUT FLOAT:range, CHARACTER:character)

Returns the character's sight range

CharacterGetWeaponRange(OUT FLOAT:minRange, OUT FLOAT:maxRange, CHARACTER:character)

Returns the character's current weapon range

CharacterGetTouchRange(OUT FLOAT:touchRange, CHARACTER:character)

Returns the character's current touch range

CharacterGetSkillRange(OUT FLOAT:minRange, OUT FLOAT:maxRange,CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterGetSkillImpactRange(OUT FLOAT:areaRange, CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterIsInTrigger(CHARACTER:character, TRIGGER:trigger)

Check if character is in given trigger

CharacterGetAbility(OUT INT:value, CHARACTER:character, ABILITY:ability)

Returns the character's value of the specified ability

CharacterGetHostileCount(OUT INT:value, CHARACTER:character)

Returns how many characters are targeting this character right now... You can iterate over them with IterateEnemiesOf.

CharacterCanFight(CHARACTER:character)

Returns true if the character can fight.

CharacterGetTemplate(CHARACTER:character, OUT CHARACTERTEMPLATE:root)

Returns the roottemplate of the character.

CharacterCanSpotSneakers(CHARACTER:character)

Returns true if the character can spot sneaking characters

CharacterIsFloating(CHARACTER:character)

Check if character is a floating character

CharacterInCreation(CHARACTER:character)

Returns true if the character is in character creation

CharacterAvoidsTraps(CHARACTER:character)

Returns true if the character avoids traps

CharacterCheckRelation(CHARACTER:character, RELATION:relation)

Returns true if relation check succeeds

CharacterIsBetterOrEqualClass(CHARACTER:character, INT:currentScore, OUT INT:newScore, INT warriorScore, INT rogueScore, INT mageScore, INT clericScore, INT rangerScore)

Returns true if score is higher or equal than the current score

CharacterHasBeenHitBy(CHARACTER:character, DAMAGE_TYPE:damageType)

Returns true if the character was hit by this type.

CharacterHasCastedSpellLastTurn(CHARACTER:character)

Returns true if the character has casted a spell in his last turn.

CharacterHasHadStatus(CHARACTER:character, STATUS:status)

Returns true if the character has had a specific status this combat.

CharacterHasAnimationOverride(CHARACTER:character)

Returns true if the character has an animation override.

CharacterCanUnlock(CHARACTER:character, ITEM:item)

Returns true if the character can unlock the item (if the item is already unlocked it returns true!)

CharacterGetReservedUserID(OUT INT:user, CHARACTER:character)

Returns the character's reserved User id.

CharacterGetRace(CHARACTER:character, OUT FIXEDSTRING:race)

Returns the <character>'s race in <race>.

CharacterIsRace(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character>'s race is <race>.

CharacterCanMoveItem(CHARACTER:character, ITEM:item, FLOAT:minRadius, FLOAT:maxRadius [, OUT FLOAT3:destination])

Returns true + <destination> if <character> can move <item> somewhere between <minRadius> and <maxRadius>.

CharacterGetDeathType(CHARACTER:character, OUT FIXEDSTRING:deathType)

Returns death type of <character> in <deathType>.

CharacterGetStillAnimation(CHARACTER:object, OUT FIXEDSTRING:stillAnimation)

Returns the still animation to play

CrimeTransferLeadership(INT: CrimeID[, FIXEDSTRING:Tag1,...])

Try and transfer the leadership of this crime to someone else.

CrimeGetLeadInvestigator(OUT CHARACTER:lead, INT: CrimeID)

Returns the lead investigator for the crime.

CharacterCanHitTargetWithRangedWeapon(CHARACTER:source, OBJECT|FLOAT3:target[, SKILL:skill = null])

Returns true if <source> can hit <target> with currently equipped ranged weapon. Will use <skill> instead of equipped weapon if provided.

CharacterHasRangedWeapon(CHARACTER:character[, INT:checkInventory = 0])

Returns true if <character> has has ranged weapon. Checks for non-wielded weapons if <checkInventory> is 1

CheckInteractionReach(CHARACTER:character, CHARACTER|ITEM: target)

Returns true if <character> could interact with <target>. This is not checking ranges, but checking if there's too much of a height difference or too many obstacles in between.

CharacterGetSourcePoints(CHARACTER:character, OUT INT: amount)

Returns the amount of sourcepoints of <character>.

CharacterAiIsCalculating(-)

Returns if the character is still calculating the AI.

CharacterAiFetchMoveSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3:target)

Returns if the character has a Move Skill command to execute according to the AI.

CharacterAiFetchSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3 endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target, OUT FLOAT3:target2, OUT CHARACTER:target2, OUT ITEM:target)

Returns if the character has a Skill command to execute according to the AI.

CharacterAiFetchConsumeCommand(OUT ITEM:item)

Returns if the character has a Consume command to execute according to the AI.

CharacterAiFetchAttackCommand(OUT FLOAT3:endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target)

Returns if the character has a Attack command to execute according to the AI.

CharacterAiFetchFallbackCommand(OUT FLOAT3:targetPosition, OUT FLOAT3:lookAtPosition)

Returns if the character has a Fallback command to execute according to the AI.

CharacterGetArchetype(CHARACTER:character, OUT ARCHETYPE:archetype)

Returns the archetype of the character.

CharacterIsPolymorphedInto(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character> is polymorphed into <race>. Race can be a race (like HUMAN), but also a template (in case of a polymorph skill like Chicken Touch).

CharacterIsPolymorphInteractionDisabled(CHARACTER:character)

Returns true if <character> has his interaction disabled because of a polymorph.

ItemGet(OUT ITEM:item, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo [, COMPAREFUNC:compareFunc, FIXEDSTRING:rootTemplate, FIXEDSTRING:tag])

Get an item within a certain range conforming to the filled in restraints.

ItemGetFromInventory(OUT ITEM:item, CHARACTER|ITEM:object [, FIXEDSTRING:statsId, FIXEDSTRING:tag, INT:isEquiped])

Returns the first item in the inventory conforming to the filled in restraints.

ItemIsInCharacterInventory(ITEM:item, CHARACTER:object)

Returns if the item is in the inventory of the character

ItemIsInTrigger(ITEM:item, TRIGGER:trigger)

Check if item is in given trigger

ItemGetStat(OUT FLOAT:statValue, ITEM:item, ITEMSTAT:statType)

Returns the current value of the stat (Weight, ...)

ItemIsMoving(ITEM:item)

Returns if the item is moving or not.

ItemIsFalling(ITEM:item)

Returns if the item is falling or not. (after teleport)

ItemIsOpening(ITEM:item)

Returns if the item is opening or not.

ItemIsClosing(ITEM:item)

Returns if the item is closing or not.

ItemIsLocked(ITEM:item)

Returns if the item is locked or not.

ItemIsMovable(ITEM:item)

Returns if the item is movable or not.

ItemCanBeLockPicked(ITEM:item)

Returns if the item is can be opened by lockpicking.

ItemIsOpen(ITEM:item)

Returns if the item is open or not.

IsStoryItem(ITEM:item)

Returns if the item is a story item.

ItemHasStatus(ITEM:item, STATUS:statusId)

Returns if the item has the status.

ItemIsDestroyed(ITEM:item)

Returns if the item is destroyed.

ItemGetTemplate(ITEM:item, OUT ITEMTEMPLATE:root)

Returns the roottemplate of the item.

ItemGetSkillId(ITEM:item, OUT SKILL:root)

Returns the skillid of the item if it has one.

ItemGetItemType(ITEM:item, OUT FIXEDSTRING:itemType)

Returns the itemtype of the item: common, unique, rare, ...

ItemGetStatusSourceCharacter(ITEM:item, STATUS:statusId, OUT CHARACTER:source)

Get the source character of a status

ItemGetStatusSourceItem(ITEM:item, STATUS:statusId, OUT ITEM:source)

Get the source item of a status

ItemCanBeMoved(ITEM:item)

Returns if the item can be moved.

== EVENTS ==

'''OnCharacterEvent(CHARACTER:character, STRING:eventName)''' 
Thrown from scripts or story

'''OnCharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)''' 
Thrown from scripts or story

'''OnCharacterCharacterEvent(CHARACTER:character, CHARACTER:character, STRING:eventName)''' 
Thrown from scripts or story

'''OnItemEvent(ITEM:item, STRING:eventName)''' 
Thrown from scripts or story

'''OnItemDestroyed(ITEM:item)''' 
Thrown when an item is destroyed

'''OnItemDestroying(ITEM:item)''' 
Thrown when an item is being destroyed

'''OnItemOpened(ITEM:item)''' 
Thrown when an item is opened

'''OnItemClosed(ITEM:item)''' 
Thrown when an item is closed

'''OnItemDropped(ITEM:item, STRING:itemTemplate)''' 
Thrown when an item is dropped

'''OnGlobalFlagSet(FIXEDSTRING:eventName)''' 
Thrown when a global event is set

'''OnGlobalFlagCleared(FIXEDSTRING:eventName)''' 
Thrown when a global event is cleared

'''OnCharacterFlagSet(FIXEDSTRING:eventName, CHARACTER:character)''' 
Thrown when a dialog event is set on a character

'''OnCharacterFlagCleared(FIXEDSTRING:eventName, CHARACTER:character)''' 
Thrown when a dialog event is cleared on a character

'''OnItemFlagSet(FIXEDSTRING:eventName, ITEM:item)''' 
Thrown when a dialog event is set on an item

'''OItemFlagCleared(FIXEDSTRING:eventName, ITEM:item)''' 
Thrown when a dialog event is cleared on an item

'''OnTimer(FIXEDSTRING:timerName)''' 
Thrown when a timer has ended

'''OnInit(-)''' 
Thrown when the script is set

'''OnLoaded(INT:major, INT:minor, INT:revision, INT:build)''' 
Thrown when the script is loaded from the savegame

'''OnShutdown(-)''' 
Thrown when the character's script is removed

'''OnVariableCleared(FIXEDSTRING:varName)''' 
Thrown when this object's script variable is cleared from Osiris with ClearVarObject

'''OnCombatStarted(INT:combatID)''' 
Thrown when combat starts

'''OnCombatSwitched(CHARACTER:source, ITEM:source)''' 
Thrown when the character switch from one combat to another

'''OnLeftCombat(CHARACTER:source, ITEM:source)''' 
Thrown when the character or item left the combat

'''OnTurn(CHARACTER:source, ITEM:source)''' 
Thrown when the character's turn starts

'''OnTurnEnded(CHARACTER:source, ITEM:source)''' 
Thrown when the character's turn ended

'''OnCharacterVitalityChanged(CHARACTER:character, FLOAT:percentage)''' 
Thrown when the characters's vitality changed

'''OnItemVitalityChanged(ITEM:item, FLOAT:percentage)''' 
Thrown when the item's vitality changed

'''OnAttackOfOpportunity(CHARACTER:target)''' 
Thrown when the characters gets an attack of opportunity on an enemy

'''OnClearAttackOfOpportunity(-)''' 
Thrown when the characters attack of opportunity is cleared

'''OnDamage(DAMAGE:type, FLOAT:percentage, CHARACTER:source, ITEM:source)''' 
Thrown when the object receives damage

'''OnMiss(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character dodges something

'''OnCriticalHit(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character is critical hit

'''OnPreBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown before the character blocks something (at the start of the attack animation)

'''OnBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character blocks something

'''OnDie(CHARACTER:character, DAMAGE:type, CHARACTER:source, ITEM:source)''' 
Thrown when the character dies

'''OnCharacterStatusAttempt(CHARACTER:character, STATUS:status)''' 
Thrown when the character attempts to gain a status

'''OnCharacterStatusApplied(CHARACTER:character, STATUS:status)''' 
Thrown when the character gains a status

'''OnCharacterStatusRemoved(CHARACTER:character, STATUS:status)''' 
Thrown when the character loses a status

'''OnItemStatusAttempt(ITEM:item, STATUS:status)''' 
Thrown when the item attempts to gain a status

'''OnItemStatus(ITEM:item, STATUS:status)''' 
Thrown when the item gains a status

'''OnItemStatusRemoved(ITEM:item, STATUS:status)''' 
Thrown when the item loses a status

'''OnStatusCreateVisuals(STATUS:status)''' 
Thrown when the item should create the visuals for this status

'''OnStatusDestroyVisuals(STATUS:status)''' 
Thrown when the item should destroy the visuals for this status

'''OnSight(CHARACTER:character)''' 
Thrown when the character sees another character

'''OnLostSight(CHARACTER:character)''' 
Thrown when the character doesn't see another character anymore

'''OnUseItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character uses an item

'''OnPickupItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character picks up an item

'''OnCharacterPreMovedItem(CHARACTER:source, ITEM:item)''' 
Event thrown just before a character moves an item. No difference whether it is in the world or in their inventory

'''OnCharacterMovedItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character moved an item

'''OnItemEquipped(CHARACTER:source, ITEM:item)''' 
Thrown when a character equips an item

'''OnItemUnequipped(CHARACTER:source, ITEM:item)''' 
Thrown when a character unequips an item

'''OnIterateCharacter(CHARACTER:character, FIXEDSTRING:eventId)''' 
Thrown by iterators

'''OnIterateItem(ITEM:source, FIXEDSTRING:eventId)''' 
Thrown by iterators

'''OnIterateCount(FIXEDSTRING:eventId, INTEGER:Count)''' 
Thrown by iterators after all iterations to inform you of the count.

'''OnStoryOverride(-)''' 
Throw when story overrides what the character was doing: teleport, movement, on/offstage

'''OnTriggerEnter(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)''' 
Thrown by a character or item entering an EventTrigger

'''OnTriggerLeave(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)''' 
Thrown by a character or item leaving an EventTrigger

'''OnEnemyChanged(CHARACTER:character, CHARACTER:newEnemy)''' 
Thrown when the character's currentenemy changes

'''OnTalentUnlocked(CHARACTER:character, TALENT:newTalent)''' 
Thrown when the character unlocks a new talent

'''OnTalentLocked(CHARACTER:character, TALENT:removedTalent)''' 
Thrown when the there's a talent removed from a character

'''OnCharacterClassChanged(CHARACTER:character, FIXEDSTRING:class)''' 
Thrown when the character changes class in the character creation screen

'''OnCharacterCreationStarted(CHARACTER:character, TRIGGER:creationPoint)''' 
Thrown when the character creation has started, and gives where the character should walk to

'''OnCharacterCreationStopped(CHARACTER:character)''' 
Thrown when the character creation has stopped

'''OnFunction(FIXEDSTRING:functionName)''' 
Throws an event on itself with the functionName. This is to fake function calls

'''OnSkillCast(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when the character casts a skill

'''OnSkillCombatComment(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when the character needs to make a comment

'''OnCharacterUsedSkillOnMe(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when you are hit by a skill from a character

'''OnItemUnlocked(ITEM: item, CHARACTER:character, ITEM:key)''' 
Thrown when an item gets unlocked by a character.

'''OnAutomatedDialogEnded(STRING:dialogName, INT:instanceID)''' 
Thrown when a automated dialog is ended for this speaker

'''OnAutomatedDialogStarted(STRING:dialogName, INT:instanceID)''' 
Thrown when a automated dialog is started for this speaker

'''OnDialogStarted(STRING:dialogName, INT:instanceID)''' 
Thrown when a dialog is started for this speaker

'''OnDialogEnded(STRING:dialogName, INT:instanceID)''' 
Thrown when a dialog is ended for this speaker

'''OnCrimeSensibleAction(FIXEDSTRING:regionID, INT:crimeID, FIXEDSTRING:reactionName, STRING:primaryDialog, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, INT:IsPrimary)''' 
Thrown when a character needs to perform a sensible action against criminals

'''OnCrimeInterrogationRequest(FIXEDSTRING:regionID, INT:crimeID, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, STRING:interrogationDialog)''' 
Thrown when a character needs to perform an interrogation against criminals

'''OnCrimeInvestigate(FLOAT3:CrimePosition, INT:crimeID)''' 
One NPC investigates a crimescene

'''OnCrimeAlarmed(FLOAT3:CrimePosition, INT:crimeID)''' 
All NPCs in a crimearea start looking around.

'''OnCrimeReturnToNormal(-)''' 
Investigation or Alarm timed out.

'''OnCrimeAborted(-)''' 
The game interrupted the sensible action of this NPC.

'''OnSplineControlPointReached(INT:Index, INT:EndReached, STRING:EventString)''' 
Thrown when a character reached a spline node.

''''OnFinishCalculationAi(-)''' 
Thrown when the calculation of the AI is finished.

'''OnGrenadeLand(INT:hitObstacle, CHARACTER:caster)''' 
Thrown when the grenades lands

'''FetchCharacterApplyStatusData(CHARACTER:character, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)''' 
Fetch from script which statuses to remove and apply.

'''FetchItemApplyStatusData(ITEM:item, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)''' 
Fetch from script which statuses to remove and apply.

'''FetchItemSkillOnDamage(INT:damage, DAMAGE_TYPE:damageType) RETURN(INT:hasSkill, SKILL_ID:skillID, INT:casterLevel)''' 
Fetch from script what skill to execute on damage.

'''FetchSkillScore(SKILL_ID:skillId, CHARACTER:sourceCharacter, CHARACTER:targetCharacter1, ITEM:targetItem1, FLOAT3:targetPosition1, CHARACTER:targetCharacter2, ITEM:targetItem2, FLOAT3:targetPosition2) RETURN(FLOAT:score) 
Fetch from script the score of a skill with set source and target

'''OnActivate(-)''' 
Thrown when a character/item activates

'''OnDeactivate(-)''' 
Thrown when a character/item deactivates

'''OnCharacterUsedSourcePoint(CHARACTER:character)''' 
Thrown when a character uses a source point

'''OnSkillAdded(CHARACTER:character, SKILL_ID:skillId, INT:learned)''' 
Thrown when a character learns a skill

'''OnSkillActivated(CHARACTER:character, SKILL_ID:skillId)''' 
Thrown when a character activates (=adds to memory) a skill

'''OnSkillDeactivated(CHARACTER:character, SKILL_ID:skillId)''' 
Thrown when a character deactivates (=removes from memory) a skill

'''OnItemFlagShared(FIXEDSTRING:eventName, ITEM:item, INT:newValue)''' 
Thrown when a dialog event is shared with an item

'''OnCharacterFlagShared(FIXEDSTRING:eventName, CHARACTER:character, INT:newValue)''' 
Thrown when a dialog event is shared with a character

'''OnItemOffStageChanged(CHARACTER:character, INT:offstage)''' 
Thrown when a character is set on/off stage

'''OnCharacterOffStageChanged(ITEM:item, INT:offstage)''' 
Thrown when a item is set on/off stage

'''OnCharacterTeleported(CHARACTER:target, CHARACTER:cause, FLOAT3:oldPosition, FLOAT3:newPosition, SKILL_ID:skillId)''' 
Thrown when a character gets teleported with a teleport skill

'''OnCombatTick(-)''' 
Thrown when this object ticks in combat. Only thrown for objects that don't get a turn.

'''OnCombatRoundStarted(INT:combatID, INT:roundID) 
Thrown when a round in a combat starts

'''OnReadyInCombat(CHARACTER:character, ITEM:item, INT:combatID)''' 
Thrown when a character or item is ready in combat

'''OnRegionLeft(CHARACTER:character, ITEM:item, FIXEDSTRING:region)''' 
Thrown when a character or item leaves a region

'''OnRegionEntered(CHARACTER:character, ITEM:item, FIXEDSTRING:region)''' 
Thrown when a character or item enters a region

'''OnRuneInserted(CHARACTER:character, ITEM:item, ITEMTEMPLATE:runeItemTemplate, INT:slot)''' 
Thrown when a <character> inserts a rune with roottemplate <runeItemTemplate> from an <item> at a specified <slot>

'''OnRuneRemoved(CHARACTER:character, ITEM:item, ITEM:rune, INT:slot)''' 
Thrown when a <character> removes a <rune> from an <item> at a specified <slot>

'''OnCharacterStartAttackObject(CHARACTER:defenderCharacter, ITEM:defenderItem, CHARACTER:attackerOwner, CHARACTER:attacker)''' 
Thrown when a character attacks a character or item with default attack

'''OnCharacterStartAttackPosition(FLOAT3:position, CHARACTER:attackerOwner, CHARACTER:attacker)''' 
Thrown when a character attacks a position with default attack

== INTERRUPTS ==

'''OnMovementFailed(FLOAT3:targetPos)''' 
Thrown when the reaction is interrupted by a move action failing

'''OnException(-)''' 
Thrown when the reaction is interrupted by an exception

'''OnBetterReactionFound(FIXEDSTRING:reactionName)''' 
Thrown when the reaction is interrupted by another reaction

'''OnNoReactionFound(-)''' 
Thrown when the reaction is interrupted because no reaction is valid

'''OnScriptDisabled(-)''' 
Thrown when the reaction is interrupted because the scriptcontroller is disabled

'''OnManualInterrupt(FIXEDSTRING:reactionName)''' 
Thrown when the reaction is interrupted using the interrupt action

'''OnRegionSwap(FIXEDSTRING:oldLevel, FIXEDSTRING:newLevel)''' 
Thrown when the reaction is interrupted by a region swap

Character and Item Script Triggers, Calls, and Queries

2018-03-02T11:47:57Z

Rimevan: /* INTERRUPTS */

This is a list of almost every character and item script event trigger, call, and query. An event is what triggers the script, and always begin with ''On''. Queries provide information and are always inside an ''IF'' or ''CHECK.'' Calls are actions that are always after THEN.

CharScript/ItemScript Functions

== CALLS ==

'''Set(OUT OBJECT:variable, OBJECT:value)'''

Set the value of a variable

'''SetVar(CHARACTER|ITEM:object, FIXEDSTRING:variableName, OBJECT:value)'''

Set the value of a global variable

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable

'''Print(OUT STRING:output, STRING:text)'''

Prints the text to the output with possible parameters: [1], [2], ...

'''Add(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Adds both values and stores it in the first variable

'''Subtract(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Subtracts both values and stores it in the first variable

'''Multiply(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Multiplies both values and stores it in the first variable

'''Divide(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Divides both values and stores it in the first variable

'''Abs(INOUT INT|FLOAT:variable)'''

Takes the absolute value of a variable

'''Clamp(INOUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Clamps a variable between min and max

'''GetRandom(OUT OBJECT:variable, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with random one of the values.

'''GetWeightedRandom(OUT OBJECT:variable, OBJECT:value, INT|FLOAT:weight, ...)'''

Gets a weighted random of the given values!

'''GetRandomBetween(OUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Gets a random value between min and max (both included)

'''GetRandomPositionInTrigger(OUT FLOAT3:variable, TRIGGER:areaTrigger)'''

Get a random position in a trigger area

'''GetElement(OUT OBJECT:variable, INT:index, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with the index one of the values (starting from 0)

'''SetPriority(FIXEDSTRING:reactionName, INT:priority)'''

Changes the priority of a reaction. Priority 0 and below are not executed!

'''DelayReaction(FIXEDSTRING:reactionName, FLOAT:timeInSeconds)'''

The reaction will not be chosen for the specified time

'''SetScriptFrame(CHARACTER:character, FIXEDSTRING:frame)'''

Sets the scriptframe on the character.

'''ClearScriptFrame(CHARACTER:character)'''

Clears the scriptframe on the character.

'''Goto(FIXEDSTRING:labelName)'''

Jumps to the label. Two label names are built-in: "Start" for the first instruction of the reaction, and "End" for the last one.

'''GotoIfEqual(OBJECT:variable, OBJECT:value, FIXEDSTRING:labelName)'''

Jumps to the label if the 2 objects are equal

'''GotoRand(FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName)'''

Jumps to a random label in the list

'''CreatePuddleAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, INT:cellAmountMin, INT:cellAmountMax, INT:growAmountMin, INT:growAmountMax, )'''

Spawn a puddle at the target's position for a certain lifetime (in turns)

'''CreateSurfaceAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, INT:lifeTime[, GAMEOBJECT:owner])'''

Spawn a surface at the target's position for a certain lifetime (in turns)

'''CreateSurfaceInPolygon(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, GAMEOBJECT|FLOAT3:point1, GAMEOBJECT|FLOAT3:point2, GAMEOBJECT|FLOAT3:point3, ...)'''

Spawn a polygon surface at the target's position. Grows <growStep> every <growTimer>.

'''CreateSurfaceInAreaTrigger(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, TRIGGER:areaTrigger)'''

Spawn a surface within <areaTrigger>. Grows <growStep> every <growTimer>.

'''CreateConeSurfaceAt(GAMEOBJECT|FLOAT3:start, GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, FLOAT:angle, FLOAT:duration)'''

Spawn a Cone surface at the target's position

'''PlayEffectAt(GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''PlayLoopEffectAt(OUT INT64:effectHandle, GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''ExplodeAt(GAMEOBJECT|FLOAT3:target, SKILL:projectileSkill, [INT:casterLevel=-1, CHARACTER|ITEM:cause])'''

Trigger an explosion of a projectile skill at the target's position. The cause will trigger NPC behavior as if the cause casted the projectile

'''DisplayText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''DisplayCombatInfoText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''StatusText(CHARACTER|ITEM:target, FIXEDSTRING:text)'''

Adds statustext above the character/item for a short amount of time. Will not replace texts or dialogtexts

'''DebugText(CHARACTER|ITEM:target, STRING:text)'''

Adds debugtext above the character/item for a short amount of time.

'''CombatLogText(CHARACTER|ITEM:target, FIXEDSTRING:text, INT:filterID, INT:broadcastID)'''

Adds combatlog text inside the combat log window. Color-/SizeFormatting should already be applied, if not color and size of the string will be NORMAL. filterID determines what filter shows/hides the text. broadcastID determines who will be able to see the message (0 hearingrange. 1 party. 2 all)

'''Log(STRING:text, ...)'''

Log's the the scriptlog. (for debugging purposes)

'''Output(STRING:text, ...)'''

Pass text with optional parameters to the output panel (e.g. Output("An int [1]", INT:10))

'''Assert(STRING:text, ...)'''

Pass text with optional parameters to display as an assert message (e.g. Assert("This number is wrong: [1]", INT:666))

'''Label(FIXEDSTRING:name)'''

Marks this line as a label where Goto actions can jump to

'''StartTimer(FIXEDSTRING:timerName, FLOAT:timeInSeconds, INT:repeatCount)'''

Start a timer which will throw the timer event. Set repeatcount < 0 for a permanent timer.

'''StopTimer(FIXEDSTRING:timerName)'''

Stop a timer which will throw the timer event

'''DialogStart(OUT INT:instanceId, STRING:dialog, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target)'''

Start a dialog between the targets. You can specify fewer targets than the maximum number.

{{warning|Starting a dialog from behaviour script will always start it as an [[Dialog_editor#Automated|Automated Dialog]]. Interactive dialogs can only be started from [[Osiris]].}}

'''DialogRequestStop(CHARACTER|ITEM:speaker, STRING:dialog)'''

Stops a certain dialog on a certain speaker

'''Check(-)'''

Reevaluate the conditions in the CHECK section of this reaction

'''Reset(-)'''

Resets the current reaction. It will start from the beginning again

'''Interrupt(FIXEDSTRING:reactionName)'''

Interrupt the reaction.

'''GlobalSetEvent(FIXEDSTRING:eventName)'''

Sets a global event. Scripts and Story can catch it.

'''GlobalClearEvent(FIXEDSTRING:eventName)'''

Clears a global event. Scripts and Story can catch it.

'''StopLoopEffect(INT64:fxHandle)'''

Stops a looping effect

'''IterateItems(FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item. If you pass a tag, it has to have that tag.

'''IterateItemsNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item in range. If you pass a tag, it has to have that tag.

'''IterateItemsOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item standing on the source. If you pass a tag, it has to have that tag.

'''IterateParty(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, CHARACTER:partyMember, FIXEDSTRING:tag])'''

Launch iterate event for each member of all parties. If you pass a party member only members of that party will be considered. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharacters(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in range. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''
Launch iterate event for each character standing on the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersInCombat(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in combat with the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateHostilesFor(CHARACTER:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character who is targetting the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''SpawnCharacter(OUT CHARACTER:result, CHARACTERTEMPLATE:rootTemplate, GAMEOBJECT|FLOAT3:position, INT:playSpawn, [INT:isSummon=0, CHARACTER:summonOwner=null, INT:overrideLevel=-1])'''

Spawns a character

'''SpawnItem(ITEMTEMPLATE:rootTemplate,GAMEOBJECT|FLOAT3:position, OUT ITEM:result)'''

Spawns an item

'''ShootLocalProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootLocalProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootWorldProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootWorldProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootLocalCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) in a direction

'''ShootLocalConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) at the target

'''ShootWorldCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Shoots a cone from worldPos in a direction. Source can be null.

'''ShootWorldConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Shoots a cone from worldPos at the target. Source can be null.

'''SetVisible(CHARACTER|ITEM:object, INT:visible)'''

Sets a character or item visible or not.

'''RotateY(INOUT FLOAT3:vector, FLOAT:degrees)'''

Rotate the vector around the Y-axis for a certain angle (in degrees)

'''SetHealth(CHARACTER|ITEM:target, FLOAT:percent)'''

Set a characters or items health on the given percentage. (percentage between 0 and 1)

'''PlaySound(CHARACTER|ITEM:target, STRING:soundEvent)'''

Plays a sound event at the target

'''PlayMusicForEveryone(STRING:musicEvent)'''

Plays a music event on all the clients

'''PlayMusicOnCharacter(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on a character for all peers (3D)

'''PlayMusicForPeer(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on the peer of the character

'''PlayMusicForPeerWithInstrument(CHARACTER:target, CHARACTER:charInstrument, STRING:musicEvent)'''

Plays a music event on the peer of the character concated with _INSTRUMENT

'''SetX(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the X component of the FLOAT3

'''SetY(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Y component of the FLOAT3

'''SetZ(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Z component of the FLOAT3

'''SetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID, FIXEDSTRING:atmosphere)'''

Changes the atmosphere of the trigger

'''ResetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID)'''

Resets the atmosphere of the trigger

'''AddStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1], [INT:force=1])'''

Adds the status influence strength on the object.

'''RemoveStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Removes the status influence strength on the object.

'''AddTemporaryStatusInfluence(CHARACTER|ITEM:source, CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Adds a temporary status influence strength on the object.. It will be gone in a few seconds if it's not set again

'''CallFunction(FIXEDSTRING:functionName)'''

Calls a function with the ID

'''SetMaterial(CHARACTER|ITEM:object, FIXEDSTRING:materialUUID, INT:duration, INT:applyOnBody, INT:applyOnArmor, INT:applyOnWeapon[)'''

Changes the material of the object for a set time (in turns), -1 is infinite. applyNormalMap: Copy the original materials normal map

'''TeleportTo(CHARACTER|ITEM:object, GAMEOBJECT|FLOAT3:target, [INT:Force=0])'''

Teleport object to or near the target

'''Transform(CHARACTER|ITEM:object, CHARACTERTEMPLATE|ITEMTEMPLATE:root [, FIXEDSTRING:fx, INT:replaceScripts=1, OUT FLOAT:currentHP])'''

Transforms <object> using <root>, returns <currentHP>, plays <fx>.

'''SaveGame(FIXEDSTRING:saveGameName)'''

Save the savegame with name <saveGameName>

'''LoadGame(FIXEDSTRING:saveGameName)'''

Load the savegame with name <saveGameName>

'''LoadLevel(FIXEDSTRING:levelName)'''

Load the level with name <levelName>

'''KillCombat(CHARACTER:character)'''

Kill all the enemies in the combat which contains <character>

'''SetTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Sets the Tag on the Object

'''ClearTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Clears the Tag on the Object

'''SetGlobalFlag(FIXEDSTRING:flagname)'''

Sets the Global Flag

'''ClearGlobalFlag(FIXEDSTRING:flagname)'''

Clears the Global Flag

'''SetFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the Object

'''ClearFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the Object

'''SetUserFlag(CHARACTER:object, FIXEDSTRING:flagname)'''

Sets the Flag on the user's characters

'''ClearUserFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the user's characters

'''SetPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the party's characters

'''ClearPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the party's characters

'''StartVoiceBark(STRING:barkName, CHARACTER:character)'''

Start a voicebark on character

'''ConfrontationDone(INT: CrimeID, CHARACTER:lead, CHARACTER:criminal, ...)'''

Resolve the crime with id CrimeID for the specified criminals

'''CrimesceneInvestigationDone(CHARACTER:investigator)'''

Crimescene is considered investigated by this NPC, start looking for culprits

'''ListAdd(LIST<OBJECT>:list, OBJECT:entry)'''

Add <entry> at the back of <list>

'''ListRemove(LIST<OBJECT>:list, INT:index)'''

Remove the entry at <index> of <list>

'''ListSet(LIST<OBJECT>:list, INT:index, OBJECT:entry)'''

Set the entry at <index> of <list> to <entry>

'''ListClear(LIST<OBJECT>:list)'''

Remove all entries of <list>

'''EndTurn(CHARACTER|ITEM:Target)'''

Ends the object's current turn

'''SetCanFight(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can fight. Optional for the whole group

'''SetCanJoinCombat(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can join combats. Optional for the whole group

'''SetIsBoss(CHARACTER|ITEM:entity, INT:enabled)'''

Enables/Disables the fact if the entity is a boss.

'''GetAIHintTriggers(OUT LIST<TRIGGER>:triggers[, [LIST]FIXEDSTRING:tags, INT:needsAllTags = -1)'''

Returns all AIHintAreaTriggers in <triggers>. Uses contraints if set.

'''SetCombatTimeout(CHARACTER|ITEM:entity, FLOAT:timer)'''

Overwrites the entity's combat timeout check.

'''ResetCombatTimeout(CHARACTER|ITEM:entity)'''

Resets the entity's combat timeout check.

'''EnterCombat(CHARACTER|ITEM:source, CHARACTER|ITEM:target)'''

Enters combat with target

'''LeaveCombat(CHARACTER|ITEM:source)'''

Leaves the combat

'''SetFaction(CHARACTER|ITEM:target, FIXEDSTRING:faction)'''

Changes the faction of a character or item

'''SetInvulnerable(CHARACTER|ITEM:target, INT:bool)'''

Makes the character or item invulnerable or not. (Allow damage)

'''JumpToTurn(CHARACTER|ITEM:Target)'''

Jumps to targets turn (ends the current turn)

'''Sleep(FLOAT:timeInSeconds)'''

Sleeps for a certain amount of time

'''CharacterAttack(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Moves in weapon range and attacks the target

'''CharacterAttackWithoutMove(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Attacks the target without checking weaponranges and without moving

'''CharacterMoveTo(GAMEOBJECT|FLOAT3:target, [INT:running=0, INT:shouldArrive=0, INT:longPath=0, FLOAT:minDistance=1.5, FLOAT:maxDistance=minDistance+2.5])'''

Move to the target. Set shouldArrive to 1 if you want a guaranteed move. (teleports on fail)

'''CharacterAiMove(FLOAT3:target, CHARACTER:targetCharacter, ITEM:targetItem)'''

Moves to the target, calculated by the AI. Should only be used with results from the AI!

'''CharacterMoveInRange(GAMEOBJECT|FLOAT3:target, FLOAT:rangeMin, FLOAT:rangeMax, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within a certain range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInWeaponRange(GAMEOBJECT|FLOAT3:target, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within weapon range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInSkillRange(GAMEOBJECT|FLOAT3:target, SKILL:skill, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within skill range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveOutOfSight(FLOAT:angle)'''

Move out of screen

'''CharacterPlayAnimation(FIXEDSTRING:animation [, INT:exitOnFinish=1, INT:waitForCompletion=1])'''

Plays a certain animation ExitOnFinish means if the exit will kill itself after it was played (revert back to still)

'''CharacterStopAnimation(-)'''

Stops all animations.

'''CharacterPickUpItem(ITEM:item)'''

Moves close enough to the item if necessary and picks it up

'''CharacterUseItem(ITEM:item [, INTEGER:LongPath])'''

Moves close enough to the item if necessary and uses it

'''CharacterMoveItem(ITEM:item, INTEGER:ignoreWeight, INTEGER:ignoreAPCost [, INTEGER:ignoreDangerousSurfaces=1, INT:amount=-1, GAMEOBJECT|FLOAT3:destination])'''

Moves close enough to the item if necessary and moves it to the destination. Will try to find a destination if not supplied.

'''CharacterAddSkill(CHARACTER:character, SKILL:skill[, INT:ShowNotification=0])'''

Adds <skill> to <character>

'''CharacterRemoveSkill(CHARACTER:character, SKILL:skill)'''

Removes <skill> from <character>

'''CharacterUseSkill(SKILL:skill, GAMEOBJECT|FLOAT3:target [, GAMEOBJECT|FLOAT3:target2, ITEM:skillItem, INT:ignoreHasSkill=0])'''

Cast a skill

'''CharacterAppearAt(GAMEOBJECT|FLOAT3:target, INT:playspawn)'''

Appear at the target

'''CharacterAppearOutOfSightTo(GAMEOBJECT:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players from a certain angle while being able to reach target

'''CharacterAppearOnTrailOutOfSightTo(CHARACTER:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players, on its previous locations, from a certain angle while being able to reach target

'''CharacterDisappear(FLOAT:angle[, INTEGER:isRunning=0])'''

Move out of screen and go of stage, will run if <isRunning> is not 0

'''CharacterSetOffStage(-)'''

Set Off Stage

'''CharacterSetOnStage(-)'''

Set On Stage

'''CharacterLookAt(GAMEOBJECT|FLOAT3|SPLINE:target[, INT:snapToTarget=0, INT:angleTolerance=0])'''

Rotates the character to look at the target (Closest spline point in case of a spline).

'''CharacterLookFrom(GAMEOBJECT|SPLINE:target[, INT:snapToTarget=0])'''

Rotates to the character so it has the same rotation as the target (Closest spline point in case of a spline).

'''CharacterFollow(CHARACTER:target, FLOAT:durationInSeconds, INT:run)'''

Follow the target for a certain time

'''CharacterFollowOwnerOrLeader(FLOAT:durationInSeconds, INT:run)'''

Follow the leader or owner for a certain time

'''CharacterWander(FLOAT|TRIGGER:range, FLOAT:durationInSeconds [, INT:run, GAMEOBJECT:anchor])'''

Wander around for a certain time

'''CharacterSwitchWeaponType(WEAPON:type)'''

If necessary switch to the new weapon type

'''CharacterFleeFrom(RELATION:relation, FLOAT:range)'''

Run away from certain characters if necessary
'''
CharacterFleeFromSurface(SURFACE:surface)'''

Run away from a certain surface if necessary

'''CharacterFleeFromDangerousSurface(-)'''

Run away from a dangerous surfaces if necessary

'''CharacterAddSourcePoints(CHARACTER:character, INT:amount)'''

Adds x source points (x can be negative to substract)

'''CharacterDie(CHARACTER:character[, DEATH:type=DoT])'''

Kills the character

'''CharacterHeal(CHARACTER:character, FLOAT:percentage)'''

Heals the character

'''CharacterConsume(CHARACTER:character, POTION:potion)'''

Makes the character consume a potion. Doesn't cost any AP and will just execute the result of the potion.

'''CharacterDisableAllCrimes(CHARACTER:target)'''

Disables all generic behaviours for <target>.

'''CharacterEnableAllCrimes(CHARACTER:target)'''

Enables all generic behaviours for <target>.
'''
CharacterEnableCrime(CHARACTER:target, STRING:crime, ...)'''

Enables the specified generic behaviours for <target>.

'''CharacterDisableCrime(CHARACTER:target, STRING:crime, ...)'''

Disables the specified generic behaviours for <target>.

'''CharacterSetLongInvestigationDuration(CHARACTER:target)'''

Doubles the time it takes for the investigation to time out. Use this when the character needs to move a long path before investigating.

'''CharacterAiCalculate(-)'''

Calculate the AI of the character

'''CharacterAiStopCalculate(-)'''

Stop the calculation of the AI of the character

'''CharacterAiFinishMoveSkill(-)'''

Finish the current MoveSkill.
'''
CharacterAiAddInterestingItem(CHARACTER:character, ITEM:item)'''

Make it interesting for the AI to destroy that Item

'''CharacterAiRemoveInterestingItem(CHARACTER:character, ITEM:item)'''

Make it no longer interesting for the AI to destroy that Item

'''CharacterSetArchetype(CHARACTER:character, ARCHETYPE:archetype)'''

Sets the archetype of the character, used in AI calculations

'''CharacterSetStoryNPC(CHARACTER:character, INT:bool)'''

Makes the character storyNPC or not.
'''
CharacterAddActionPoints(CHARACTER:character, INT:amount)'''

Give character some action points

'''CharacterSetImmortal(CHARACTER:character, INT:bool)'''

Makes the character immortal or not. (Allow dying)

'''CharacterPlayEffect(CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the character and it follows the character

'''CharacterPlayLoopEffect(OUT INT64:effectHandle, CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the character and it follows the character

'''CharacterEvent(CHARACTER:character, STRING:eventName)'''

Throw a character event which you can catch in scripts and story

'''CharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)'''

Throw a character/item event which you can catch in scripts and story

'''CharacterCharacterEvent(CHARACTER:character1, CHARACTER:character2, STRING:eventName)'''

Throw a character/character event which you can catch in scripts and story

'''CharacterSetRelationIndivToIndiv(CHARACTER:source, CHARACTER:target, INT:relation)'''

Changes the relationship between 2 characters.
'''
CharacterForceUpdate(INT:forceUpdate)'''

Makes sure the attached character is always being update or not.
'''
CharacterSetEnemy(CHARACTER:character, CHARACTER:enemy)'''

Sets the current enemy of character

'''CharacterApplyStatus(CHARACTER:character, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the character When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''CharacterRemoveStatus(CHARACTER:character, STATUS:statusId [, STATUS:reasonStatusID=null])'''

Removes the status from the character

'''CharacterDestroy(CHARACTER:character)'''

Destroys the character

'''CharacterSetCanSpotSneakers(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can spot sneaking characters.

'''CharacterSetAttackOfOpportunity(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can do attack of opportunities.

'''CharacterResurrect(CHARACTER:character [, INT:Percentage = 100])'''

Resurrects the character at [2]% health.

'''CharacterAddToInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount, INT:showInTrade=1])'''

Add the item to the character

'''CharacterRemoveFromInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount])'''

Remove the item from the character. If Amount is -1, then all are removed

'''CharacterDrinkPotion(FIXEDSTRING:statID)'''

Makes the character drink a potion from the inventory.

'''CharacterSetAnimationOverride(CHARACTER:character, FIXEDSTRING:animation)'''

Sets an animation override, only walk/run/die animations can override it.

'''CharacterUseActionPoints(CHARACTER:character, INT:amount [, OUT INT:succeeded])'''

Uses x action points

'''CharacterAddTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Adds <treasureTable> to the treasure list of <character>

'''CharacterRemoveTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Removes <treasureTable> from the treasure list of <character>

'''CharacterClearTreasureTables(CHARACTER:character)'''

Removes all treasure tables from <character>

'''CharacterSetTemporaryHostileRelation(CHARACTER:character, CHARACTER:otherCharacter)'''

Creates a temporary hostile relation between the 2 characters!

'''CharacterSetFightMode(CHARACTER:character, INT:fight [, INT:force=0])'''

Set the character in sheath/unsheated mode.

'''CharacterSetStats(CHARACTER:character, FIXEDSTRING:statsEntry [, INT:keepVitality=0, INT:keepAP=0, INT:keepLevel=0, OUT FLOAT:currentHP])'''

Applies <statsEntry> from character.xlsm to <character>, returns <currentHP>.

'''CharacterSetWalkSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:walkSpeed])'''

Sets walk speed override of <character>, removes it if <override> is 0

'''CharacterSetRunSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:runSpeed])'''

Sets run speed override of <character>, removes it if <override> is 0

'''CharacterSetHasDialog(CHARACTER:character, INTEGER:bool)'''

Enables/Disables the dialog of the character

'''CharacterInitPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStartPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStopPatrol(-)'''

Let the character stop patrolling whatever spline he's on!

'''CharacterInterruptPatrol(-)'''

Call when the patrol should interrupt so the guard stops moving to the next spline. If this is called when the character is deactivated, a caret will take his place.

'''CharacterSetAnimationSetOverride(CHARACTER:source, FIXEDSTRING:override)'''

Sets an animation set override for a character. Empty fixedstring clears the override.

'''CharacterSetFloating(CHARACTER:target, INTEGER:isFloating)'''

Sets <target> floating if <isFloating> is not 0

'''CharacterResetCooldowns(CHARACTER:target)'''

Resets the skill cooldowns for <target>

'''ItemEvent(ITEM:item, STRING:eventName)'''

Throw an item event which you can catch in scripts and story

'''ItemPlayAnimation(FIXEDSTRING:animation)'''

Plays an animation on the item

'''ItemPlayAnimationTo(FIXEDSTRING:animation, FLOAT:targetPercentage, [FLOAT:speed])'''

Plays an animation on the item to the target time (percentage of the total duration)

'''ItemPlayEffect(ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the item and it follows the item

'''ItemPlayLoopEffect(OUT INT:effectHandle, ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the item and it follows the item

'''ItemSetOnStage(ITEM:item, INTEGER:bool)'''

Sets an item on or offstage

'''ItemSetCanInteract(ITEM:item, INTEGER:bool)'''

Sets an item (not) interactible

'''ItemClose(ITEM:item)'''

Close an item

'''ItemOpen(ITEM:item)'''

Open an item

'''ItemDrop(ITEM:item)'''

Drop an item

'''ItemLock(ITEM:item, FIXEDSTRING:key)'''

Lock an item

'''ItemUnlock(ITEM:item)'''

Unlock an item

'''ItemApplyStatus(ITEM:item, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the item When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''ItemRemoveStatus(ITEM:item, STATUS:statusId)'''

Removes the status from the item

'''ItemDie(ITEM:item)'''

Kills the item

'''ItemMoveTo(GAMEOBJECT|FLOAT3:target, FLOAT:velocity, FLOAT:acceleration, INTEGER:matchTargetRotation)'''

Moves the item to the target

'''ItemToInventory(ITEM:item, CHARACTER|ITEM:target [,INT:amount=-1])'''

Moves the item to the target's inventory

'''ItemLookAt(GAMEOBJECT:target, FLOAT:degreesPerSecond)'''

Rotates the item to look at the target

'''ItemDestroy(ITEM:item)'''

Destroys the item

'''ItemSetAmount(ITEM:item, INT:amount)'''

Change the amount of the item

'''IterateItemsInInventory(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each iten in source's inventory. If you pass a tag, it has to have that tag.

'''ItemAddCharges(ITEM:TargetItem, INT:charges)'''

Add/subtract charges from an item

'''ItemResetChargesToInitial(ITEM:TargetItem)'''

Resets charges from item to initial state

'''MakePeace(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make peace between users of the characters

'''MakeWar(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make war between users of the characters

'''FindSurface(OUT FLOAT3:result, GAMEOBJECT|FLOAT3:source, FLOAT:minRange, FLOAT:maxRange, SURFACE:type [,CHARACTER:alignSource, INT:minEnemiesInSurface, INT:maxAlliesInSurface, INT:minimumCellCount])'''

Finds the closest surface of a specific type.

'''FindValidPosition(INOUT FLOAT3:position, FLOAT:radius[, CHARACTER|ITEM:object=null])'''

Finds the closest valid position (where the object can stand.)

'''FindPosition(INOUT FLOAT3:position, CHARACTER:source, INT:canStand, INT:checkSight, FLOAT:minRadius, FLOAT:maxRadius, FLOAT:rangeCheck, CHARACTER:alignSource, INT:minAllies, INT:maxAllies, INT:minEnemies, INT:maxEnemies [,FIXEDSTRING:AiHintTag=null, INT:forceHint=0, FLOAT3:SourcePosition])'''

Finds the closest position from the source (within radius) where the conditions are matched.

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable.

'''StringConcatenate(STRING:stringA, STRING:stringB, OUT STRING:resultingString)'''

Appends stringB to stringA. Resulting string is stored in the third parameter.

== QUERIES ==

GetPosition(GAMEOBJECT:object,OUT FLOAT3:src)

Get the current position of an object

GetForwardDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current forward direction of an object

GetRightDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current right direction of an object

GetUpDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current up direction of an object

GetDirection(GAMEOBJECT|FLOAT3:src,GAMEOBJECT|FLOAT3:target,OUT FLOAT3:direction[, OUT FLOAT:distance])

Get the direction from src to target (optional: returns the distance between the objects as well)

GetRotation(GAMEOBJECT:object, OUT FLOAT3:vector)

Get the rotation of an object

CharacterGetTargetSpline(INT: SplineIndex)

Returns the spline index the character is currently walking towards, or -1 if he is not active on a spline.

IsEqual(OBJECT:variable, OBJECT:variable)

Compares both objects and see if they are equal.

IsLessThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is smaller.

IsGreaterThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is bigger.

IsRandom(FLOAT:percentage)

Each time this condition is checked, it will succeed with a chance of the percentage (between 0 and 1)

IsRound(INT:roundNumber)

Checks if we are currently in combat in round x

IsInSurface(OBJECT|FLOAT3:target, SURFACE:type[, FLOAT:radius])

Check if the character, item, trigger or position is currently within the specific surface.

IsInDangerousSurface(OBJECT|FLOAT3:target[, CHARACTER:character, FLOAT:radius])

Check if <target> is currently in on a dangerous surface. Uses <character> for path influences if provided (is necessary with non-character targets)

IsInDialog(CHARACTER|ITEM:target[, INT:ignoreAutomatedDialogs=0])

Check if the character or item is currently in a dialog, optionally ignoring automated dialogs

IsInAutomatedDialog(CHARACTER|ITEM:target)

Check if the character or item is currently in an automated dialog

GetDistance(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)

Returns the distance between 2 positions

GetDistance2D(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)
Returns the 2D distance between 2 positions (ignores height)

GetInnerDistance(OUT FLOAT:distance, GAMEOBJECT:source, GAMEOBJECT:target)

Returns the distance between 2 gameobjects (character, item, trigger, ...) Their bounds are already subtracted.

GetPosition(GAMEOBJECT:object, OUT FLOAT3:position)

Returns the position of a gameobject (character, item, trigger, ...)

GetVar(OUT OBJECT:returnValue, CHARACTER|ITEM:target, FIXEDSTRING:varName)

Gets a global variable from the target

GetClosestPlayer(OUT CHARACTER:player, GAMEOBJECT|FLOAT3:source)

Gets the closest player near the source, default being being the object itself

GetPlayerCount(OUT INT:playerCount)

Gets the number of players in the party

GetPlayerByIndex(OUT CHARACTER:returnCharacter, INT:playerIndex)

Gets a player from the party by index

GetRandomCharacter(OUT CHARACTER:returnCharacter, [INT:canBeSelf=0, INT:canBePlayer=0])

Gets a random character in the current level

ContainsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if there is any surface of the type within a radius of the source

IsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if the whole radius around the source is the specified surface type

IsObjectOnObject(CHARACTER|ITEM:source,CHARACTER|ITEM:target)

Checks if the source is standing on the target

GetX(FLOAT3:vector, OUT FLOAT:value)

Returns the X component of the vector

GetY(FLOAT3:vector, OUT FLOAT:value)

Returns the Y component of the vector

GetZ(FLOAT3:vector, OUT FLOAT:value)

Returns the Z component of the vector

CanSee(GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target[, INT:addProjectileTargetGroundOffset=0])

Check if the sight is blocked between 2 points.

IsVisible(CHARACTER|ITEM:object)

Check if the object is set invisible or not with SetVisible.

GetTextDuration(CHARACTER|ITEM:object, FIXEDSRTING:key, OUT FLOAT:duration)

Gets how long a text needs to be displayed

IsCasual(-)

Returns if the current game mode is Casual

IsHardcore(-)

Returns if the current game mode is Hardcore

IsTagged(GAMEOBJECT:object, FIXEDSTRING:tag)

Check if the object is tagged.

TranslatedStringKeyExists(FIXEDSTRING:key)

Check if the TranslatedString key exists.

IsInCombat(CHARACTER|ITEM:object)

Returns true if the object is in combat.

IsInCombatWith(CHARACTER|ITEM:object, CHARACTER|ITEM:object)

Returns true if the objects are in combat with each other.

IsFacing(GAMEOBJECT:source, GAMEOBJECT|FLOAT3:target, [INT:angle=90])

Returns true if the object is facing the position within the given angle.

GameIsSaving(-)

Returns true if the game is saving.

GameIsLoading(-)

Returns true if the game is loading.

GetUserCount(OUT INT:userCount)

Returns the user count.

GetCurrentCharacter(OUT CHARACTER:character, INT:user)

Returns the character currently being controlled by the specified user.

GetCurrentLevel(OUT FIXEDSTRING:currentLevel)

Returns the current levelname

GetAIBounds(CHARACTER|ITEM:source, OUT FLOAT:bounds)

Returns AI bounds of <source> in <bounds>

HasGlobalFlag(FIXEDSTRING:flagName)

Returns if the Global Flag is set

HasFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the Object

HasUserFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the user's characters

HasPartyFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the party's characters

DialogExists(STRING:dialogue)

Returns true if the dialogue exists.

IsActive(CHARACTER|ITEM:Object)

Returns if the character or item is currently active.

ListGetSize(LIST<OBJECT>:list, out INT:size)

Returns the number of elements in <list>

ListGet(LIST<OBJECT>:list, INT:index, out OBJECT:entry)

Returns <entry> at <index> of <list>

ListGetRandom(LIST<OBJECT>:list, out OBJECT:entry)

Returns a random <entry> of <list>

IsBoss(CHARACTER|ITEM:Object)

Returns true if the entity is tagged as a boss

IsProjectileSkill(SKILL:skill)

Returns true if the skill is a ranged skill (uses a projectile)

IsValidSkillTarget(CHARACTER:source, OBJECT|FLOAT3:target, SKILLID:skill[, INTEGER:ignoreRangeCheck=0])

Checks whether <target> is a valid target for <skill> at <source>

GetFaction(OUT FIXEDSTRING:faction, CHARACTER|ITEM:character)

Returns the faction of the provided character or item

IsInActiveTurn(CHARACTER|ITEM:target)

Returns true if it's the character's or item's turn in combat.

IsSkillActive(CHARACTER:character, SKILL:skillId)

Returns true if <character> has <skillId> active (in memory).

HasSkillAi(SKILLID:skillId)

Returns true if the skill is using the new Ai system

IsInArena(CHARACTER::character)

Returns true if the character is in an arena fight

CrimeGetType(INTEGER:crimeId, OUT STRING:crimeType)

Returns the type of the crime with this id.

CrimeGetCriminals(INTEGER:crimeId, OUT CHARACTER:criminal1, OUT CHARACTER:criminal2, OUT CHARACTER:criminal3, OUT CHARACTER:criminal4)

Returns the criminals of that crime. They might all be null.

IsSourceSkill(SKILL:skill)

Returns true if the skill is a source skill.

IsInGameMasterMode(-)

Returns true if the game in game master mode.

CharacterGet(OUT CHARACTER:character, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo, COMPAREFUNC:compareFunc[, RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf, FIXEDSTRING:tag])

Get a character within a certain range conforming to the filled in restraints.

CharacterCount(OUT INT:count, GAMEOBJECT|FLOAT3:src, FLOAT:range, [RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf])

Counts the characters within a certain range conforming to the filled in restraints.

CharacterGetOwner(OUT CHARACTER:owner, CHARACTER:source)

Get the character's owner

CharacterGetFollow(OUT CHARACTER:to follow, CHARACTER:source)

Get the character to follow

CharacterGetEnemy(OUT CHARACTER:current enemy, CHARACTER:source)

Get current enemy of character

CharacterCanCast(CHARACTER:source, SKILL:skillId, [ITEM:skillItem=null, INT:ignoreActionPoints=0])

Check if the character source can cast the skill: will check cooldown, actionpoints

CharacterCanSitOnItem(CHARACTER:source, ITEM:item)

Check if the character source can sit or lie on an item.

CharacterCanDrinkPotion(CHARACTER:source, FIXEDSTRING:potionID[, INT:ignoreActionPoints=0])

Check if the character source can drink the potion: will check inv and actionpoints

CharacterCanUseItem(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in the world

CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in his inventory

CharacterCanSee(CHARACTER:watchingChar, CHARACTER|ITEM:target [, INT:forceUpdate=0])

Check if character has target in his line of sight.

CharacterCanShoot(CHARACTER:source, GAMEOBJECT|FLOAT3:target)

Check if the character can shoot the target.

CharacterIsPlayer(CHARACTER:character)

Check if the character is a player

CharacterIsInParty(CHARACTER:character)

Check if the character is in the party

CharacterIsEnemy(CHARACTER:source, CHARACTER:target)

Check if target is enemy of source

CharacterIsAlly(CHARACTER:source, CHARACTER:target)

Check if target is ally of source

CharacterIsNeutral(CHARACTER:source, CHARACTER:target)

Check if target is neutral of source

CharacterIsDead(CHARACTER:character)

Check if character is dead

CharacterIsMoving(CHARACTER:character)

Check if character is moving (speed > 0)

CharacterIsSummon(CHARACTER:character)

Check if character is a summon

CharacterIsPartyFollower(CHARACTER:character)

Check if character is a party follower

CharacterIsStoryNPC(CHARACTER:character)

Check if character is a story NPC

CharacterInWeaponRange(CHARACTER:character, CHARACTER:target)

Check if target is in the current's weapon range

CharacterInTouchRange(CHARACTER:character, CHARACTER:targetChar)

Check if target is in the character's touch range

CharacterHasStatus(CHARACTER:character, STATUS:statusId[, FIXEDSTRING:extraData])

Check if character currently has the status. ExtraData can be filled in for some statuses: - Consume: statsid of the item - Shield: skillid of the shield

CharacterGetStatusSourceCharacter(CHARACTER:character, STATUS:statusId, OUT CHARACTER:source[, FIXEDSTRING:extraData])

Get the source character of a status

CharacterGetStatusSourceItem(CHARACTER:character, STATUS:statusId, OUT ITEM:source[, FIXEDSTRING:extraData])

Get the source item of a status

CharacterHasTalent(CHARACTER:character, TALENT:talent)

Check if character currently has the talent

CharacterHasSkill(CHARACTER:character, SKILL:skillId)

Check if character currently has the skill

CharacterHasWeaponType(CHARACTER:character, WEAPON:weaponTYPE [, INT:equipped])

Check if character currently has a weapon of this type in his inventory or equipped

CharacterGetStat(OUT FLOAT:statValue, CHARACTER:character, CHARACTERSTAT:statType)

Returns the current value of the stat (Vitality, ...)

CharacterGetSightRange(OUT FLOAT:range, CHARACTER:character)

Returns the character's sight range

CharacterGetWeaponRange(OUT FLOAT:minRange, OUT FLOAT:maxRange, CHARACTER:character)

Returns the character's current weapon range

CharacterGetTouchRange(OUT FLOAT:touchRange, CHARACTER:character)

Returns the character's current touch range

CharacterGetSkillRange(OUT FLOAT:minRange, OUT FLOAT:maxRange,CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterGetSkillImpactRange(OUT FLOAT:areaRange, CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterIsInTrigger(CHARACTER:character, TRIGGER:trigger)

Check if character is in given trigger

CharacterGetAbility(OUT INT:value, CHARACTER:character, ABILITY:ability)

Returns the character's value of the specified ability

CharacterGetHostileCount(OUT INT:value, CHARACTER:character)

Returns how many characters are targeting this character right now... You can iterate over them with IterateEnemiesOf.

CharacterCanFight(CHARACTER:character)

Returns true if the character can fight.

CharacterGetTemplate(CHARACTER:character, OUT CHARACTERTEMPLATE:root)

Returns the roottemplate of the character.

CharacterCanSpotSneakers(CHARACTER:character)

Returns true if the character can spot sneaking characters

CharacterIsFloating(CHARACTER:character)

Check if character is a floating character

CharacterInCreation(CHARACTER:character)

Returns true if the character is in character creation

CharacterAvoidsTraps(CHARACTER:character)

Returns true if the character avoids traps

CharacterCheckRelation(CHARACTER:character, RELATION:relation)

Returns true if relation check succeeds

CharacterIsBetterOrEqualClass(CHARACTER:character, INT:currentScore, OUT INT:newScore, INT warriorScore, INT rogueScore, INT mageScore, INT clericScore, INT rangerScore)

Returns true if score is higher or equal than the current score

CharacterHasBeenHitBy(CHARACTER:character, DAMAGE_TYPE:damageType)

Returns true if the character was hit by this type.

CharacterHasCastedSpellLastTurn(CHARACTER:character)

Returns true if the character has casted a spell in his last turn.

CharacterHasHadStatus(CHARACTER:character, STATUS:status)

Returns true if the character has had a specific status this combat.

CharacterHasAnimationOverride(CHARACTER:character)

Returns true if the character has an animation override.

CharacterCanUnlock(CHARACTER:character, ITEM:item)

Returns true if the character can unlock the item (if the item is already unlocked it returns true!)

CharacterGetReservedUserID(OUT INT:user, CHARACTER:character)

Returns the character's reserved User id.

CharacterGetRace(CHARACTER:character, OUT FIXEDSTRING:race)

Returns the <character>'s race in <race>.

CharacterIsRace(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character>'s race is <race>.

CharacterCanMoveItem(CHARACTER:character, ITEM:item, FLOAT:minRadius, FLOAT:maxRadius [, OUT FLOAT3:destination])

Returns true + <destination> if <character> can move <item> somewhere between <minRadius> and <maxRadius>.

CharacterGetDeathType(CHARACTER:character, OUT FIXEDSTRING:deathType)

Returns death type of <character> in <deathType>.

CharacterGetStillAnimation(CHARACTER:object, OUT FIXEDSTRING:stillAnimation)

Returns the still animation to play

CrimeTransferLeadership(INT: CrimeID[, FIXEDSTRING:Tag1,...])

Try and transfer the leadership of this crime to someone else.

CrimeGetLeadInvestigator(OUT CHARACTER:lead, INT: CrimeID)

Returns the lead investigator for the crime.

CharacterCanHitTargetWithRangedWeapon(CHARACTER:source, OBJECT|FLOAT3:target[, SKILL:skill = null])

Returns true if <source> can hit <target> with currently equipped ranged weapon. Will use <skill> instead of equipped weapon if provided.

CharacterHasRangedWeapon(CHARACTER:character[, INT:checkInventory = 0])

Returns true if <character> has has ranged weapon. Checks for non-wielded weapons if <checkInventory> is 1

CheckInteractionReach(CHARACTER:character, CHARACTER|ITEM: target)

Returns true if <character> could interact with <target>. This is not checking ranges, but checking if there's too much of a height difference or too many obstacles in between.

CharacterGetSourcePoints(CHARACTER:character, OUT INT: amount)

Returns the amount of sourcepoints of <character>.

CharacterAiIsCalculating(-)

Returns if the character is still calculating the AI.

CharacterAiFetchMoveSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3:target)

Returns if the character has a Move Skill command to execute according to the AI.

CharacterAiFetchSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3 endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target, OUT FLOAT3:target2, OUT CHARACTER:target2, OUT ITEM:target)

Returns if the character has a Skill command to execute according to the AI.

CharacterAiFetchConsumeCommand(OUT ITEM:item)

Returns if the character has a Consume command to execute according to the AI.

CharacterAiFetchAttackCommand(OUT FLOAT3:endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target)

Returns if the character has a Attack command to execute according to the AI.

CharacterAiFetchFallbackCommand(OUT FLOAT3:targetPosition, OUT FLOAT3:lookAtPosition)

Returns if the character has a Fallback command to execute according to the AI.

CharacterGetArchetype(CHARACTER:character, OUT ARCHETYPE:archetype)

Returns the archetype of the character.

CharacterIsPolymorphedInto(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character> is polymorphed into <race>. Race can be a race (like HUMAN), but also a template (in case of a polymorph skill like Chicken Touch).

CharacterIsPolymorphInteractionDisabled(CHARACTER:character)

Returns true if <character> has his interaction disabled because of a polymorph.

ItemGet(OUT ITEM:item, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo [, COMPAREFUNC:compareFunc, FIXEDSTRING:rootTemplate, FIXEDSTRING:tag])

Get an item within a certain range conforming to the filled in restraints.

ItemGetFromInventory(OUT ITEM:item, CHARACTER|ITEM:object [, FIXEDSTRING:statsId, FIXEDSTRING:tag, INT:isEquiped])

Returns the first item in the inventory conforming to the filled in restraints.

ItemIsInCharacterInventory(ITEM:item, CHARACTER:object)

Returns if the item is in the inventory of the character

ItemIsInTrigger(ITEM:item, TRIGGER:trigger)

Check if item is in given trigger

ItemGetStat(OUT FLOAT:statValue, ITEM:item, ITEMSTAT:statType)

Returns the current value of the stat (Weight, ...)

ItemIsMoving(ITEM:item)

Returns if the item is moving or not.

ItemIsFalling(ITEM:item)

Returns if the item is falling or not. (after teleport)

ItemIsOpening(ITEM:item)

Returns if the item is opening or not.

ItemIsClosing(ITEM:item)

Returns if the item is closing or not.

ItemIsLocked(ITEM:item)

Returns if the item is locked or not.

ItemIsMovable(ITEM:item)

Returns if the item is movable or not.

ItemCanBeLockPicked(ITEM:item)

Returns if the item is can be opened by lockpicking.

ItemIsOpen(ITEM:item)

Returns if the item is open or not.

IsStoryItem(ITEM:item)

Returns if the item is a story item.

ItemHasStatus(ITEM:item, STATUS:statusId)

Returns if the item has the status.

ItemIsDestroyed(ITEM:item)

Returns if the item is destroyed.

ItemGetTemplate(ITEM:item, OUT ITEMTEMPLATE:root)

Returns the roottemplate of the item.

ItemGetSkillId(ITEM:item, OUT SKILL:root)

Returns the skillid of the item if it has one.

ItemGetItemType(ITEM:item, OUT FIXEDSTRING:itemType)

Returns the itemtype of the item: common, unique, rare, ...

ItemGetStatusSourceCharacter(ITEM:item, STATUS:statusId, OUT CHARACTER:source)

Get the source character of a status

ItemGetStatusSourceItem(ITEM:item, STATUS:statusId, OUT ITEM:source)

Get the source item of a status

ItemCanBeMoved(ITEM:item)

Returns if the item can be moved.

== EVENTS ==

'''OnCharacterEvent(CHARACTER:character, STRING:eventName)''' 
Thrown from scripts or story

'''OnCharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)''' 
Thrown from scripts or story

'''OnCharacterCharacterEvent(CHARACTER:character, CHARACTER:character, STRING:eventName)''' 
Thrown from scripts or story

'''OnItemEvent(ITEM:item, STRING:eventName)''' 
Thrown from scripts or story

'''OnItemDestroyed(ITEM:item)''' 
Thrown when an item is destroyed

'''OnItemDestroying(ITEM:item)''' 
Thrown when an item is being destroyed

'''OnItemOpened(ITEM:item)''' 
Thrown when an item is opened

'''OnItemClosed(ITEM:item)''' 
Thrown when an item is closed

'''OnItemDropped(ITEM:item, STRING:itemTemplate)''' 
Thrown when an item is dropped

'''OnGlobalFlagSet(FIXEDSTRING:eventName)''' 
Thrown when a global event is set

'''OnGlobalFlagCleared(FIXEDSTRING:eventName)''' 
Thrown when a global event is cleared

'''OnCharacterFlagSet(FIXEDSTRING:eventName, CHARACTER:character)''' 
Thrown when a dialog event is set on a character

'''OnCharacterFlagCleared(FIXEDSTRING:eventName, CHARACTER:character)''' 
Thrown when a dialog event is cleared on a character

'''OnItemFlagSet(FIXEDSTRING:eventName, ITEM:item)''' 
Thrown when a dialog event is set on an item

'''OItemFlagCleared(FIXEDSTRING:eventName, ITEM:item)''' 
Thrown when a dialog event is cleared on an item

'''OnTimer(FIXEDSTRING:timerName)''' 
Thrown when a timer has ended

'''OnInit(-)''' 
Thrown when the script is set

'''OnLoaded(INT:major, INT:minor, INT:revision, INT:build)''' 
Thrown when the script is loaded from the savegame

'''OnShutdown(-)''' 
Thrown when the character's script is removed

'''OnVariableCleared(FIXEDSTRING:varName)''' 
Thrown when this object's script variable is cleared from Osiris with ClearVarObject

'''OnCombatStarted(INT:combatID)''' 
Thrown when combat starts

'''OnCombatSwitched(CHARACTER:source, ITEM:source)''' 
Thrown when the character switch from one combat to another

'''OnLeftCombat(CHARACTER:source, ITEM:source)''' 
Thrown when the character or item left the combat

'''OnTurn(CHARACTER:source, ITEM:source)''' 
Thrown when the character's turn starts

'''OnTurnEnded(CHARACTER:source, ITEM:source)''' 
Thrown when the character's turn ended

'''OnCharacterVitalityChanged(CHARACTER:character, FLOAT:percentage)''' 
Thrown when the characters's vitality changed

'''OnItemVitalityChanged(ITEM:item, FLOAT:percentage)''' 
Thrown when the item's vitality changed

'''OnAttackOfOpportunity(CHARACTER:target)''' 
Thrown when the characters gets an attack of opportunity on an enemy

'''OnClearAttackOfOpportunity(-)''' 
Thrown when the characters attack of opportunity is cleared

'''OnDamage(DAMAGE:type, FLOAT:percentage, CHARACTER:source, ITEM:source)''' 
Thrown when the object receives damage

'''OnMiss(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character dodges something

'''OnCriticalHit(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character is critical hit

'''OnPreBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown before the character blocks something (at the start of the attack animation)

'''OnBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character blocks something

'''OnDie(CHARACTER:character, DAMAGE:type, CHARACTER:source, ITEM:source)''' 
Thrown when the character dies

'''OnCharacterStatusAttempt(CHARACTER:character, STATUS:status)''' 
Thrown when the character attempts to gain a status

'''OnCharacterStatusApplied(CHARACTER:character, STATUS:status)''' 
Thrown when the character gains a status

'''OnCharacterStatusRemoved(CHARACTER:character, STATUS:status)''' 
Thrown when the character loses a status

'''OnItemStatusAttempt(ITEM:item, STATUS:status)''' 
Thrown when the item attempts to gain a status

'''OnItemStatus(ITEM:item, STATUS:status)''' 
Thrown when the item gains a status

'''OnItemStatusRemoved(ITEM:item, STATUS:status)''' 
Thrown when the item loses a status

'''OnStatusCreateVisuals(STATUS:status)''' 
Thrown when the item should create the visuals for this status

'''OnStatusDestroyVisuals(STATUS:status)''' 
Thrown when the item should destroy the visuals for this status

'''OnSight(CHARACTER:character)''' 
Thrown when the character sees another character

'''OnLostSight(CHARACTER:character)''' 
Thrown when the character doesn't see another character anymore

'''OnUseItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character uses an item

'''OnPickupItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character picks up an item

'''OnCharacterPreMovedItem(CHARACTER:source, ITEM:item)''' 
Event thrown just before a character moves an item. No difference whether it is in the world or in their inventory

'''OnCharacterMovedItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character moved an item

'''OnItemEquipped(CHARACTER:source, ITEM:item)''' 
Thrown when a character equips an item

'''OnItemUnequipped(CHARACTER:source, ITEM:item)''' 
Thrown when a character unequips an item

'''OnIterateCharacter(CHARACTER:character, FIXEDSTRING:eventId)''' 
Thrown by iterators

'''OnIterateItem(ITEM:source, FIXEDSTRING:eventId)''' 
Thrown by iterators

'''OnIterateCount(FIXEDSTRING:eventId, INTEGER:Count)''' 
Thrown by iterators after all iterations to inform you of the count.

'''OnStoryOverride(-)''' 
Throw when story overrides what the character was doing: teleport, movement, on/offstage

'''OnTriggerEnter(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)''' 
Thrown by a character or item entering an EventTrigger

'''OnTriggerLeave(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)''' 
Thrown by a character or item leaving an EventTrigger

'''OnEnemyChanged(CHARACTER:character, CHARACTER:newEnemy)''' 
Thrown when the character's currentenemy changes

'''OnTalentUnlocked(CHARACTER:character, TALENT:newTalent)''' 
Thrown when the character unlocks a new talent

'''OnCharacterClassChanged(CHARACTER:character, FIXEDSTRING:class)''' 
Thrown when the character changes class in the character creation screen

'''OnCharacterCreationStarted(CHARACTER:character, TRIGGER:creationPoint)''' 
Thrown when the character creation has started, and gives where the character should walk to

'''OnCharacterCreationStopped(CHARACTER:character)''' 
Thrown when the character creation has stopped

'''OnFunction(FIXEDSTRING:functionName)''' 
Throws an event on itself with the functionName. This is to fake function calls

'''OnSkillCast(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when the character casts a skill

'''OnSkillCombatComment(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when the character needs to make a comment

'''OnCharacterUsedSkillOnMe(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when you are hit by a skill from a character

'''OnItemUnlocked(ITEM: item, CHARACTER:character, ITEM:key)''' 
Thrown when an item gets unlocked by a character.

'''OnAutomatedDialogEnded(STRING:dialogName, INT:instanceID)''' 
Thrown when a automated dialog is ended for this speaker

'''OnAutomatedDialogStarted(STRING:dialogName, INT:instanceID)''' 
Thrown when a automated dialog is started for this speaker

'''OnDialogEnded(STRING:dialogName, INT:instanceID)''' 
Thrown when a dialog is ended for this speaker

'''OnCrimeSensibleAction(FIXEDSTRING:regionID, INT:crimeID, FIXEDSTRING:reactionName, STRING:primaryDialog, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, INT:IsPrimary)''' 
Thrown when a character needs to perform a sensible action against criminals

'''OnCrimeInterrogationRequest(FIXEDSTRING:regionID, INT:crimeID, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, STRING:interrogationDialog)''' 
Thrown when a character needs to perform an interrogation against criminals

'''OnCrimeInvestigate(FLOAT3:CrimePosition, INT:crimeID)''' 
One NPC investigates a crimescene

'''OnCrimeAlarmed(FLOAT3:CrimePosition, INT:crimeID)''' 
All NPCs in a crimearea start looking around.

'''OnCrimeReturnToNormal(-)''' 
Investigation or Alarm timed out.

'''OnCrimeAborted(-)''' 
The game interrupted the sensible action of this NPC.

'''OnSplineControlPointReached(INT:Index, INT:EndReached, STRING:EventString)''' 
Thrown when a character reached a spline node.

''''OnFinishCalculationAi(-)''' 
Thrown when the calculation of the AI is finished.

'''OnGrenadeLand(INT:hitObstacle, CHARACTER:caster)''' 
Thrown when the grenades lands

'''FetchCharacterApplyStatusData(CHARACTER:character, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)''' 
Fetch from script which statuses to remove and apply.

'''FetchItemApplyStatusData(ITEM:item, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)''' 
Fetch from script which statuses to remove and apply.

'''FetchItemSkillOnDamage(INT:damage, DAMAGE_TYPE:damageType) RETURN(INT:hasSkill, SKILL_ID:skillID, INT:casterLevel)''' 
Fetch from script what skill to execute on damage.

'''OnActivate(-)''' 
Thrown when a character/item activates

'''OnDeactivate(-)''' 
Thrown when a character/item deactivates

'''OnCharacterUsedSourcePoint(CHARACTER:character)''' 
Thrown when a character uses a source point

'''OnSkillAdded(CHARACTER:character, SKILL_ID:skillId, INT:learned)''' 
Thrown when a character learns a skill

'''OnSkillActivated(CHARACTER:character, SKILL_ID:skillId)''' 
Thrown when a character activates (=adds to memory) a skill

'''OnSkillDeactivated(CHARACTER:character, SKILL_ID:skillId)''' 
Thrown when a character deactivates (=removes from memory) a skill

'''OnItemFlagShared(FIXEDSTRING:eventName, ITEM:item, INT:newValue)''' 
Thrown when a dialog event is shared with an item

'''OnCharacterFlagShared(FIXEDSTRING:eventName, CHARACTER:character, INT:newValue)''' 
Thrown when a dialog event is shared with a character

'''OnItemOffStageChanged(CHARACTER:character, INT:offstage)''' 
Thrown when a character is set on/off stage

'''OnCharacterOffStageChanged(ITEM:item, INT:offstage)''' 
Thrown when a item is set on/off stage

'''OnCharacterTeleported(CHARACTER:target, CHARACTER:cause, FLOAT3:oldPosition, FLOAT3:newPosition, SKILL_ID:skillId)''' 
Thrown when a character gets teleported with a teleport skill

'''OnCombatTick(-)''' 
Thrown when this object ticks in combat. Only thrown for objects that don't get a turn.

== INTERRUPTS ==

'''OnMovementFailed(FLOAT3:targetPos)''' 
Thrown when the reaction is interrupted by a move action failing

'''OnException(-)''' 
Thrown when the reaction is interrupted by an exception

'''OnBetterReactionFound(FIXEDSTRING:reactionName)''' 
Thrown when the reaction is interrupted by another reaction

'''OnNoReactionFound(-)''' 
Thrown when the reaction is interrupted because no reaction is valid

'''OnScriptDisabled(-)''' 
Thrown when the reaction is interrupted because the scriptcontroller is disabled

'''OnManualInterrupt(FIXEDSTRING:reactionName)''' 
Thrown when the reaction is interrupted using the interrupt action

'''OnRegionSwap(FIXEDSTRING:oldLevel, FIXEDSTRING:newLevel)''' 
Thrown when the reaction is interrupted by a region swap

Character and Item Script Triggers, Calls, and Queries

2018-03-02T11:47:21Z

Rimevan: /* EVENTS */

This is a list of almost every character and item script event trigger, call, and query. An event is what triggers the script, and always begin with ''On''. Queries provide information and are always inside an ''IF'' or ''CHECK.'' Calls are actions that are always after THEN.

CharScript/ItemScript Functions

== CALLS ==

'''Set(OUT OBJECT:variable, OBJECT:value)'''

Set the value of a variable

'''SetVar(CHARACTER|ITEM:object, FIXEDSTRING:variableName, OBJECT:value)'''

Set the value of a global variable

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable

'''Print(OUT STRING:output, STRING:text)'''

Prints the text to the output with possible parameters: [1], [2], ...

'''Add(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Adds both values and stores it in the first variable

'''Subtract(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Subtracts both values and stores it in the first variable

'''Multiply(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Multiplies both values and stores it in the first variable

'''Divide(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Divides both values and stores it in the first variable

'''Abs(INOUT INT|FLOAT:variable)'''

Takes the absolute value of a variable

'''Clamp(INOUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Clamps a variable between min and max

'''GetRandom(OUT OBJECT:variable, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with random one of the values.

'''GetWeightedRandom(OUT OBJECT:variable, OBJECT:value, INT|FLOAT:weight, ...)'''

Gets a weighted random of the given values!

'''GetRandomBetween(OUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Gets a random value between min and max (both included)

'''GetRandomPositionInTrigger(OUT FLOAT3:variable, TRIGGER:areaTrigger)'''

Get a random position in a trigger area

'''GetElement(OUT OBJECT:variable, INT:index, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with the index one of the values (starting from 0)

'''SetPriority(FIXEDSTRING:reactionName, INT:priority)'''

Changes the priority of a reaction. Priority 0 and below are not executed!

'''DelayReaction(FIXEDSTRING:reactionName, FLOAT:timeInSeconds)'''

The reaction will not be chosen for the specified time

'''SetScriptFrame(CHARACTER:character, FIXEDSTRING:frame)'''

Sets the scriptframe on the character.

'''ClearScriptFrame(CHARACTER:character)'''

Clears the scriptframe on the character.

'''Goto(FIXEDSTRING:labelName)'''

Jumps to the label. Two label names are built-in: "Start" for the first instruction of the reaction, and "End" for the last one.

'''GotoIfEqual(OBJECT:variable, OBJECT:value, FIXEDSTRING:labelName)'''

Jumps to the label if the 2 objects are equal

'''GotoRand(FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName)'''

Jumps to a random label in the list

'''CreatePuddleAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, INT:cellAmountMin, INT:cellAmountMax, INT:growAmountMin, INT:growAmountMax, )'''

Spawn a puddle at the target's position for a certain lifetime (in turns)

'''CreateSurfaceAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, INT:lifeTime[, GAMEOBJECT:owner])'''

Spawn a surface at the target's position for a certain lifetime (in turns)

'''CreateSurfaceInPolygon(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, GAMEOBJECT|FLOAT3:point1, GAMEOBJECT|FLOAT3:point2, GAMEOBJECT|FLOAT3:point3, ...)'''

Spawn a polygon surface at the target's position. Grows <growStep> every <growTimer>.

'''CreateSurfaceInAreaTrigger(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, TRIGGER:areaTrigger)'''

Spawn a surface within <areaTrigger>. Grows <growStep> every <growTimer>.

'''CreateConeSurfaceAt(GAMEOBJECT|FLOAT3:start, GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, FLOAT:angle, FLOAT:duration)'''

Spawn a Cone surface at the target's position

'''PlayEffectAt(GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''PlayLoopEffectAt(OUT INT64:effectHandle, GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''ExplodeAt(GAMEOBJECT|FLOAT3:target, SKILL:projectileSkill, [INT:casterLevel=-1, CHARACTER|ITEM:cause])'''

Trigger an explosion of a projectile skill at the target's position. The cause will trigger NPC behavior as if the cause casted the projectile

'''DisplayText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''DisplayCombatInfoText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''StatusText(CHARACTER|ITEM:target, FIXEDSTRING:text)'''

Adds statustext above the character/item for a short amount of time. Will not replace texts or dialogtexts

'''DebugText(CHARACTER|ITEM:target, STRING:text)'''

Adds debugtext above the character/item for a short amount of time.

'''CombatLogText(CHARACTER|ITEM:target, FIXEDSTRING:text, INT:filterID, INT:broadcastID)'''

Adds combatlog text inside the combat log window. Color-/SizeFormatting should already be applied, if not color and size of the string will be NORMAL. filterID determines what filter shows/hides the text. broadcastID determines who will be able to see the message (0 hearingrange. 1 party. 2 all)

'''Log(STRING:text, ...)'''

Log's the the scriptlog. (for debugging purposes)

'''Output(STRING:text, ...)'''

Pass text with optional parameters to the output panel (e.g. Output("An int [1]", INT:10))

'''Assert(STRING:text, ...)'''

Pass text with optional parameters to display as an assert message (e.g. Assert("This number is wrong: [1]", INT:666))

'''Label(FIXEDSTRING:name)'''

Marks this line as a label where Goto actions can jump to

'''StartTimer(FIXEDSTRING:timerName, FLOAT:timeInSeconds, INT:repeatCount)'''

Start a timer which will throw the timer event. Set repeatcount < 0 for a permanent timer.

'''StopTimer(FIXEDSTRING:timerName)'''

Stop a timer which will throw the timer event

'''DialogStart(OUT INT:instanceId, STRING:dialog, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target)'''

Start a dialog between the targets. You can specify fewer targets than the maximum number.

{{warning|Starting a dialog from behaviour script will always start it as an [[Dialog_editor#Automated|Automated Dialog]]. Interactive dialogs can only be started from [[Osiris]].}}

'''DialogRequestStop(CHARACTER|ITEM:speaker, STRING:dialog)'''

Stops a certain dialog on a certain speaker

'''Check(-)'''

Reevaluate the conditions in the CHECK section of this reaction

'''Reset(-)'''

Resets the current reaction. It will start from the beginning again

'''Interrupt(FIXEDSTRING:reactionName)'''

Interrupt the reaction.

'''GlobalSetEvent(FIXEDSTRING:eventName)'''

Sets a global event. Scripts and Story can catch it.

'''GlobalClearEvent(FIXEDSTRING:eventName)'''

Clears a global event. Scripts and Story can catch it.

'''StopLoopEffect(INT64:fxHandle)'''

Stops a looping effect

'''IterateItems(FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item. If you pass a tag, it has to have that tag.

'''IterateItemsNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item in range. If you pass a tag, it has to have that tag.

'''IterateItemsOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item standing on the source. If you pass a tag, it has to have that tag.

'''IterateParty(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, CHARACTER:partyMember, FIXEDSTRING:tag])'''

Launch iterate event for each member of all parties. If you pass a party member only members of that party will be considered. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharacters(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in range. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''
Launch iterate event for each character standing on the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersInCombat(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in combat with the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateHostilesFor(CHARACTER:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character who is targetting the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''SpawnCharacter(OUT CHARACTER:result, CHARACTERTEMPLATE:rootTemplate, GAMEOBJECT|FLOAT3:position, INT:playSpawn, [INT:isSummon=0, CHARACTER:summonOwner=null, INT:overrideLevel=-1])'''

Spawns a character

'''SpawnItem(ITEMTEMPLATE:rootTemplate,GAMEOBJECT|FLOAT3:position, OUT ITEM:result)'''

Spawns an item

'''ShootLocalProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootLocalProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootWorldProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootWorldProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootLocalCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) in a direction

'''ShootLocalConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) at the target

'''ShootWorldCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Shoots a cone from worldPos in a direction. Source can be null.

'''ShootWorldConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Shoots a cone from worldPos at the target. Source can be null.

'''SetVisible(CHARACTER|ITEM:object, INT:visible)'''

Sets a character or item visible or not.

'''RotateY(INOUT FLOAT3:vector, FLOAT:degrees)'''

Rotate the vector around the Y-axis for a certain angle (in degrees)

'''SetHealth(CHARACTER|ITEM:target, FLOAT:percent)'''

Set a characters or items health on the given percentage. (percentage between 0 and 1)

'''PlaySound(CHARACTER|ITEM:target, STRING:soundEvent)'''

Plays a sound event at the target

'''PlayMusicForEveryone(STRING:musicEvent)'''

Plays a music event on all the clients

'''PlayMusicOnCharacter(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on a character for all peers (3D)

'''PlayMusicForPeer(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on the peer of the character

'''PlayMusicForPeerWithInstrument(CHARACTER:target, CHARACTER:charInstrument, STRING:musicEvent)'''

Plays a music event on the peer of the character concated with _INSTRUMENT

'''SetX(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the X component of the FLOAT3

'''SetY(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Y component of the FLOAT3

'''SetZ(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Z component of the FLOAT3

'''SetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID, FIXEDSTRING:atmosphere)'''

Changes the atmosphere of the trigger

'''ResetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID)'''

Resets the atmosphere of the trigger

'''AddStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1], [INT:force=1])'''

Adds the status influence strength on the object.

'''RemoveStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Removes the status influence strength on the object.

'''AddTemporaryStatusInfluence(CHARACTER|ITEM:source, CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Adds a temporary status influence strength on the object.. It will be gone in a few seconds if it's not set again

'''CallFunction(FIXEDSTRING:functionName)'''

Calls a function with the ID

'''SetMaterial(CHARACTER|ITEM:object, FIXEDSTRING:materialUUID, INT:duration, INT:applyOnBody, INT:applyOnArmor, INT:applyOnWeapon[)'''

Changes the material of the object for a set time (in turns), -1 is infinite. applyNormalMap: Copy the original materials normal map

'''TeleportTo(CHARACTER|ITEM:object, GAMEOBJECT|FLOAT3:target, [INT:Force=0])'''

Teleport object to or near the target

'''Transform(CHARACTER|ITEM:object, CHARACTERTEMPLATE|ITEMTEMPLATE:root [, FIXEDSTRING:fx, INT:replaceScripts=1, OUT FLOAT:currentHP])'''

Transforms <object> using <root>, returns <currentHP>, plays <fx>.

'''SaveGame(FIXEDSTRING:saveGameName)'''

Save the savegame with name <saveGameName>

'''LoadGame(FIXEDSTRING:saveGameName)'''

Load the savegame with name <saveGameName>

'''LoadLevel(FIXEDSTRING:levelName)'''

Load the level with name <levelName>

'''KillCombat(CHARACTER:character)'''

Kill all the enemies in the combat which contains <character>

'''SetTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Sets the Tag on the Object

'''ClearTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Clears the Tag on the Object

'''SetGlobalFlag(FIXEDSTRING:flagname)'''

Sets the Global Flag

'''ClearGlobalFlag(FIXEDSTRING:flagname)'''

Clears the Global Flag

'''SetFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the Object

'''ClearFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the Object

'''SetUserFlag(CHARACTER:object, FIXEDSTRING:flagname)'''

Sets the Flag on the user's characters

'''ClearUserFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the user's characters

'''SetPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the party's characters

'''ClearPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the party's characters

'''StartVoiceBark(STRING:barkName, CHARACTER:character)'''

Start a voicebark on character

'''ConfrontationDone(INT: CrimeID, CHARACTER:lead, CHARACTER:criminal, ...)'''

Resolve the crime with id CrimeID for the specified criminals

'''CrimesceneInvestigationDone(CHARACTER:investigator)'''

Crimescene is considered investigated by this NPC, start looking for culprits

'''ListAdd(LIST<OBJECT>:list, OBJECT:entry)'''

Add <entry> at the back of <list>

'''ListRemove(LIST<OBJECT>:list, INT:index)'''

Remove the entry at <index> of <list>

'''ListSet(LIST<OBJECT>:list, INT:index, OBJECT:entry)'''

Set the entry at <index> of <list> to <entry>

'''ListClear(LIST<OBJECT>:list)'''

Remove all entries of <list>

'''EndTurn(CHARACTER|ITEM:Target)'''

Ends the object's current turn

'''SetCanFight(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can fight. Optional for the whole group

'''SetCanJoinCombat(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can join combats. Optional for the whole group

'''SetIsBoss(CHARACTER|ITEM:entity, INT:enabled)'''

Enables/Disables the fact if the entity is a boss.

'''GetAIHintTriggers(OUT LIST<TRIGGER>:triggers[, [LIST]FIXEDSTRING:tags, INT:needsAllTags = -1)'''

Returns all AIHintAreaTriggers in <triggers>. Uses contraints if set.

'''SetCombatTimeout(CHARACTER|ITEM:entity, FLOAT:timer)'''

Overwrites the entity's combat timeout check.

'''ResetCombatTimeout(CHARACTER|ITEM:entity)'''

Resets the entity's combat timeout check.

'''EnterCombat(CHARACTER|ITEM:source, CHARACTER|ITEM:target)'''

Enters combat with target

'''LeaveCombat(CHARACTER|ITEM:source)'''

Leaves the combat

'''SetFaction(CHARACTER|ITEM:target, FIXEDSTRING:faction)'''

Changes the faction of a character or item

'''SetInvulnerable(CHARACTER|ITEM:target, INT:bool)'''

Makes the character or item invulnerable or not. (Allow damage)

'''JumpToTurn(CHARACTER|ITEM:Target)'''

Jumps to targets turn (ends the current turn)

'''Sleep(FLOAT:timeInSeconds)'''

Sleeps for a certain amount of time

'''CharacterAttack(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Moves in weapon range and attacks the target

'''CharacterAttackWithoutMove(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Attacks the target without checking weaponranges and without moving

'''CharacterMoveTo(GAMEOBJECT|FLOAT3:target, [INT:running=0, INT:shouldArrive=0, INT:longPath=0, FLOAT:minDistance=1.5, FLOAT:maxDistance=minDistance+2.5])'''

Move to the target. Set shouldArrive to 1 if you want a guaranteed move. (teleports on fail)

'''CharacterAiMove(FLOAT3:target, CHARACTER:targetCharacter, ITEM:targetItem)'''

Moves to the target, calculated by the AI. Should only be used with results from the AI!

'''CharacterMoveInRange(GAMEOBJECT|FLOAT3:target, FLOAT:rangeMin, FLOAT:rangeMax, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within a certain range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInWeaponRange(GAMEOBJECT|FLOAT3:target, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within weapon range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInSkillRange(GAMEOBJECT|FLOAT3:target, SKILL:skill, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within skill range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveOutOfSight(FLOAT:angle)'''

Move out of screen

'''CharacterPlayAnimation(FIXEDSTRING:animation [, INT:exitOnFinish=1, INT:waitForCompletion=1])'''

Plays a certain animation ExitOnFinish means if the exit will kill itself after it was played (revert back to still)

'''CharacterStopAnimation(-)'''

Stops all animations.

'''CharacterPickUpItem(ITEM:item)'''

Moves close enough to the item if necessary and picks it up

'''CharacterUseItem(ITEM:item [, INTEGER:LongPath])'''

Moves close enough to the item if necessary and uses it

'''CharacterMoveItem(ITEM:item, INTEGER:ignoreWeight, INTEGER:ignoreAPCost [, INTEGER:ignoreDangerousSurfaces=1, INT:amount=-1, GAMEOBJECT|FLOAT3:destination])'''

Moves close enough to the item if necessary and moves it to the destination. Will try to find a destination if not supplied.

'''CharacterAddSkill(CHARACTER:character, SKILL:skill[, INT:ShowNotification=0])'''

Adds <skill> to <character>

'''CharacterRemoveSkill(CHARACTER:character, SKILL:skill)'''

Removes <skill> from <character>

'''CharacterUseSkill(SKILL:skill, GAMEOBJECT|FLOAT3:target [, GAMEOBJECT|FLOAT3:target2, ITEM:skillItem, INT:ignoreHasSkill=0])'''

Cast a skill

'''CharacterAppearAt(GAMEOBJECT|FLOAT3:target, INT:playspawn)'''

Appear at the target

'''CharacterAppearOutOfSightTo(GAMEOBJECT:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players from a certain angle while being able to reach target

'''CharacterAppearOnTrailOutOfSightTo(CHARACTER:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players, on its previous locations, from a certain angle while being able to reach target

'''CharacterDisappear(FLOAT:angle[, INTEGER:isRunning=0])'''

Move out of screen and go of stage, will run if <isRunning> is not 0

'''CharacterSetOffStage(-)'''

Set Off Stage

'''CharacterSetOnStage(-)'''

Set On Stage

'''CharacterLookAt(GAMEOBJECT|FLOAT3|SPLINE:target[, INT:snapToTarget=0, INT:angleTolerance=0])'''

Rotates the character to look at the target (Closest spline point in case of a spline).

'''CharacterLookFrom(GAMEOBJECT|SPLINE:target[, INT:snapToTarget=0])'''

Rotates to the character so it has the same rotation as the target (Closest spline point in case of a spline).

'''CharacterFollow(CHARACTER:target, FLOAT:durationInSeconds, INT:run)'''

Follow the target for a certain time

'''CharacterFollowOwnerOrLeader(FLOAT:durationInSeconds, INT:run)'''

Follow the leader or owner for a certain time

'''CharacterWander(FLOAT|TRIGGER:range, FLOAT:durationInSeconds [, INT:run, GAMEOBJECT:anchor])'''

Wander around for a certain time

'''CharacterSwitchWeaponType(WEAPON:type)'''

If necessary switch to the new weapon type

'''CharacterFleeFrom(RELATION:relation, FLOAT:range)'''

Run away from certain characters if necessary
'''
CharacterFleeFromSurface(SURFACE:surface)'''

Run away from a certain surface if necessary

'''CharacterFleeFromDangerousSurface(-)'''

Run away from a dangerous surfaces if necessary

'''CharacterAddSourcePoints(CHARACTER:character, INT:amount)'''

Adds x source points (x can be negative to substract)

'''CharacterDie(CHARACTER:character[, DEATH:type=DoT])'''

Kills the character

'''CharacterHeal(CHARACTER:character, FLOAT:percentage)'''

Heals the character

'''CharacterConsume(CHARACTER:character, POTION:potion)'''

Makes the character consume a potion. Doesn't cost any AP and will just execute the result of the potion.

'''CharacterDisableAllCrimes(CHARACTER:target)'''

Disables all generic behaviours for <target>.

'''CharacterEnableAllCrimes(CHARACTER:target)'''

Enables all generic behaviours for <target>.
'''
CharacterEnableCrime(CHARACTER:target, STRING:crime, ...)'''

Enables the specified generic behaviours for <target>.

'''CharacterDisableCrime(CHARACTER:target, STRING:crime, ...)'''

Disables the specified generic behaviours for <target>.

'''CharacterSetLongInvestigationDuration(CHARACTER:target)'''

Doubles the time it takes for the investigation to time out. Use this when the character needs to move a long path before investigating.

'''CharacterAiCalculate(-)'''

Calculate the AI of the character

'''CharacterAiStopCalculate(-)'''

Stop the calculation of the AI of the character

'''CharacterAiFinishMoveSkill(-)'''

Finish the current MoveSkill.
'''
CharacterAiAddInterestingItem(CHARACTER:character, ITEM:item)'''

Make it interesting for the AI to destroy that Item

'''CharacterAiRemoveInterestingItem(CHARACTER:character, ITEM:item)'''

Make it no longer interesting for the AI to destroy that Item

'''CharacterSetArchetype(CHARACTER:character, ARCHETYPE:archetype)'''

Sets the archetype of the character, used in AI calculations

'''CharacterSetStoryNPC(CHARACTER:character, INT:bool)'''

Makes the character storyNPC or not.
'''
CharacterAddActionPoints(CHARACTER:character, INT:amount)'''

Give character some action points

'''CharacterSetImmortal(CHARACTER:character, INT:bool)'''

Makes the character immortal or not. (Allow dying)

'''CharacterPlayEffect(CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the character and it follows the character

'''CharacterPlayLoopEffect(OUT INT64:effectHandle, CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the character and it follows the character

'''CharacterEvent(CHARACTER:character, STRING:eventName)'''

Throw a character event which you can catch in scripts and story

'''CharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)'''

Throw a character/item event which you can catch in scripts and story

'''CharacterCharacterEvent(CHARACTER:character1, CHARACTER:character2, STRING:eventName)'''

Throw a character/character event which you can catch in scripts and story

'''CharacterSetRelationIndivToIndiv(CHARACTER:source, CHARACTER:target, INT:relation)'''

Changes the relationship between 2 characters.
'''
CharacterForceUpdate(INT:forceUpdate)'''

Makes sure the attached character is always being update or not.
'''
CharacterSetEnemy(CHARACTER:character, CHARACTER:enemy)'''

Sets the current enemy of character

'''CharacterApplyStatus(CHARACTER:character, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the character When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''CharacterRemoveStatus(CHARACTER:character, STATUS:statusId [, STATUS:reasonStatusID=null])'''

Removes the status from the character

'''CharacterDestroy(CHARACTER:character)'''

Destroys the character

'''CharacterSetCanSpotSneakers(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can spot sneaking characters.

'''CharacterSetAttackOfOpportunity(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can do attack of opportunities.

'''CharacterResurrect(CHARACTER:character [, INT:Percentage = 100])'''

Resurrects the character at [2]% health.

'''CharacterAddToInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount, INT:showInTrade=1])'''

Add the item to the character

'''CharacterRemoveFromInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount])'''

Remove the item from the character. If Amount is -1, then all are removed

'''CharacterDrinkPotion(FIXEDSTRING:statID)'''

Makes the character drink a potion from the inventory.

'''CharacterSetAnimationOverride(CHARACTER:character, FIXEDSTRING:animation)'''

Sets an animation override, only walk/run/die animations can override it.

'''CharacterUseActionPoints(CHARACTER:character, INT:amount [, OUT INT:succeeded])'''

Uses x action points

'''CharacterAddTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Adds <treasureTable> to the treasure list of <character>

'''CharacterRemoveTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Removes <treasureTable> from the treasure list of <character>

'''CharacterClearTreasureTables(CHARACTER:character)'''

Removes all treasure tables from <character>

'''CharacterSetTemporaryHostileRelation(CHARACTER:character, CHARACTER:otherCharacter)'''

Creates a temporary hostile relation between the 2 characters!

'''CharacterSetFightMode(CHARACTER:character, INT:fight [, INT:force=0])'''

Set the character in sheath/unsheated mode.

'''CharacterSetStats(CHARACTER:character, FIXEDSTRING:statsEntry [, INT:keepVitality=0, INT:keepAP=0, INT:keepLevel=0, OUT FLOAT:currentHP])'''

Applies <statsEntry> from character.xlsm to <character>, returns <currentHP>.

'''CharacterSetWalkSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:walkSpeed])'''

Sets walk speed override of <character>, removes it if <override> is 0

'''CharacterSetRunSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:runSpeed])'''

Sets run speed override of <character>, removes it if <override> is 0

'''CharacterSetHasDialog(CHARACTER:character, INTEGER:bool)'''

Enables/Disables the dialog of the character

'''CharacterInitPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStartPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStopPatrol(-)'''

Let the character stop patrolling whatever spline he's on!

'''CharacterInterruptPatrol(-)'''

Call when the patrol should interrupt so the guard stops moving to the next spline. If this is called when the character is deactivated, a caret will take his place.

'''CharacterSetAnimationSetOverride(CHARACTER:source, FIXEDSTRING:override)'''

Sets an animation set override for a character. Empty fixedstring clears the override.

'''CharacterSetFloating(CHARACTER:target, INTEGER:isFloating)'''

Sets <target> floating if <isFloating> is not 0

'''CharacterResetCooldowns(CHARACTER:target)'''

Resets the skill cooldowns for <target>

'''ItemEvent(ITEM:item, STRING:eventName)'''

Throw an item event which you can catch in scripts and story

'''ItemPlayAnimation(FIXEDSTRING:animation)'''

Plays an animation on the item

'''ItemPlayAnimationTo(FIXEDSTRING:animation, FLOAT:targetPercentage, [FLOAT:speed])'''

Plays an animation on the item to the target time (percentage of the total duration)

'''ItemPlayEffect(ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the item and it follows the item

'''ItemPlayLoopEffect(OUT INT:effectHandle, ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the item and it follows the item

'''ItemSetOnStage(ITEM:item, INTEGER:bool)'''

Sets an item on or offstage

'''ItemSetCanInteract(ITEM:item, INTEGER:bool)'''

Sets an item (not) interactible

'''ItemClose(ITEM:item)'''

Close an item

'''ItemOpen(ITEM:item)'''

Open an item

'''ItemDrop(ITEM:item)'''

Drop an item

'''ItemLock(ITEM:item, FIXEDSTRING:key)'''

Lock an item

'''ItemUnlock(ITEM:item)'''

Unlock an item

'''ItemApplyStatus(ITEM:item, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the item When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''ItemRemoveStatus(ITEM:item, STATUS:statusId)'''

Removes the status from the item

'''ItemDie(ITEM:item)'''

Kills the item

'''ItemMoveTo(GAMEOBJECT|FLOAT3:target, FLOAT:velocity, FLOAT:acceleration, INTEGER:matchTargetRotation)'''

Moves the item to the target

'''ItemToInventory(ITEM:item, CHARACTER|ITEM:target [,INT:amount=-1])'''

Moves the item to the target's inventory

'''ItemLookAt(GAMEOBJECT:target, FLOAT:degreesPerSecond)'''

Rotates the item to look at the target

'''ItemDestroy(ITEM:item)'''

Destroys the item

'''ItemSetAmount(ITEM:item, INT:amount)'''

Change the amount of the item

'''IterateItemsInInventory(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each iten in source's inventory. If you pass a tag, it has to have that tag.

'''ItemAddCharges(ITEM:TargetItem, INT:charges)'''

Add/subtract charges from an item

'''ItemResetChargesToInitial(ITEM:TargetItem)'''

Resets charges from item to initial state

'''MakePeace(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make peace between users of the characters

'''MakeWar(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make war between users of the characters

'''FindSurface(OUT FLOAT3:result, GAMEOBJECT|FLOAT3:source, FLOAT:minRange, FLOAT:maxRange, SURFACE:type [,CHARACTER:alignSource, INT:minEnemiesInSurface, INT:maxAlliesInSurface, INT:minimumCellCount])'''

Finds the closest surface of a specific type.

'''FindValidPosition(INOUT FLOAT3:position, FLOAT:radius[, CHARACTER|ITEM:object=null])'''

Finds the closest valid position (where the object can stand.)

'''FindPosition(INOUT FLOAT3:position, CHARACTER:source, INT:canStand, INT:checkSight, FLOAT:minRadius, FLOAT:maxRadius, FLOAT:rangeCheck, CHARACTER:alignSource, INT:minAllies, INT:maxAllies, INT:minEnemies, INT:maxEnemies [,FIXEDSTRING:AiHintTag=null, INT:forceHint=0, FLOAT3:SourcePosition])'''

Finds the closest position from the source (within radius) where the conditions are matched.

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable.

'''StringConcatenate(STRING:stringA, STRING:stringB, OUT STRING:resultingString)'''

Appends stringB to stringA. Resulting string is stored in the third parameter.

== QUERIES ==

GetPosition(GAMEOBJECT:object,OUT FLOAT3:src)

Get the current position of an object

GetForwardDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current forward direction of an object

GetRightDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current right direction of an object

GetUpDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current up direction of an object

GetDirection(GAMEOBJECT|FLOAT3:src,GAMEOBJECT|FLOAT3:target,OUT FLOAT3:direction[, OUT FLOAT:distance])

Get the direction from src to target (optional: returns the distance between the objects as well)

GetRotation(GAMEOBJECT:object, OUT FLOAT3:vector)

Get the rotation of an object

CharacterGetTargetSpline(INT: SplineIndex)

Returns the spline index the character is currently walking towards, or -1 if he is not active on a spline.

IsEqual(OBJECT:variable, OBJECT:variable)

Compares both objects and see if they are equal.

IsLessThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is smaller.

IsGreaterThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is bigger.

IsRandom(FLOAT:percentage)

Each time this condition is checked, it will succeed with a chance of the percentage (between 0 and 1)

IsRound(INT:roundNumber)

Checks if we are currently in combat in round x

IsInSurface(OBJECT|FLOAT3:target, SURFACE:type[, FLOAT:radius])

Check if the character, item, trigger or position is currently within the specific surface.

IsInDangerousSurface(OBJECT|FLOAT3:target[, CHARACTER:character, FLOAT:radius])

Check if <target> is currently in on a dangerous surface. Uses <character> for path influences if provided (is necessary with non-character targets)

IsInDialog(CHARACTER|ITEM:target[, INT:ignoreAutomatedDialogs=0])

Check if the character or item is currently in a dialog, optionally ignoring automated dialogs

IsInAutomatedDialog(CHARACTER|ITEM:target)

Check if the character or item is currently in an automated dialog

GetDistance(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)

Returns the distance between 2 positions

GetDistance2D(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)
Returns the 2D distance between 2 positions (ignores height)

GetInnerDistance(OUT FLOAT:distance, GAMEOBJECT:source, GAMEOBJECT:target)

Returns the distance between 2 gameobjects (character, item, trigger, ...) Their bounds are already subtracted.

GetPosition(GAMEOBJECT:object, OUT FLOAT3:position)

Returns the position of a gameobject (character, item, trigger, ...)

GetVar(OUT OBJECT:returnValue, CHARACTER|ITEM:target, FIXEDSTRING:varName)

Gets a global variable from the target

GetClosestPlayer(OUT CHARACTER:player, GAMEOBJECT|FLOAT3:source)

Gets the closest player near the source, default being being the object itself

GetPlayerCount(OUT INT:playerCount)

Gets the number of players in the party

GetPlayerByIndex(OUT CHARACTER:returnCharacter, INT:playerIndex)

Gets a player from the party by index

GetRandomCharacter(OUT CHARACTER:returnCharacter, [INT:canBeSelf=0, INT:canBePlayer=0])

Gets a random character in the current level

ContainsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if there is any surface of the type within a radius of the source

IsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if the whole radius around the source is the specified surface type

IsObjectOnObject(CHARACTER|ITEM:source,CHARACTER|ITEM:target)

Checks if the source is standing on the target

GetX(FLOAT3:vector, OUT FLOAT:value)

Returns the X component of the vector

GetY(FLOAT3:vector, OUT FLOAT:value)

Returns the Y component of the vector

GetZ(FLOAT3:vector, OUT FLOAT:value)

Returns the Z component of the vector

CanSee(GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target[, INT:addProjectileTargetGroundOffset=0])

Check if the sight is blocked between 2 points.

IsVisible(CHARACTER|ITEM:object)

Check if the object is set invisible or not with SetVisible.

GetTextDuration(CHARACTER|ITEM:object, FIXEDSRTING:key, OUT FLOAT:duration)

Gets how long a text needs to be displayed

IsCasual(-)

Returns if the current game mode is Casual

IsHardcore(-)

Returns if the current game mode is Hardcore

IsTagged(GAMEOBJECT:object, FIXEDSTRING:tag)

Check if the object is tagged.

TranslatedStringKeyExists(FIXEDSTRING:key)

Check if the TranslatedString key exists.

IsInCombat(CHARACTER|ITEM:object)

Returns true if the object is in combat.

IsInCombatWith(CHARACTER|ITEM:object, CHARACTER|ITEM:object)

Returns true if the objects are in combat with each other.

IsFacing(GAMEOBJECT:source, GAMEOBJECT|FLOAT3:target, [INT:angle=90])

Returns true if the object is facing the position within the given angle.

GameIsSaving(-)

Returns true if the game is saving.

GameIsLoading(-)

Returns true if the game is loading.

GetUserCount(OUT INT:userCount)

Returns the user count.

GetCurrentCharacter(OUT CHARACTER:character, INT:user)

Returns the character currently being controlled by the specified user.

GetCurrentLevel(OUT FIXEDSTRING:currentLevel)

Returns the current levelname

GetAIBounds(CHARACTER|ITEM:source, OUT FLOAT:bounds)

Returns AI bounds of <source> in <bounds>

HasGlobalFlag(FIXEDSTRING:flagName)

Returns if the Global Flag is set

HasFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the Object

HasUserFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the user's characters

HasPartyFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the party's characters

DialogExists(STRING:dialogue)

Returns true if the dialogue exists.

IsActive(CHARACTER|ITEM:Object)

Returns if the character or item is currently active.

ListGetSize(LIST<OBJECT>:list, out INT:size)

Returns the number of elements in <list>

ListGet(LIST<OBJECT>:list, INT:index, out OBJECT:entry)

Returns <entry> at <index> of <list>

ListGetRandom(LIST<OBJECT>:list, out OBJECT:entry)

Returns a random <entry> of <list>

IsBoss(CHARACTER|ITEM:Object)

Returns true if the entity is tagged as a boss

IsProjectileSkill(SKILL:skill)

Returns true if the skill is a ranged skill (uses a projectile)

IsValidSkillTarget(CHARACTER:source, OBJECT|FLOAT3:target, SKILLID:skill[, INTEGER:ignoreRangeCheck=0])

Checks whether <target> is a valid target for <skill> at <source>

GetFaction(OUT FIXEDSTRING:faction, CHARACTER|ITEM:character)

Returns the faction of the provided character or item

IsInActiveTurn(CHARACTER|ITEM:target)

Returns true if it's the character's or item's turn in combat.

IsSkillActive(CHARACTER:character, SKILL:skillId)

Returns true if <character> has <skillId> active (in memory).

HasSkillAi(SKILLID:skillId)

Returns true if the skill is using the new Ai system

IsInArena(CHARACTER::character)

Returns true if the character is in an arena fight

CrimeGetType(INTEGER:crimeId, OUT STRING:crimeType)

Returns the type of the crime with this id.

CrimeGetCriminals(INTEGER:crimeId, OUT CHARACTER:criminal1, OUT CHARACTER:criminal2, OUT CHARACTER:criminal3, OUT CHARACTER:criminal4)

Returns the criminals of that crime. They might all be null.

IsSourceSkill(SKILL:skill)

Returns true if the skill is a source skill.

IsInGameMasterMode(-)

Returns true if the game in game master mode.

CharacterGet(OUT CHARACTER:character, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo, COMPAREFUNC:compareFunc[, RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf, FIXEDSTRING:tag])

Get a character within a certain range conforming to the filled in restraints.

CharacterCount(OUT INT:count, GAMEOBJECT|FLOAT3:src, FLOAT:range, [RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf])

Counts the characters within a certain range conforming to the filled in restraints.

CharacterGetOwner(OUT CHARACTER:owner, CHARACTER:source)

Get the character's owner

CharacterGetFollow(OUT CHARACTER:to follow, CHARACTER:source)

Get the character to follow

CharacterGetEnemy(OUT CHARACTER:current enemy, CHARACTER:source)

Get current enemy of character

CharacterCanCast(CHARACTER:source, SKILL:skillId, [ITEM:skillItem=null, INT:ignoreActionPoints=0])

Check if the character source can cast the skill: will check cooldown, actionpoints

CharacterCanSitOnItem(CHARACTER:source, ITEM:item)

Check if the character source can sit or lie on an item.

CharacterCanDrinkPotion(CHARACTER:source, FIXEDSTRING:potionID[, INT:ignoreActionPoints=0])

Check if the character source can drink the potion: will check inv and actionpoints

CharacterCanUseItem(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in the world

CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in his inventory

CharacterCanSee(CHARACTER:watchingChar, CHARACTER|ITEM:target [, INT:forceUpdate=0])

Check if character has target in his line of sight.

CharacterCanShoot(CHARACTER:source, GAMEOBJECT|FLOAT3:target)

Check if the character can shoot the target.

CharacterIsPlayer(CHARACTER:character)

Check if the character is a player

CharacterIsInParty(CHARACTER:character)

Check if the character is in the party

CharacterIsEnemy(CHARACTER:source, CHARACTER:target)

Check if target is enemy of source

CharacterIsAlly(CHARACTER:source, CHARACTER:target)

Check if target is ally of source

CharacterIsNeutral(CHARACTER:source, CHARACTER:target)

Check if target is neutral of source

CharacterIsDead(CHARACTER:character)

Check if character is dead

CharacterIsMoving(CHARACTER:character)

Check if character is moving (speed > 0)

CharacterIsSummon(CHARACTER:character)

Check if character is a summon

CharacterIsPartyFollower(CHARACTER:character)

Check if character is a party follower

CharacterIsStoryNPC(CHARACTER:character)

Check if character is a story NPC

CharacterInWeaponRange(CHARACTER:character, CHARACTER:target)

Check if target is in the current's weapon range

CharacterInTouchRange(CHARACTER:character, CHARACTER:targetChar)

Check if target is in the character's touch range

CharacterHasStatus(CHARACTER:character, STATUS:statusId[, FIXEDSTRING:extraData])

Check if character currently has the status. ExtraData can be filled in for some statuses: - Consume: statsid of the item - Shield: skillid of the shield

CharacterGetStatusSourceCharacter(CHARACTER:character, STATUS:statusId, OUT CHARACTER:source[, FIXEDSTRING:extraData])

Get the source character of a status

CharacterGetStatusSourceItem(CHARACTER:character, STATUS:statusId, OUT ITEM:source[, FIXEDSTRING:extraData])

Get the source item of a status

CharacterHasTalent(CHARACTER:character, TALENT:talent)

Check if character currently has the talent

CharacterHasSkill(CHARACTER:character, SKILL:skillId)

Check if character currently has the skill

CharacterHasWeaponType(CHARACTER:character, WEAPON:weaponTYPE [, INT:equipped])

Check if character currently has a weapon of this type in his inventory or equipped

CharacterGetStat(OUT FLOAT:statValue, CHARACTER:character, CHARACTERSTAT:statType)

Returns the current value of the stat (Vitality, ...)

CharacterGetSightRange(OUT FLOAT:range, CHARACTER:character)

Returns the character's sight range

CharacterGetWeaponRange(OUT FLOAT:minRange, OUT FLOAT:maxRange, CHARACTER:character)

Returns the character's current weapon range

CharacterGetTouchRange(OUT FLOAT:touchRange, CHARACTER:character)

Returns the character's current touch range

CharacterGetSkillRange(OUT FLOAT:minRange, OUT FLOAT:maxRange,CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterGetSkillImpactRange(OUT FLOAT:areaRange, CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterIsInTrigger(CHARACTER:character, TRIGGER:trigger)

Check if character is in given trigger

CharacterGetAbility(OUT INT:value, CHARACTER:character, ABILITY:ability)

Returns the character's value of the specified ability

CharacterGetHostileCount(OUT INT:value, CHARACTER:character)

Returns how many characters are targeting this character right now... You can iterate over them with IterateEnemiesOf.

CharacterCanFight(CHARACTER:character)

Returns true if the character can fight.

CharacterGetTemplate(CHARACTER:character, OUT CHARACTERTEMPLATE:root)

Returns the roottemplate of the character.

CharacterCanSpotSneakers(CHARACTER:character)

Returns true if the character can spot sneaking characters

CharacterIsFloating(CHARACTER:character)

Check if character is a floating character

CharacterInCreation(CHARACTER:character)

Returns true if the character is in character creation

CharacterAvoidsTraps(CHARACTER:character)

Returns true if the character avoids traps

CharacterCheckRelation(CHARACTER:character, RELATION:relation)

Returns true if relation check succeeds

CharacterIsBetterOrEqualClass(CHARACTER:character, INT:currentScore, OUT INT:newScore, INT warriorScore, INT rogueScore, INT mageScore, INT clericScore, INT rangerScore)

Returns true if score is higher or equal than the current score

CharacterHasBeenHitBy(CHARACTER:character, DAMAGE_TYPE:damageType)

Returns true if the character was hit by this type.

CharacterHasCastedSpellLastTurn(CHARACTER:character)

Returns true if the character has casted a spell in his last turn.

CharacterHasHadStatus(CHARACTER:character, STATUS:status)

Returns true if the character has had a specific status this combat.

CharacterHasAnimationOverride(CHARACTER:character)

Returns true if the character has an animation override.

CharacterCanUnlock(CHARACTER:character, ITEM:item)

Returns true if the character can unlock the item (if the item is already unlocked it returns true!)

CharacterGetReservedUserID(OUT INT:user, CHARACTER:character)

Returns the character's reserved User id.

CharacterGetRace(CHARACTER:character, OUT FIXEDSTRING:race)

Returns the <character>'s race in <race>.

CharacterIsRace(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character>'s race is <race>.

CharacterCanMoveItem(CHARACTER:character, ITEM:item, FLOAT:minRadius, FLOAT:maxRadius [, OUT FLOAT3:destination])

Returns true + <destination> if <character> can move <item> somewhere between <minRadius> and <maxRadius>.

CharacterGetDeathType(CHARACTER:character, OUT FIXEDSTRING:deathType)

Returns death type of <character> in <deathType>.

CharacterGetStillAnimation(CHARACTER:object, OUT FIXEDSTRING:stillAnimation)

Returns the still animation to play

CrimeTransferLeadership(INT: CrimeID[, FIXEDSTRING:Tag1,...])

Try and transfer the leadership of this crime to someone else.

CrimeGetLeadInvestigator(OUT CHARACTER:lead, INT: CrimeID)

Returns the lead investigator for the crime.

CharacterCanHitTargetWithRangedWeapon(CHARACTER:source, OBJECT|FLOAT3:target[, SKILL:skill = null])

Returns true if <source> can hit <target> with currently equipped ranged weapon. Will use <skill> instead of equipped weapon if provided.

CharacterHasRangedWeapon(CHARACTER:character[, INT:checkInventory = 0])

Returns true if <character> has has ranged weapon. Checks for non-wielded weapons if <checkInventory> is 1

CheckInteractionReach(CHARACTER:character, CHARACTER|ITEM: target)

Returns true if <character> could interact with <target>. This is not checking ranges, but checking if there's too much of a height difference or too many obstacles in between.

CharacterGetSourcePoints(CHARACTER:character, OUT INT: amount)

Returns the amount of sourcepoints of <character>.

CharacterAiIsCalculating(-)

Returns if the character is still calculating the AI.

CharacterAiFetchMoveSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3:target)

Returns if the character has a Move Skill command to execute according to the AI.

CharacterAiFetchSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3 endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target, OUT FLOAT3:target2, OUT CHARACTER:target2, OUT ITEM:target)

Returns if the character has a Skill command to execute according to the AI.

CharacterAiFetchConsumeCommand(OUT ITEM:item)

Returns if the character has a Consume command to execute according to the AI.

CharacterAiFetchAttackCommand(OUT FLOAT3:endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target)

Returns if the character has a Attack command to execute according to the AI.

CharacterAiFetchFallbackCommand(OUT FLOAT3:targetPosition, OUT FLOAT3:lookAtPosition)

Returns if the character has a Fallback command to execute according to the AI.

CharacterGetArchetype(CHARACTER:character, OUT ARCHETYPE:archetype)

Returns the archetype of the character.

CharacterIsPolymorphedInto(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character> is polymorphed into <race>. Race can be a race (like HUMAN), but also a template (in case of a polymorph skill like Chicken Touch).

CharacterIsPolymorphInteractionDisabled(CHARACTER:character)

Returns true if <character> has his interaction disabled because of a polymorph.

ItemGet(OUT ITEM:item, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo [, COMPAREFUNC:compareFunc, FIXEDSTRING:rootTemplate, FIXEDSTRING:tag])

Get an item within a certain range conforming to the filled in restraints.

ItemGetFromInventory(OUT ITEM:item, CHARACTER|ITEM:object [, FIXEDSTRING:statsId, FIXEDSTRING:tag, INT:isEquiped])

Returns the first item in the inventory conforming to the filled in restraints.

ItemIsInCharacterInventory(ITEM:item, CHARACTER:object)

Returns if the item is in the inventory of the character

ItemIsInTrigger(ITEM:item, TRIGGER:trigger)

Check if item is in given trigger

ItemGetStat(OUT FLOAT:statValue, ITEM:item, ITEMSTAT:statType)

Returns the current value of the stat (Weight, ...)

ItemIsMoving(ITEM:item)

Returns if the item is moving or not.

ItemIsFalling(ITEM:item)

Returns if the item is falling or not. (after teleport)

ItemIsOpening(ITEM:item)

Returns if the item is opening or not.

ItemIsClosing(ITEM:item)

Returns if the item is closing or not.

ItemIsLocked(ITEM:item)

Returns if the item is locked or not.

ItemIsMovable(ITEM:item)

Returns if the item is movable or not.

ItemCanBeLockPicked(ITEM:item)

Returns if the item is can be opened by lockpicking.

ItemIsOpen(ITEM:item)

Returns if the item is open or not.

IsStoryItem(ITEM:item)

Returns if the item is a story item.

ItemHasStatus(ITEM:item, STATUS:statusId)

Returns if the item has the status.

ItemIsDestroyed(ITEM:item)

Returns if the item is destroyed.

ItemGetTemplate(ITEM:item, OUT ITEMTEMPLATE:root)

Returns the roottemplate of the item.

ItemGetSkillId(ITEM:item, OUT SKILL:root)

Returns the skillid of the item if it has one.

ItemGetItemType(ITEM:item, OUT FIXEDSTRING:itemType)

Returns the itemtype of the item: common, unique, rare, ...

ItemGetStatusSourceCharacter(ITEM:item, STATUS:statusId, OUT CHARACTER:source)

Get the source character of a status

ItemGetStatusSourceItem(ITEM:item, STATUS:statusId, OUT ITEM:source)

Get the source item of a status

ItemCanBeMoved(ITEM:item)

Returns if the item can be moved.

== EVENTS ==

'''OnCharacterEvent(CHARACTER:character, STRING:eventName)''' 
Thrown from scripts or story

'''OnCharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)''' 
Thrown from scripts or story

'''OnCharacterCharacterEvent(CHARACTER:character, CHARACTER:character, STRING:eventName)''' 
Thrown from scripts or story

'''OnItemEvent(ITEM:item, STRING:eventName)''' 
Thrown from scripts or story

'''OnItemDestroyed(ITEM:item)''' 
Thrown when an item is destroyed

'''OnItemDestroying(ITEM:item)''' 
Thrown when an item is being destroyed

'''OnItemOpened(ITEM:item)''' 
Thrown when an item is opened

'''OnItemClosed(ITEM:item)''' 
Thrown when an item is closed

'''OnItemDropped(ITEM:item, STRING:itemTemplate)''' 
Thrown when an item is dropped

'''OnGlobalFlagSet(FIXEDSTRING:eventName)''' 
Thrown when a global event is set

'''OnGlobalFlagCleared(FIXEDSTRING:eventName)''' 
Thrown when a global event is cleared

'''OnCharacterFlagSet(FIXEDSTRING:eventName, CHARACTER:character)''' 
Thrown when a dialog event is set on a character

'''OnCharacterFlagCleared(FIXEDSTRING:eventName, CHARACTER:character)''' 
Thrown when a dialog event is cleared on a character

'''OnItemFlagSet(FIXEDSTRING:eventName, ITEM:item)''' 
Thrown when a dialog event is set on an item

'''OItemFlagCleared(FIXEDSTRING:eventName, ITEM:item)''' 
Thrown when a dialog event is cleared on an item

'''OnTimer(FIXEDSTRING:timerName)''' 
Thrown when a timer has ended

'''OnInit(-)''' 
Thrown when the script is set

'''OnLoaded(INT:major, INT:minor, INT:revision, INT:build)''' 
Thrown when the script is loaded from the savegame

'''OnShutdown(-)''' 
Thrown when the character's script is removed

'''OnVariableCleared(FIXEDSTRING:varName)''' 
Thrown when this object's script variable is cleared from Osiris with ClearVarObject

'''OnCombatStarted(INT:combatID)''' 
Thrown when combat starts

'''OnCombatSwitched(CHARACTER:source, ITEM:source)''' 
Thrown when the character switch from one combat to another

'''OnLeftCombat(CHARACTER:source, ITEM:source)''' 
Thrown when the character or item left the combat

'''OnTurn(CHARACTER:source, ITEM:source)''' 
Thrown when the character's turn starts

'''OnTurnEnded(CHARACTER:source, ITEM:source)''' 
Thrown when the character's turn ended

'''OnCharacterVitalityChanged(CHARACTER:character, FLOAT:percentage)''' 
Thrown when the characters's vitality changed

'''OnItemVitalityChanged(ITEM:item, FLOAT:percentage)''' 
Thrown when the item's vitality changed

'''OnAttackOfOpportunity(CHARACTER:target)''' 
Thrown when the characters gets an attack of opportunity on an enemy

'''OnClearAttackOfOpportunity(-)''' 
Thrown when the characters attack of opportunity is cleared

'''OnDamage(DAMAGE:type, FLOAT:percentage, CHARACTER:source, ITEM:source)''' 
Thrown when the object receives damage

'''OnMiss(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character dodges something

'''OnCriticalHit(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character is critical hit

'''OnPreBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown before the character blocks something (at the start of the attack animation)

'''OnBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)''' 
Thrown when the character blocks something

'''OnDie(CHARACTER:character, DAMAGE:type, CHARACTER:source, ITEM:source)''' 
Thrown when the character dies

'''OnCharacterStatusAttempt(CHARACTER:character, STATUS:status)''' 
Thrown when the character attempts to gain a status

'''OnCharacterStatusApplied(CHARACTER:character, STATUS:status)''' 
Thrown when the character gains a status

'''OnCharacterStatusRemoved(CHARACTER:character, STATUS:status)''' 
Thrown when the character loses a status

'''OnItemStatusAttempt(ITEM:item, STATUS:status)''' 
Thrown when the item attempts to gain a status

'''OnItemStatus(ITEM:item, STATUS:status)''' 
Thrown when the item gains a status

'''OnItemStatusRemoved(ITEM:item, STATUS:status)''' 
Thrown when the item loses a status

'''OnStatusCreateVisuals(STATUS:status)''' 
Thrown when the item should create the visuals for this status

'''OnStatusDestroyVisuals(STATUS:status)''' 
Thrown when the item should destroy the visuals for this status

'''OnSight(CHARACTER:character)''' 
Thrown when the character sees another character

'''OnLostSight(CHARACTER:character)''' 
Thrown when the character doesn't see another character anymore

'''OnUseItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character uses an item

'''OnPickupItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character picks up an item

'''OnCharacterPreMovedItem(CHARACTER:source, ITEM:item)''' 
Event thrown just before a character moves an item. No difference whether it is in the world or in their inventory

'''OnCharacterMovedItem(CHARACTER:source, ITEM:item)''' 
Thrown when a character moved an item

'''OnItemEquipped(CHARACTER:source, ITEM:item)''' 
Thrown when a character equips an item

'''OnItemUnequipped(CHARACTER:source, ITEM:item)''' 
Thrown when a character unequips an item

'''OnIterateCharacter(CHARACTER:character, FIXEDSTRING:eventId)''' 
Thrown by iterators

'''OnIterateItem(ITEM:source, FIXEDSTRING:eventId)''' 
Thrown by iterators

'''OnIterateCount(FIXEDSTRING:eventId, INTEGER:Count)''' 
Thrown by iterators after all iterations to inform you of the count.

'''OnStoryOverride(-)''' 
Throw when story overrides what the character was doing: teleport, movement, on/offstage

'''OnTriggerEnter(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)''' 
Thrown by a character or item entering an EventTrigger

'''OnTriggerLeave(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)''' 
Thrown by a character or item leaving an EventTrigger

'''OnEnemyChanged(CHARACTER:character, CHARACTER:newEnemy)''' 
Thrown when the character's currentenemy changes

'''OnTalentUnlocked(CHARACTER:character, TALENT:newTalent)''' 
Thrown when the character unlocks a new talent

'''OnCharacterClassChanged(CHARACTER:character, FIXEDSTRING:class)''' 
Thrown when the character changes class in the character creation screen

'''OnCharacterCreationStarted(CHARACTER:character, TRIGGER:creationPoint)''' 
Thrown when the character creation has started, and gives where the character should walk to

'''OnCharacterCreationStopped(CHARACTER:character)''' 
Thrown when the character creation has stopped

'''OnFunction(FIXEDSTRING:functionName)''' 
Throws an event on itself with the functionName. This is to fake function calls

'''OnSkillCast(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when the character casts a skill

'''OnSkillCombatComment(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when the character needs to make a comment

'''OnCharacterUsedSkillOnMe(CHARACTER:character, SKILL_ID:skillID)''' 
Thrown when you are hit by a skill from a character

'''OnItemUnlocked(ITEM: item, CHARACTER:character, ITEM:key)''' 
Thrown when an item gets unlocked by a character.

'''OnAutomatedDialogEnded(STRING:dialogName, INT:instanceID)''' 
Thrown when a automated dialog is ended for this speaker

'''OnAutomatedDialogStarted(STRING:dialogName, INT:instanceID)''' 
Thrown when a automated dialog is started for this speaker

'''OnDialogEnded(STRING:dialogName, INT:instanceID)''' 
Thrown when a dialog is ended for this speaker

'''OnCrimeSensibleAction(FIXEDSTRING:regionID, INT:crimeID, FIXEDSTRING:reactionName, STRING:primaryDialog, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, INT:IsPrimary)''' 
Thrown when a character needs to perform a sensible action against criminals

'''OnCrimeInterrogationRequest(FIXEDSTRING:regionID, INT:crimeID, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, STRING:interrogationDialog)''' 
Thrown when a character needs to perform an interrogation against criminals

'''OnCrimeInvestigate(FLOAT3:CrimePosition, INT:crimeID)''' 
One NPC investigates a crimescene

'''OnCrimeAlarmed(FLOAT3:CrimePosition, INT:crimeID)''' 
All NPCs in a crimearea start looking around.

'''OnCrimeReturnToNormal(-)''' 
Investigation or Alarm timed out.

'''OnCrimeAborted(-)''' 
The game interrupted the sensible action of this NPC.

'''OnSplineControlPointReached(INT:Index, INT:EndReached, STRING:EventString)''' 
Thrown when a character reached a spline node.

''''OnFinishCalculationAi(-)''' 
Thrown when the calculation of the AI is finished.

'''OnGrenadeLand(INT:hitObstacle, CHARACTER:caster)''' 
Thrown when the grenades lands

'''FetchCharacterApplyStatusData(CHARACTER:character, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)''' 
Fetch from script which statuses to remove and apply.

'''FetchItemApplyStatusData(ITEM:item, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)''' 
Fetch from script which statuses to remove and apply.

'''FetchItemSkillOnDamage(INT:damage, DAMAGE_TYPE:damageType) RETURN(INT:hasSkill, SKILL_ID:skillID, INT:casterLevel)''' 
Fetch from script what skill to execute on damage.

'''OnActivate(-)''' 
Thrown when a character/item activates

'''OnDeactivate(-)''' 
Thrown when a character/item deactivates

'''OnCharacterUsedSourcePoint(CHARACTER:character)''' 
Thrown when a character uses a source point

'''OnSkillAdded(CHARACTER:character, SKILL_ID:skillId, INT:learned)''' 
Thrown when a character learns a skill

'''OnSkillActivated(CHARACTER:character, SKILL_ID:skillId)''' 
Thrown when a character activates (=adds to memory) a skill

'''OnSkillDeactivated(CHARACTER:character, SKILL_ID:skillId)''' 
Thrown when a character deactivates (=removes from memory) a skill

'''OnItemFlagShared(FIXEDSTRING:eventName, ITEM:item, INT:newValue)''' 
Thrown when a dialog event is shared with an item

'''OnCharacterFlagShared(FIXEDSTRING:eventName, CHARACTER:character, INT:newValue)''' 
Thrown when a dialog event is shared with a character

'''OnItemOffStageChanged(CHARACTER:character, INT:offstage)''' 
Thrown when a character is set on/off stage

'''OnCharacterOffStageChanged(ITEM:item, INT:offstage)''' 
Thrown when a item is set on/off stage

'''OnCharacterTeleported(CHARACTER:target, CHARACTER:cause, FLOAT3:oldPosition, FLOAT3:newPosition, SKILL_ID:skillId)''' 
Thrown when a character gets teleported with a teleport skill

'''OnCombatTick(-)''' 
Thrown when this object ticks in combat. Only thrown for objects that don't get a turn.

== INTERRUPTS ==

'''OnMovementFailed(FLOAT3:targetPos)'''

Thrown when the reaction is interrupted by a move action failing

'''OnException(-)'''

Thrown when the reaction is interrupted by an exception

'''OnBetterReactionFound(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted by another reaction

'''OnNoReactionFound(-)'''

Thrown when the reaction is interrupted because no reaction is valid

'''OnScriptDisabled(-)'''

Thrown when the reaction is interrupted because the scriptcontroller is disabled

'''OnManualInterrupt(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted using the interrupt action

'''OnRegionSwap(FIXEDSTRING:oldLevel, FIXEDSTRING:newLevel)'''

Thrown when the reaction is interrupted by a region swap

Character and Item Script Triggers, Calls, and Queries

2018-03-02T11:44:20Z

Rimevan: /* EVENTS */

This is a list of almost every character and item script event trigger, call, and query. An event is what triggers the script, and always begin with ''On''. Queries provide information and are always inside an ''IF'' or ''CHECK.'' Calls are actions that are always after THEN.

CharScript/ItemScript Functions

== CALLS ==

'''Set(OUT OBJECT:variable, OBJECT:value)'''

Set the value of a variable

'''SetVar(CHARACTER|ITEM:object, FIXEDSTRING:variableName, OBJECT:value)'''

Set the value of a global variable

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable

'''Print(OUT STRING:output, STRING:text)'''

Prints the text to the output with possible parameters: [1], [2], ...

'''Add(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Adds both values and stores it in the first variable

'''Subtract(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Subtracts both values and stores it in the first variable

'''Multiply(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Multiplies both values and stores it in the first variable

'''Divide(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Divides both values and stores it in the first variable

'''Abs(INOUT INT|FLOAT:variable)'''

Takes the absolute value of a variable

'''Clamp(INOUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Clamps a variable between min and max

'''GetRandom(OUT OBJECT:variable, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with random one of the values.

'''GetWeightedRandom(OUT OBJECT:variable, OBJECT:value, INT|FLOAT:weight, ...)'''

Gets a weighted random of the given values!

'''GetRandomBetween(OUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Gets a random value between min and max (both included)

'''GetRandomPositionInTrigger(OUT FLOAT3:variable, TRIGGER:areaTrigger)'''

Get a random position in a trigger area

'''GetElement(OUT OBJECT:variable, INT:index, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with the index one of the values (starting from 0)

'''SetPriority(FIXEDSTRING:reactionName, INT:priority)'''

Changes the priority of a reaction. Priority 0 and below are not executed!

'''DelayReaction(FIXEDSTRING:reactionName, FLOAT:timeInSeconds)'''

The reaction will not be chosen for the specified time

'''SetScriptFrame(CHARACTER:character, FIXEDSTRING:frame)'''

Sets the scriptframe on the character.

'''ClearScriptFrame(CHARACTER:character)'''

Clears the scriptframe on the character.

'''Goto(FIXEDSTRING:labelName)'''

Jumps to the label. Two label names are built-in: "Start" for the first instruction of the reaction, and "End" for the last one.

'''GotoIfEqual(OBJECT:variable, OBJECT:value, FIXEDSTRING:labelName)'''

Jumps to the label if the 2 objects are equal

'''GotoRand(FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName)'''

Jumps to a random label in the list

'''CreatePuddleAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, INT:cellAmountMin, INT:cellAmountMax, INT:growAmountMin, INT:growAmountMax, )'''

Spawn a puddle at the target's position for a certain lifetime (in turns)

'''CreateSurfaceAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, INT:lifeTime[, GAMEOBJECT:owner])'''

Spawn a surface at the target's position for a certain lifetime (in turns)

'''CreateSurfaceInPolygon(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, GAMEOBJECT|FLOAT3:point1, GAMEOBJECT|FLOAT3:point2, GAMEOBJECT|FLOAT3:point3, ...)'''

Spawn a polygon surface at the target's position. Grows <growStep> every <growTimer>.

'''CreateSurfaceInAreaTrigger(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, TRIGGER:areaTrigger)'''

Spawn a surface within <areaTrigger>. Grows <growStep> every <growTimer>.

'''CreateConeSurfaceAt(GAMEOBJECT|FLOAT3:start, GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, FLOAT:angle, FLOAT:duration)'''

Spawn a Cone surface at the target's position

'''PlayEffectAt(GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''PlayLoopEffectAt(OUT INT64:effectHandle, GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''ExplodeAt(GAMEOBJECT|FLOAT3:target, SKILL:projectileSkill, [INT:casterLevel=-1, CHARACTER|ITEM:cause])'''

Trigger an explosion of a projectile skill at the target's position. The cause will trigger NPC behavior as if the cause casted the projectile

'''DisplayText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''DisplayCombatInfoText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''StatusText(CHARACTER|ITEM:target, FIXEDSTRING:text)'''

Adds statustext above the character/item for a short amount of time. Will not replace texts or dialogtexts

'''DebugText(CHARACTER|ITEM:target, STRING:text)'''

Adds debugtext above the character/item for a short amount of time.

'''CombatLogText(CHARACTER|ITEM:target, FIXEDSTRING:text, INT:filterID, INT:broadcastID)'''

Adds combatlog text inside the combat log window. Color-/SizeFormatting should already be applied, if not color and size of the string will be NORMAL. filterID determines what filter shows/hides the text. broadcastID determines who will be able to see the message (0 hearingrange. 1 party. 2 all)

'''Log(STRING:text, ...)'''

Log's the the scriptlog. (for debugging purposes)

'''Output(STRING:text, ...)'''

Pass text with optional parameters to the output panel (e.g. Output("An int [1]", INT:10))

'''Assert(STRING:text, ...)'''

Pass text with optional parameters to display as an assert message (e.g. Assert("This number is wrong: [1]", INT:666))

'''Label(FIXEDSTRING:name)'''

Marks this line as a label where Goto actions can jump to

'''StartTimer(FIXEDSTRING:timerName, FLOAT:timeInSeconds, INT:repeatCount)'''

Start a timer which will throw the timer event. Set repeatcount < 0 for a permanent timer.

'''StopTimer(FIXEDSTRING:timerName)'''

Stop a timer which will throw the timer event

'''DialogStart(OUT INT:instanceId, STRING:dialog, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target)'''

Start a dialog between the targets. You can specify fewer targets than the maximum number.

{{warning|Starting a dialog from behaviour script will always start it as an [[Dialog_editor#Automated|Automated Dialog]]. Interactive dialogs can only be started from [[Osiris]].}}

'''DialogRequestStop(CHARACTER|ITEM:speaker, STRING:dialog)'''

Stops a certain dialog on a certain speaker

'''Check(-)'''

Reevaluate the conditions in the CHECK section of this reaction

'''Reset(-)'''

Resets the current reaction. It will start from the beginning again

'''Interrupt(FIXEDSTRING:reactionName)'''

Interrupt the reaction.

'''GlobalSetEvent(FIXEDSTRING:eventName)'''

Sets a global event. Scripts and Story can catch it.

'''GlobalClearEvent(FIXEDSTRING:eventName)'''

Clears a global event. Scripts and Story can catch it.

'''StopLoopEffect(INT64:fxHandle)'''

Stops a looping effect

'''IterateItems(FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item. If you pass a tag, it has to have that tag.

'''IterateItemsNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item in range. If you pass a tag, it has to have that tag.

'''IterateItemsOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item standing on the source. If you pass a tag, it has to have that tag.

'''IterateParty(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, CHARACTER:partyMember, FIXEDSTRING:tag])'''

Launch iterate event for each member of all parties. If you pass a party member only members of that party will be considered. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharacters(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in range. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''
Launch iterate event for each character standing on the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersInCombat(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in combat with the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateHostilesFor(CHARACTER:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character who is targetting the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''SpawnCharacter(OUT CHARACTER:result, CHARACTERTEMPLATE:rootTemplate, GAMEOBJECT|FLOAT3:position, INT:playSpawn, [INT:isSummon=0, CHARACTER:summonOwner=null, INT:overrideLevel=-1])'''

Spawns a character

'''SpawnItem(ITEMTEMPLATE:rootTemplate,GAMEOBJECT|FLOAT3:position, OUT ITEM:result)'''

Spawns an item

'''ShootLocalProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootLocalProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootWorldProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootWorldProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootLocalCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) in a direction

'''ShootLocalConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) at the target

'''ShootWorldCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Shoots a cone from worldPos in a direction. Source can be null.

'''ShootWorldConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Shoots a cone from worldPos at the target. Source can be null.

'''SetVisible(CHARACTER|ITEM:object, INT:visible)'''

Sets a character or item visible or not.

'''RotateY(INOUT FLOAT3:vector, FLOAT:degrees)'''

Rotate the vector around the Y-axis for a certain angle (in degrees)

'''SetHealth(CHARACTER|ITEM:target, FLOAT:percent)'''

Set a characters or items health on the given percentage. (percentage between 0 and 1)

'''PlaySound(CHARACTER|ITEM:target, STRING:soundEvent)'''

Plays a sound event at the target

'''PlayMusicForEveryone(STRING:musicEvent)'''

Plays a music event on all the clients

'''PlayMusicOnCharacter(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on a character for all peers (3D)

'''PlayMusicForPeer(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on the peer of the character

'''PlayMusicForPeerWithInstrument(CHARACTER:target, CHARACTER:charInstrument, STRING:musicEvent)'''

Plays a music event on the peer of the character concated with _INSTRUMENT

'''SetX(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the X component of the FLOAT3

'''SetY(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Y component of the FLOAT3

'''SetZ(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Z component of the FLOAT3

'''SetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID, FIXEDSTRING:atmosphere)'''

Changes the atmosphere of the trigger

'''ResetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID)'''

Resets the atmosphere of the trigger

'''AddStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1], [INT:force=1])'''

Adds the status influence strength on the object.

'''RemoveStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Removes the status influence strength on the object.

'''AddTemporaryStatusInfluence(CHARACTER|ITEM:source, CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Adds a temporary status influence strength on the object.. It will be gone in a few seconds if it's not set again

'''CallFunction(FIXEDSTRING:functionName)'''

Calls a function with the ID

'''SetMaterial(CHARACTER|ITEM:object, FIXEDSTRING:materialUUID, INT:duration, INT:applyOnBody, INT:applyOnArmor, INT:applyOnWeapon[)'''

Changes the material of the object for a set time (in turns), -1 is infinite. applyNormalMap: Copy the original materials normal map

'''TeleportTo(CHARACTER|ITEM:object, GAMEOBJECT|FLOAT3:target, [INT:Force=0])'''

Teleport object to or near the target

'''Transform(CHARACTER|ITEM:object, CHARACTERTEMPLATE|ITEMTEMPLATE:root [, FIXEDSTRING:fx, INT:replaceScripts=1, OUT FLOAT:currentHP])'''

Transforms <object> using <root>, returns <currentHP>, plays <fx>.

'''SaveGame(FIXEDSTRING:saveGameName)'''

Save the savegame with name <saveGameName>

'''LoadGame(FIXEDSTRING:saveGameName)'''

Load the savegame with name <saveGameName>

'''LoadLevel(FIXEDSTRING:levelName)'''

Load the level with name <levelName>

'''KillCombat(CHARACTER:character)'''

Kill all the enemies in the combat which contains <character>

'''SetTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Sets the Tag on the Object

'''ClearTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Clears the Tag on the Object

'''SetGlobalFlag(FIXEDSTRING:flagname)'''

Sets the Global Flag

'''ClearGlobalFlag(FIXEDSTRING:flagname)'''

Clears the Global Flag

'''SetFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the Object

'''ClearFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the Object

'''SetUserFlag(CHARACTER:object, FIXEDSTRING:flagname)'''

Sets the Flag on the user's characters

'''ClearUserFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the user's characters

'''SetPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the party's characters

'''ClearPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the party's characters

'''StartVoiceBark(STRING:barkName, CHARACTER:character)'''

Start a voicebark on character

'''ConfrontationDone(INT: CrimeID, CHARACTER:lead, CHARACTER:criminal, ...)'''

Resolve the crime with id CrimeID for the specified criminals

'''CrimesceneInvestigationDone(CHARACTER:investigator)'''

Crimescene is considered investigated by this NPC, start looking for culprits

'''ListAdd(LIST<OBJECT>:list, OBJECT:entry)'''

Add <entry> at the back of <list>

'''ListRemove(LIST<OBJECT>:list, INT:index)'''

Remove the entry at <index> of <list>

'''ListSet(LIST<OBJECT>:list, INT:index, OBJECT:entry)'''

Set the entry at <index> of <list> to <entry>

'''ListClear(LIST<OBJECT>:list)'''

Remove all entries of <list>

'''EndTurn(CHARACTER|ITEM:Target)'''

Ends the object's current turn

'''SetCanFight(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can fight. Optional for the whole group

'''SetCanJoinCombat(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can join combats. Optional for the whole group

'''SetIsBoss(CHARACTER|ITEM:entity, INT:enabled)'''

Enables/Disables the fact if the entity is a boss.

'''GetAIHintTriggers(OUT LIST<TRIGGER>:triggers[, [LIST]FIXEDSTRING:tags, INT:needsAllTags = -1)'''

Returns all AIHintAreaTriggers in <triggers>. Uses contraints if set.

'''SetCombatTimeout(CHARACTER|ITEM:entity, FLOAT:timer)'''

Overwrites the entity's combat timeout check.

'''ResetCombatTimeout(CHARACTER|ITEM:entity)'''

Resets the entity's combat timeout check.

'''EnterCombat(CHARACTER|ITEM:source, CHARACTER|ITEM:target)'''

Enters combat with target

'''LeaveCombat(CHARACTER|ITEM:source)'''

Leaves the combat

'''SetFaction(CHARACTER|ITEM:target, FIXEDSTRING:faction)'''

Changes the faction of a character or item

'''SetInvulnerable(CHARACTER|ITEM:target, INT:bool)'''

Makes the character or item invulnerable or not. (Allow damage)

'''JumpToTurn(CHARACTER|ITEM:Target)'''

Jumps to targets turn (ends the current turn)

'''Sleep(FLOAT:timeInSeconds)'''

Sleeps for a certain amount of time

'''CharacterAttack(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Moves in weapon range and attacks the target

'''CharacterAttackWithoutMove(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Attacks the target without checking weaponranges and without moving

'''CharacterMoveTo(GAMEOBJECT|FLOAT3:target, [INT:running=0, INT:shouldArrive=0, INT:longPath=0, FLOAT:minDistance=1.5, FLOAT:maxDistance=minDistance+2.5])'''

Move to the target. Set shouldArrive to 1 if you want a guaranteed move. (teleports on fail)

'''CharacterAiMove(FLOAT3:target, CHARACTER:targetCharacter, ITEM:targetItem)'''

Moves to the target, calculated by the AI. Should only be used with results from the AI!

'''CharacterMoveInRange(GAMEOBJECT|FLOAT3:target, FLOAT:rangeMin, FLOAT:rangeMax, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within a certain range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInWeaponRange(GAMEOBJECT|FLOAT3:target, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within weapon range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInSkillRange(GAMEOBJECT|FLOAT3:target, SKILL:skill, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within skill range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveOutOfSight(FLOAT:angle)'''

Move out of screen

'''CharacterPlayAnimation(FIXEDSTRING:animation [, INT:exitOnFinish=1, INT:waitForCompletion=1])'''

Plays a certain animation ExitOnFinish means if the exit will kill itself after it was played (revert back to still)

'''CharacterStopAnimation(-)'''

Stops all animations.

'''CharacterPickUpItem(ITEM:item)'''

Moves close enough to the item if necessary and picks it up

'''CharacterUseItem(ITEM:item [, INTEGER:LongPath])'''

Moves close enough to the item if necessary and uses it

'''CharacterMoveItem(ITEM:item, INTEGER:ignoreWeight, INTEGER:ignoreAPCost [, INTEGER:ignoreDangerousSurfaces=1, INT:amount=-1, GAMEOBJECT|FLOAT3:destination])'''

Moves close enough to the item if necessary and moves it to the destination. Will try to find a destination if not supplied.

'''CharacterAddSkill(CHARACTER:character, SKILL:skill[, INT:ShowNotification=0])'''

Adds <skill> to <character>

'''CharacterRemoveSkill(CHARACTER:character, SKILL:skill)'''

Removes <skill> from <character>

'''CharacterUseSkill(SKILL:skill, GAMEOBJECT|FLOAT3:target [, GAMEOBJECT|FLOAT3:target2, ITEM:skillItem, INT:ignoreHasSkill=0])'''

Cast a skill

'''CharacterAppearAt(GAMEOBJECT|FLOAT3:target, INT:playspawn)'''

Appear at the target

'''CharacterAppearOutOfSightTo(GAMEOBJECT:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players from a certain angle while being able to reach target

'''CharacterAppearOnTrailOutOfSightTo(CHARACTER:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players, on its previous locations, from a certain angle while being able to reach target

'''CharacterDisappear(FLOAT:angle[, INTEGER:isRunning=0])'''

Move out of screen and go of stage, will run if <isRunning> is not 0

'''CharacterSetOffStage(-)'''

Set Off Stage

'''CharacterSetOnStage(-)'''

Set On Stage

'''CharacterLookAt(GAMEOBJECT|FLOAT3|SPLINE:target[, INT:snapToTarget=0, INT:angleTolerance=0])'''

Rotates the character to look at the target (Closest spline point in case of a spline).

'''CharacterLookFrom(GAMEOBJECT|SPLINE:target[, INT:snapToTarget=0])'''

Rotates to the character so it has the same rotation as the target (Closest spline point in case of a spline).

'''CharacterFollow(CHARACTER:target, FLOAT:durationInSeconds, INT:run)'''

Follow the target for a certain time

'''CharacterFollowOwnerOrLeader(FLOAT:durationInSeconds, INT:run)'''

Follow the leader or owner for a certain time

'''CharacterWander(FLOAT|TRIGGER:range, FLOAT:durationInSeconds [, INT:run, GAMEOBJECT:anchor])'''

Wander around for a certain time

'''CharacterSwitchWeaponType(WEAPON:type)'''

If necessary switch to the new weapon type

'''CharacterFleeFrom(RELATION:relation, FLOAT:range)'''

Run away from certain characters if necessary
'''
CharacterFleeFromSurface(SURFACE:surface)'''

Run away from a certain surface if necessary

'''CharacterFleeFromDangerousSurface(-)'''

Run away from a dangerous surfaces if necessary

'''CharacterAddSourcePoints(CHARACTER:character, INT:amount)'''

Adds x source points (x can be negative to substract)

'''CharacterDie(CHARACTER:character[, DEATH:type=DoT])'''

Kills the character

'''CharacterHeal(CHARACTER:character, FLOAT:percentage)'''

Heals the character

'''CharacterConsume(CHARACTER:character, POTION:potion)'''

Makes the character consume a potion. Doesn't cost any AP and will just execute the result of the potion.

'''CharacterDisableAllCrimes(CHARACTER:target)'''

Disables all generic behaviours for <target>.

'''CharacterEnableAllCrimes(CHARACTER:target)'''

Enables all generic behaviours for <target>.
'''
CharacterEnableCrime(CHARACTER:target, STRING:crime, ...)'''

Enables the specified generic behaviours for <target>.

'''CharacterDisableCrime(CHARACTER:target, STRING:crime, ...)'''

Disables the specified generic behaviours for <target>.

'''CharacterSetLongInvestigationDuration(CHARACTER:target)'''

Doubles the time it takes for the investigation to time out. Use this when the character needs to move a long path before investigating.

'''CharacterAiCalculate(-)'''

Calculate the AI of the character

'''CharacterAiStopCalculate(-)'''

Stop the calculation of the AI of the character

'''CharacterAiFinishMoveSkill(-)'''

Finish the current MoveSkill.
'''
CharacterAiAddInterestingItem(CHARACTER:character, ITEM:item)'''

Make it interesting for the AI to destroy that Item

'''CharacterAiRemoveInterestingItem(CHARACTER:character, ITEM:item)'''

Make it no longer interesting for the AI to destroy that Item

'''CharacterSetArchetype(CHARACTER:character, ARCHETYPE:archetype)'''

Sets the archetype of the character, used in AI calculations

'''CharacterSetStoryNPC(CHARACTER:character, INT:bool)'''

Makes the character storyNPC or not.
'''
CharacterAddActionPoints(CHARACTER:character, INT:amount)'''

Give character some action points

'''CharacterSetImmortal(CHARACTER:character, INT:bool)'''

Makes the character immortal or not. (Allow dying)

'''CharacterPlayEffect(CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the character and it follows the character

'''CharacterPlayLoopEffect(OUT INT64:effectHandle, CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the character and it follows the character

'''CharacterEvent(CHARACTER:character, STRING:eventName)'''

Throw a character event which you can catch in scripts and story

'''CharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)'''

Throw a character/item event which you can catch in scripts and story

'''CharacterCharacterEvent(CHARACTER:character1, CHARACTER:character2, STRING:eventName)'''

Throw a character/character event which you can catch in scripts and story

'''CharacterSetRelationIndivToIndiv(CHARACTER:source, CHARACTER:target, INT:relation)'''

Changes the relationship between 2 characters.
'''
CharacterForceUpdate(INT:forceUpdate)'''

Makes sure the attached character is always being update or not.
'''
CharacterSetEnemy(CHARACTER:character, CHARACTER:enemy)'''

Sets the current enemy of character

'''CharacterApplyStatus(CHARACTER:character, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the character When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''CharacterRemoveStatus(CHARACTER:character, STATUS:statusId [, STATUS:reasonStatusID=null])'''

Removes the status from the character

'''CharacterDestroy(CHARACTER:character)'''

Destroys the character

'''CharacterSetCanSpotSneakers(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can spot sneaking characters.

'''CharacterSetAttackOfOpportunity(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can do attack of opportunities.

'''CharacterResurrect(CHARACTER:character [, INT:Percentage = 100])'''

Resurrects the character at [2]% health.

'''CharacterAddToInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount, INT:showInTrade=1])'''

Add the item to the character

'''CharacterRemoveFromInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount])'''

Remove the item from the character. If Amount is -1, then all are removed

'''CharacterDrinkPotion(FIXEDSTRING:statID)'''

Makes the character drink a potion from the inventory.

'''CharacterSetAnimationOverride(CHARACTER:character, FIXEDSTRING:animation)'''

Sets an animation override, only walk/run/die animations can override it.

'''CharacterUseActionPoints(CHARACTER:character, INT:amount [, OUT INT:succeeded])'''

Uses x action points

'''CharacterAddTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Adds <treasureTable> to the treasure list of <character>

'''CharacterRemoveTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Removes <treasureTable> from the treasure list of <character>

'''CharacterClearTreasureTables(CHARACTER:character)'''

Removes all treasure tables from <character>

'''CharacterSetTemporaryHostileRelation(CHARACTER:character, CHARACTER:otherCharacter)'''

Creates a temporary hostile relation between the 2 characters!

'''CharacterSetFightMode(CHARACTER:character, INT:fight [, INT:force=0])'''

Set the character in sheath/unsheated mode.

'''CharacterSetStats(CHARACTER:character, FIXEDSTRING:statsEntry [, INT:keepVitality=0, INT:keepAP=0, INT:keepLevel=0, OUT FLOAT:currentHP])'''

Applies <statsEntry> from character.xlsm to <character>, returns <currentHP>.

'''CharacterSetWalkSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:walkSpeed])'''

Sets walk speed override of <character>, removes it if <override> is 0

'''CharacterSetRunSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:runSpeed])'''

Sets run speed override of <character>, removes it if <override> is 0

'''CharacterSetHasDialog(CHARACTER:character, INTEGER:bool)'''

Enables/Disables the dialog of the character

'''CharacterInitPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStartPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStopPatrol(-)'''

Let the character stop patrolling whatever spline he's on!

'''CharacterInterruptPatrol(-)'''

Call when the patrol should interrupt so the guard stops moving to the next spline. If this is called when the character is deactivated, a caret will take his place.

'''CharacterSetAnimationSetOverride(CHARACTER:source, FIXEDSTRING:override)'''

Sets an animation set override for a character. Empty fixedstring clears the override.

'''CharacterSetFloating(CHARACTER:target, INTEGER:isFloating)'''

Sets <target> floating if <isFloating> is not 0

'''CharacterResetCooldowns(CHARACTER:target)'''

Resets the skill cooldowns for <target>

'''ItemEvent(ITEM:item, STRING:eventName)'''

Throw an item event which you can catch in scripts and story

'''ItemPlayAnimation(FIXEDSTRING:animation)'''

Plays an animation on the item

'''ItemPlayAnimationTo(FIXEDSTRING:animation, FLOAT:targetPercentage, [FLOAT:speed])'''

Plays an animation on the item to the target time (percentage of the total duration)

'''ItemPlayEffect(ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the item and it follows the item

'''ItemPlayLoopEffect(OUT INT:effectHandle, ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the item and it follows the item

'''ItemSetOnStage(ITEM:item, INTEGER:bool)'''

Sets an item on or offstage

'''ItemSetCanInteract(ITEM:item, INTEGER:bool)'''

Sets an item (not) interactible

'''ItemClose(ITEM:item)'''

Close an item

'''ItemOpen(ITEM:item)'''

Open an item

'''ItemDrop(ITEM:item)'''

Drop an item

'''ItemLock(ITEM:item, FIXEDSTRING:key)'''

Lock an item

'''ItemUnlock(ITEM:item)'''

Unlock an item

'''ItemApplyStatus(ITEM:item, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the item When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''ItemRemoveStatus(ITEM:item, STATUS:statusId)'''

Removes the status from the item

'''ItemDie(ITEM:item)'''

Kills the item

'''ItemMoveTo(GAMEOBJECT|FLOAT3:target, FLOAT:velocity, FLOAT:acceleration, INTEGER:matchTargetRotation)'''

Moves the item to the target

'''ItemToInventory(ITEM:item, CHARACTER|ITEM:target [,INT:amount=-1])'''

Moves the item to the target's inventory

'''ItemLookAt(GAMEOBJECT:target, FLOAT:degreesPerSecond)'''

Rotates the item to look at the target

'''ItemDestroy(ITEM:item)'''

Destroys the item

'''ItemSetAmount(ITEM:item, INT:amount)'''

Change the amount of the item

'''IterateItemsInInventory(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each iten in source's inventory. If you pass a tag, it has to have that tag.

'''ItemAddCharges(ITEM:TargetItem, INT:charges)'''

Add/subtract charges from an item

'''ItemResetChargesToInitial(ITEM:TargetItem)'''

Resets charges from item to initial state

'''MakePeace(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make peace between users of the characters

'''MakeWar(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make war between users of the characters

'''FindSurface(OUT FLOAT3:result, GAMEOBJECT|FLOAT3:source, FLOAT:minRange, FLOAT:maxRange, SURFACE:type [,CHARACTER:alignSource, INT:minEnemiesInSurface, INT:maxAlliesInSurface, INT:minimumCellCount])'''

Finds the closest surface of a specific type.

'''FindValidPosition(INOUT FLOAT3:position, FLOAT:radius[, CHARACTER|ITEM:object=null])'''

Finds the closest valid position (where the object can stand.)

'''FindPosition(INOUT FLOAT3:position, CHARACTER:source, INT:canStand, INT:checkSight, FLOAT:minRadius, FLOAT:maxRadius, FLOAT:rangeCheck, CHARACTER:alignSource, INT:minAllies, INT:maxAllies, INT:minEnemies, INT:maxEnemies [,FIXEDSTRING:AiHintTag=null, INT:forceHint=0, FLOAT3:SourcePosition])'''

Finds the closest position from the source (within radius) where the conditions are matched.

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable.

'''StringConcatenate(STRING:stringA, STRING:stringB, OUT STRING:resultingString)'''

Appends stringB to stringA. Resulting string is stored in the third parameter.

== QUERIES ==

GetPosition(GAMEOBJECT:object,OUT FLOAT3:src)

Get the current position of an object

GetForwardDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current forward direction of an object

GetRightDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current right direction of an object

GetUpDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current up direction of an object

GetDirection(GAMEOBJECT|FLOAT3:src,GAMEOBJECT|FLOAT3:target,OUT FLOAT3:direction[, OUT FLOAT:distance])

Get the direction from src to target (optional: returns the distance between the objects as well)

GetRotation(GAMEOBJECT:object, OUT FLOAT3:vector)

Get the rotation of an object

CharacterGetTargetSpline(INT: SplineIndex)

Returns the spline index the character is currently walking towards, or -1 if he is not active on a spline.

IsEqual(OBJECT:variable, OBJECT:variable)

Compares both objects and see if they are equal.

IsLessThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is smaller.

IsGreaterThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is bigger.

IsRandom(FLOAT:percentage)

Each time this condition is checked, it will succeed with a chance of the percentage (between 0 and 1)

IsRound(INT:roundNumber)

Checks if we are currently in combat in round x

IsInSurface(OBJECT|FLOAT3:target, SURFACE:type[, FLOAT:radius])

Check if the character, item, trigger or position is currently within the specific surface.

IsInDangerousSurface(OBJECT|FLOAT3:target[, CHARACTER:character, FLOAT:radius])

Check if <target> is currently in on a dangerous surface. Uses <character> for path influences if provided (is necessary with non-character targets)

IsInDialog(CHARACTER|ITEM:target[, INT:ignoreAutomatedDialogs=0])

Check if the character or item is currently in a dialog, optionally ignoring automated dialogs

IsInAutomatedDialog(CHARACTER|ITEM:target)

Check if the character or item is currently in an automated dialog

GetDistance(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)

Returns the distance between 2 positions

GetDistance2D(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)
Returns the 2D distance between 2 positions (ignores height)

GetInnerDistance(OUT FLOAT:distance, GAMEOBJECT:source, GAMEOBJECT:target)

Returns the distance between 2 gameobjects (character, item, trigger, ...) Their bounds are already subtracted.

GetPosition(GAMEOBJECT:object, OUT FLOAT3:position)

Returns the position of a gameobject (character, item, trigger, ...)

GetVar(OUT OBJECT:returnValue, CHARACTER|ITEM:target, FIXEDSTRING:varName)

Gets a global variable from the target

GetClosestPlayer(OUT CHARACTER:player, GAMEOBJECT|FLOAT3:source)

Gets the closest player near the source, default being being the object itself

GetPlayerCount(OUT INT:playerCount)

Gets the number of players in the party

GetPlayerByIndex(OUT CHARACTER:returnCharacter, INT:playerIndex)

Gets a player from the party by index

GetRandomCharacter(OUT CHARACTER:returnCharacter, [INT:canBeSelf=0, INT:canBePlayer=0])

Gets a random character in the current level

ContainsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if there is any surface of the type within a radius of the source

IsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if the whole radius around the source is the specified surface type

IsObjectOnObject(CHARACTER|ITEM:source,CHARACTER|ITEM:target)

Checks if the source is standing on the target

GetX(FLOAT3:vector, OUT FLOAT:value)

Returns the X component of the vector

GetY(FLOAT3:vector, OUT FLOAT:value)

Returns the Y component of the vector

GetZ(FLOAT3:vector, OUT FLOAT:value)

Returns the Z component of the vector

CanSee(GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target[, INT:addProjectileTargetGroundOffset=0])

Check if the sight is blocked between 2 points.

IsVisible(CHARACTER|ITEM:object)

Check if the object is set invisible or not with SetVisible.

GetTextDuration(CHARACTER|ITEM:object, FIXEDSRTING:key, OUT FLOAT:duration)

Gets how long a text needs to be displayed

IsCasual(-)

Returns if the current game mode is Casual

IsHardcore(-)

Returns if the current game mode is Hardcore

IsTagged(GAMEOBJECT:object, FIXEDSTRING:tag)

Check if the object is tagged.

TranslatedStringKeyExists(FIXEDSTRING:key)

Check if the TranslatedString key exists.

IsInCombat(CHARACTER|ITEM:object)

Returns true if the object is in combat.

IsInCombatWith(CHARACTER|ITEM:object, CHARACTER|ITEM:object)

Returns true if the objects are in combat with each other.

IsFacing(GAMEOBJECT:source, GAMEOBJECT|FLOAT3:target, [INT:angle=90])

Returns true if the object is facing the position within the given angle.

GameIsSaving(-)

Returns true if the game is saving.

GameIsLoading(-)

Returns true if the game is loading.

GetUserCount(OUT INT:userCount)

Returns the user count.

GetCurrentCharacter(OUT CHARACTER:character, INT:user)

Returns the character currently being controlled by the specified user.

GetCurrentLevel(OUT FIXEDSTRING:currentLevel)

Returns the current levelname

GetAIBounds(CHARACTER|ITEM:source, OUT FLOAT:bounds)

Returns AI bounds of <source> in <bounds>

HasGlobalFlag(FIXEDSTRING:flagName)

Returns if the Global Flag is set

HasFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the Object

HasUserFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the user's characters

HasPartyFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the party's characters

DialogExists(STRING:dialogue)

Returns true if the dialogue exists.

IsActive(CHARACTER|ITEM:Object)

Returns if the character or item is currently active.

ListGetSize(LIST<OBJECT>:list, out INT:size)

Returns the number of elements in <list>

ListGet(LIST<OBJECT>:list, INT:index, out OBJECT:entry)

Returns <entry> at <index> of <list>

ListGetRandom(LIST<OBJECT>:list, out OBJECT:entry)

Returns a random <entry> of <list>

IsBoss(CHARACTER|ITEM:Object)

Returns true if the entity is tagged as a boss

IsProjectileSkill(SKILL:skill)

Returns true if the skill is a ranged skill (uses a projectile)

IsValidSkillTarget(CHARACTER:source, OBJECT|FLOAT3:target, SKILLID:skill[, INTEGER:ignoreRangeCheck=0])

Checks whether <target> is a valid target for <skill> at <source>

GetFaction(OUT FIXEDSTRING:faction, CHARACTER|ITEM:character)

Returns the faction of the provided character or item

IsInActiveTurn(CHARACTER|ITEM:target)

Returns true if it's the character's or item's turn in combat.

IsSkillActive(CHARACTER:character, SKILL:skillId)

Returns true if <character> has <skillId> active (in memory).

HasSkillAi(SKILLID:skillId)

Returns true if the skill is using the new Ai system

IsInArena(CHARACTER::character)

Returns true if the character is in an arena fight

CrimeGetType(INTEGER:crimeId, OUT STRING:crimeType)

Returns the type of the crime with this id.

CrimeGetCriminals(INTEGER:crimeId, OUT CHARACTER:criminal1, OUT CHARACTER:criminal2, OUT CHARACTER:criminal3, OUT CHARACTER:criminal4)

Returns the criminals of that crime. They might all be null.

IsSourceSkill(SKILL:skill)

Returns true if the skill is a source skill.

IsInGameMasterMode(-)

Returns true if the game in game master mode.

CharacterGet(OUT CHARACTER:character, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo, COMPAREFUNC:compareFunc[, RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf, FIXEDSTRING:tag])

Get a character within a certain range conforming to the filled in restraints.

CharacterCount(OUT INT:count, GAMEOBJECT|FLOAT3:src, FLOAT:range, [RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf])

Counts the characters within a certain range conforming to the filled in restraints.

CharacterGetOwner(OUT CHARACTER:owner, CHARACTER:source)

Get the character's owner

CharacterGetFollow(OUT CHARACTER:to follow, CHARACTER:source)

Get the character to follow

CharacterGetEnemy(OUT CHARACTER:current enemy, CHARACTER:source)

Get current enemy of character

CharacterCanCast(CHARACTER:source, SKILL:skillId, [ITEM:skillItem=null, INT:ignoreActionPoints=0])

Check if the character source can cast the skill: will check cooldown, actionpoints

CharacterCanSitOnItem(CHARACTER:source, ITEM:item)

Check if the character source can sit or lie on an item.

CharacterCanDrinkPotion(CHARACTER:source, FIXEDSTRING:potionID[, INT:ignoreActionPoints=0])

Check if the character source can drink the potion: will check inv and actionpoints

CharacterCanUseItem(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in the world

CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in his inventory

CharacterCanSee(CHARACTER:watchingChar, CHARACTER|ITEM:target [, INT:forceUpdate=0])

Check if character has target in his line of sight.

CharacterCanShoot(CHARACTER:source, GAMEOBJECT|FLOAT3:target)

Check if the character can shoot the target.

CharacterIsPlayer(CHARACTER:character)

Check if the character is a player

CharacterIsInParty(CHARACTER:character)

Check if the character is in the party

CharacterIsEnemy(CHARACTER:source, CHARACTER:target)

Check if target is enemy of source

CharacterIsAlly(CHARACTER:source, CHARACTER:target)

Check if target is ally of source

CharacterIsNeutral(CHARACTER:source, CHARACTER:target)

Check if target is neutral of source

CharacterIsDead(CHARACTER:character)

Check if character is dead

CharacterIsMoving(CHARACTER:character)

Check if character is moving (speed > 0)

CharacterIsSummon(CHARACTER:character)

Check if character is a summon

CharacterIsPartyFollower(CHARACTER:character)

Check if character is a party follower

CharacterIsStoryNPC(CHARACTER:character)

Check if character is a story NPC

CharacterInWeaponRange(CHARACTER:character, CHARACTER:target)

Check if target is in the current's weapon range

CharacterInTouchRange(CHARACTER:character, CHARACTER:targetChar)

Check if target is in the character's touch range

CharacterHasStatus(CHARACTER:character, STATUS:statusId[, FIXEDSTRING:extraData])

Check if character currently has the status. ExtraData can be filled in for some statuses: - Consume: statsid of the item - Shield: skillid of the shield

CharacterGetStatusSourceCharacter(CHARACTER:character, STATUS:statusId, OUT CHARACTER:source[, FIXEDSTRING:extraData])

Get the source character of a status

CharacterGetStatusSourceItem(CHARACTER:character, STATUS:statusId, OUT ITEM:source[, FIXEDSTRING:extraData])

Get the source item of a status

CharacterHasTalent(CHARACTER:character, TALENT:talent)

Check if character currently has the talent

CharacterHasSkill(CHARACTER:character, SKILL:skillId)

Check if character currently has the skill

CharacterHasWeaponType(CHARACTER:character, WEAPON:weaponTYPE [, INT:equipped])

Check if character currently has a weapon of this type in his inventory or equipped

CharacterGetStat(OUT FLOAT:statValue, CHARACTER:character, CHARACTERSTAT:statType)

Returns the current value of the stat (Vitality, ...)

CharacterGetSightRange(OUT FLOAT:range, CHARACTER:character)

Returns the character's sight range

CharacterGetWeaponRange(OUT FLOAT:minRange, OUT FLOAT:maxRange, CHARACTER:character)

Returns the character's current weapon range

CharacterGetTouchRange(OUT FLOAT:touchRange, CHARACTER:character)

Returns the character's current touch range

CharacterGetSkillRange(OUT FLOAT:minRange, OUT FLOAT:maxRange,CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterGetSkillImpactRange(OUT FLOAT:areaRange, CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterIsInTrigger(CHARACTER:character, TRIGGER:trigger)

Check if character is in given trigger

CharacterGetAbility(OUT INT:value, CHARACTER:character, ABILITY:ability)

Returns the character's value of the specified ability

CharacterGetHostileCount(OUT INT:value, CHARACTER:character)

Returns how many characters are targeting this character right now... You can iterate over them with IterateEnemiesOf.

CharacterCanFight(CHARACTER:character)

Returns true if the character can fight.

CharacterGetTemplate(CHARACTER:character, OUT CHARACTERTEMPLATE:root)

Returns the roottemplate of the character.

CharacterCanSpotSneakers(CHARACTER:character)

Returns true if the character can spot sneaking characters

CharacterIsFloating(CHARACTER:character)

Check if character is a floating character

CharacterInCreation(CHARACTER:character)

Returns true if the character is in character creation

CharacterAvoidsTraps(CHARACTER:character)

Returns true if the character avoids traps

CharacterCheckRelation(CHARACTER:character, RELATION:relation)

Returns true if relation check succeeds

CharacterIsBetterOrEqualClass(CHARACTER:character, INT:currentScore, OUT INT:newScore, INT warriorScore, INT rogueScore, INT mageScore, INT clericScore, INT rangerScore)

Returns true if score is higher or equal than the current score

CharacterHasBeenHitBy(CHARACTER:character, DAMAGE_TYPE:damageType)

Returns true if the character was hit by this type.

CharacterHasCastedSpellLastTurn(CHARACTER:character)

Returns true if the character has casted a spell in his last turn.

CharacterHasHadStatus(CHARACTER:character, STATUS:status)

Returns true if the character has had a specific status this combat.

CharacterHasAnimationOverride(CHARACTER:character)

Returns true if the character has an animation override.

CharacterCanUnlock(CHARACTER:character, ITEM:item)

Returns true if the character can unlock the item (if the item is already unlocked it returns true!)

CharacterGetReservedUserID(OUT INT:user, CHARACTER:character)

Returns the character's reserved User id.

CharacterGetRace(CHARACTER:character, OUT FIXEDSTRING:race)

Returns the <character>'s race in <race>.

CharacterIsRace(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character>'s race is <race>.

CharacterCanMoveItem(CHARACTER:character, ITEM:item, FLOAT:minRadius, FLOAT:maxRadius [, OUT FLOAT3:destination])

Returns true + <destination> if <character> can move <item> somewhere between <minRadius> and <maxRadius>.

CharacterGetDeathType(CHARACTER:character, OUT FIXEDSTRING:deathType)

Returns death type of <character> in <deathType>.

CharacterGetStillAnimation(CHARACTER:object, OUT FIXEDSTRING:stillAnimation)

Returns the still animation to play

CrimeTransferLeadership(INT: CrimeID[, FIXEDSTRING:Tag1,...])

Try and transfer the leadership of this crime to someone else.

CrimeGetLeadInvestigator(OUT CHARACTER:lead, INT: CrimeID)

Returns the lead investigator for the crime.

CharacterCanHitTargetWithRangedWeapon(CHARACTER:source, OBJECT|FLOAT3:target[, SKILL:skill = null])

Returns true if <source> can hit <target> with currently equipped ranged weapon. Will use <skill> instead of equipped weapon if provided.

CharacterHasRangedWeapon(CHARACTER:character[, INT:checkInventory = 0])

Returns true if <character> has has ranged weapon. Checks for non-wielded weapons if <checkInventory> is 1

CheckInteractionReach(CHARACTER:character, CHARACTER|ITEM: target)

Returns true if <character> could interact with <target>. This is not checking ranges, but checking if there's too much of a height difference or too many obstacles in between.

CharacterGetSourcePoints(CHARACTER:character, OUT INT: amount)

Returns the amount of sourcepoints of <character>.

CharacterAiIsCalculating(-)

Returns if the character is still calculating the AI.

CharacterAiFetchMoveSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3:target)

Returns if the character has a Move Skill command to execute according to the AI.

CharacterAiFetchSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3 endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target, OUT FLOAT3:target2, OUT CHARACTER:target2, OUT ITEM:target)

Returns if the character has a Skill command to execute according to the AI.

CharacterAiFetchConsumeCommand(OUT ITEM:item)

Returns if the character has a Consume command to execute according to the AI.

CharacterAiFetchAttackCommand(OUT FLOAT3:endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target)

Returns if the character has a Attack command to execute according to the AI.

CharacterAiFetchFallbackCommand(OUT FLOAT3:targetPosition, OUT FLOAT3:lookAtPosition)

Returns if the character has a Fallback command to execute according to the AI.

CharacterGetArchetype(CHARACTER:character, OUT ARCHETYPE:archetype)

Returns the archetype of the character.

CharacterIsPolymorphedInto(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character> is polymorphed into <race>. Race can be a race (like HUMAN), but also a template (in case of a polymorph skill like Chicken Touch).

CharacterIsPolymorphInteractionDisabled(CHARACTER:character)

Returns true if <character> has his interaction disabled because of a polymorph.

ItemGet(OUT ITEM:item, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo [, COMPAREFUNC:compareFunc, FIXEDSTRING:rootTemplate, FIXEDSTRING:tag])

Get an item within a certain range conforming to the filled in restraints.

ItemGetFromInventory(OUT ITEM:item, CHARACTER|ITEM:object [, FIXEDSTRING:statsId, FIXEDSTRING:tag, INT:isEquiped])

Returns the first item in the inventory conforming to the filled in restraints.

ItemIsInCharacterInventory(ITEM:item, CHARACTER:object)

Returns if the item is in the inventory of the character

ItemIsInTrigger(ITEM:item, TRIGGER:trigger)

Check if item is in given trigger

ItemGetStat(OUT FLOAT:statValue, ITEM:item, ITEMSTAT:statType)

Returns the current value of the stat (Weight, ...)

ItemIsMoving(ITEM:item)

Returns if the item is moving or not.

ItemIsFalling(ITEM:item)

Returns if the item is falling or not. (after teleport)

ItemIsOpening(ITEM:item)

Returns if the item is opening or not.

ItemIsClosing(ITEM:item)

Returns if the item is closing or not.

ItemIsLocked(ITEM:item)

Returns if the item is locked or not.

ItemIsMovable(ITEM:item)

Returns if the item is movable or not.

ItemCanBeLockPicked(ITEM:item)

Returns if the item is can be opened by lockpicking.

ItemIsOpen(ITEM:item)

Returns if the item is open or not.

IsStoryItem(ITEM:item)

Returns if the item is a story item.

ItemHasStatus(ITEM:item, STATUS:statusId)

Returns if the item has the status.

ItemIsDestroyed(ITEM:item)

Returns if the item is destroyed.

ItemGetTemplate(ITEM:item, OUT ITEMTEMPLATE:root)

Returns the roottemplate of the item.

ItemGetSkillId(ITEM:item, OUT SKILL:root)

Returns the skillid of the item if it has one.

ItemGetItemType(ITEM:item, OUT FIXEDSTRING:itemType)

Returns the itemtype of the item: common, unique, rare, ...

ItemGetStatusSourceCharacter(ITEM:item, STATUS:statusId, OUT CHARACTER:source)

Get the source character of a status

ItemGetStatusSourceItem(ITEM:item, STATUS:statusId, OUT ITEM:source)

Get the source item of a status

ItemCanBeMoved(ITEM:item)

Returns if the item can be moved.

== EVENTS ==

'''OnCharacterEvent(CHARACTER:character, STRING:eventName)'''

Thrown from scripts or story

'''OnCharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)'''

Thrown from scripts or story

'''OnCharacterCharacterEvent(CHARACTER:character, CHARACTER:character, STRING:eventName)'''

Thrown from scripts or story

'''OnItemEvent(ITEM:item, STRING:eventName)'''

Thrown from scripts or story

'''OnItemDestroyed(ITEM:item)'''

Thrown when an item is destroyed

'''OnItemDestroying(ITEM:item)'''

Thrown when an item is being destroyed

'''OnItemOpened(ITEM:item)'''

Thrown when an item is opened

'''OnItemClosed(ITEM:item)'''

Thrown when an item is closed

'''OnItemDropped(ITEM:item, STRING:itemTemplate)'''

Thrown when an item is dropped

'''OnGlobalFlagSet(FIXEDSTRING:eventName)'''
Thrown when a global event is set

'''OnGlobalFlagCleared(FIXEDSTRING:eventName)'''

Thrown when a global event is cleared

'''OnCharacterFlagSet(FIXEDSTRING:eventName, CHARACTER:character)'''

Thrown when a dialog event is set on a character

'''OnCharacterFlagCleared(FIXEDSTRING:eventName, CHARACTER:character)'''

Thrown when a dialog event is cleared on a character

'''OnItemFlagSet(FIXEDSTRING:eventName, ITEM:item)'''

Thrown when a dialog event is set on an item

'''OItemFlagCleared(FIXEDSTRING:eventName, ITEM:item)'''

Thrown when a dialog event is cleared on an item

'''OnTimer(FIXEDSTRING:timerName)'''

Thrown when a timer has ended

'''OnInit(-)'''

Thrown when the script is set

'''OnLoaded(INT:major, INT:minor, INT:revision, INT:build)'''

Thrown when the script is loaded from the savegame

'''OnShutdown(-)'''

Thrown when the character's script is removed

'''OnVariableCleared(FIXEDSTRING:varName)'''

Thrown when this object's script variable is cleared from Osiris with ClearVarObject

'''OnCombatStarted(INT:combatID)'''

Thrown when combat starts

'''OnCombatSwitched(CHARACTER:source, ITEM:source)'''

Thrown when the character switch from one combat to another

'''OnLeftCombat(CHARACTER:source, ITEM:source)'''

Thrown when the character or item left the combat

'''OnTurn(CHARACTER:source, ITEM:source)'''

Thrown when the character's turn starts

'''OnTurnEnded(CHARACTER:source, ITEM:source)'''

Thrown when the character's turn ended

'''OnCharacterVitalityChanged(CHARACTER:character, FLOAT:percentage)'''

Thrown when the characters's vitality changed

'''OnItemVitalityChanged(ITEM:item, FLOAT:percentage)'''

Thrown when the item's vitality changed

'''OnAttackOfOpportunity(CHARACTER:target)'''

Thrown when the characters gets an attack of opportunity on an enemy

'''OnClearAttackOfOpportunity(-)'''

Thrown when the characters attack of opportunity is cleared

'''OnDamage(DAMAGE:type, FLOAT:percentage, CHARACTER:source, ITEM:source)'''

Thrown when the object receives damage

'''OnMiss(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)'''

Thrown when the character dodges something

'''OnCriticalHit(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)'''

Thrown when the character is critical hit

'''OnPreBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)'''

Thrown before the character blocks something (at the start of the attack animation)

'''OnBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)'''

Thrown when the character blocks something

'''OnDie(CHARACTER:character, DAMAGE:type, CHARACTER:source, ITEM:source)'''

Thrown when the character dies

'''OnCharacterStatusAttempt(CHARACTER:character, STATUS:status)'''

Thrown when the character attempts to gain a status

'''OnCharacterStatusApplied(CHARACTER:character, STATUS:status)'''

Thrown when the character gains a status

'''OnCharacterStatusRemoved(CHARACTER:character, STATUS:status)'''

Thrown when the character loses a status

'''OnItemStatusAttempt(ITEM:item, STATUS:status)'''

Thrown when the item attempts to gain a status

'''OnItemStatus(ITEM:item, STATUS:status)'''

Thrown when the item gains a status

'''OnItemStatusRemoved(ITEM:item, STATUS:status)'''

Thrown when the item loses a status

'''OnStatusCreateVisuals(STATUS:status)'''

Thrown when the item should create the visuals for this status

'''OnStatusDestroyVisuals(STATUS:status)'''

Thrown when the item should destroy the visuals for this status

'''OnSight(CHARACTER:character)'''

Thrown when the character sees another character

'''OnLostSight(CHARACTER:character)'''

Thrown when the character doesn't see another character anymore

'''OnUseItem(CHARACTER:source, ITEM:item)'''

Thrown when a character uses an item

'''OnPickupItem(CHARACTER:source, ITEM:item)'''

Thrown when a character picks up an item

'''OnCharacterPreMovedItem(CHARACTER:source, ITEM:item)'''

Event thrown just before a character moves an item. No difference whether it is in the world or in their inventory

'''OnCharacterMovedItem(CHARACTER:source, ITEM:item)'''

Thrown when a character moved an item

'''OnItemEquipped(CHARACTER:source, ITEM:item)'''

Thrown when a character equips an item

'''OnItemUnequipped(CHARACTER:source, ITEM:item)'''

Thrown when a character unequips an item

'''OnIterateCharacter(CHARACTER:character, FIXEDSTRING:eventId)'''

Thrown by iterators

'''OnIterateItem(ITEM:source, FIXEDSTRING:eventId)'''

Thrown by iterators

'''OnIterateCount(FIXEDSTRING:eventId, INTEGER:Count)'''

Thrown by iterators after all iterations to inform you of the count.

'''OnStoryOverride(-)'''

Throw when story overrides what the character was doing: teleport, movement, on/offstage

'''OnTriggerEnter(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)'''

Thrown by a character or item entering an EventTrigger

'''OnTriggerLeave(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)'''

Thrown by a character or item leaving an EventTrigger

'''OnEnemyChanged(CHARACTER:character, CHARACTER:newEnemy)'''

Thrown when the character's currentenemy changes

'''OnTalentUnlocked(CHARACTER:character, TALENT:newTalent)'''

Thrown when the character unlocks a new talent

'''OnCharacterClassChanged(CHARACTER:character, FIXEDSTRING:class)'''

Thrown when the character changes class in the character creation screen

'''OnCharacterCreationStarted(CHARACTER:character, TRIGGER:creationPoint)'''

Thrown when the character creation has started, and gives where the character should walk to

'''OnCharacterCreationStopped(CHARACTER:character)'''

Thrown when the character creation has stopped

'''OnFunction(FIXEDSTRING:functionName)'''

Throws an event on itself with the functionName. This is to fake function calls

'''OnSkillCast(CHARACTER:character, SKILL_ID:skillID)'''

Thrown when the character casts a skill

'''OnSkillCombatComment(CHARACTER:character, SKILL_ID:skillID)'''

Thrown when the character needs to make a comment

'''OnCharacterUsedSkillOnMe(CHARACTER:character, SKILL_ID:skillID)'''

Thrown when you are hit by a skill from a character

'''OnItemUnlocked(ITEM: item, CHARACTER:character, ITEM:key)'''

Thrown when an item gets unlocked by a character.

'''OnAutomatedDialogEnded(STRING:dialogName, INT:instanceID)'''

Thrown when a automated dialog is ended for this speaker

'''OnAutomatedDialogStarted(STRING:dialogName, INT:instanceID)'''

Thrown when a automated dialog is started for this speaker

'''OnDialogEnded(STRING:dialogName, INT:instanceID)'''

Thrown when a dialog is ended for this speaker

'''OnCrimeSensibleAction(FIXEDSTRING:regionID, INT:crimeID, FIXEDSTRING:reactionName, STRING:primaryDialog, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, INT:IsPrimary)'''

Thrown when a character needs to perform a sensible action against criminals

'''OnCrimeInterrogationRequest(FIXEDSTRING:regionID, INT:crimeID, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, STRING:interrogationDialog)'''

Thrown when a character needs to perform an interrogation against criminals

'''OnCrimeInvestigate(FLOAT3:CrimePosition, INT:crimeID)'''

One NPC investigates a crimescene

'''OnCrimeAlarmed(FLOAT3:CrimePosition, INT:crimeID)'''

All NPCs in a crimearea start looking around.

'''OnCrimeReturnToNormal(-)'''

Investigation or Alarm timed out.

'''OnCrimeAborted(-)'''

The game interrupted the sensible action of this NPC.

'''OnSplineControlPointReached(INT:Index, INT:EndReached, STRING:EventString)'''

Thrown when a character reached a spline node.

''''OnFinishCalculationAi(-)'''

Thrown when the calculation of the AI is finished.

'''OnGrenadeLand(INT:hitObstacle, CHARACTER:caster)'''

Thrown when the grenades lands

'''FetchCharacterApplyStatusData(CHARACTER:character, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)'''

Fetch from script which statuses to remove and apply.

'''FetchItemApplyStatusData(ITEM:item, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)'''

Fetch from script which statuses to remove and apply.

'''FetchItemSkillOnDamage(INT:damage, DAMAGE_TYPE:damageType) RETURN(INT:hasSkill, SKILL_ID:skillID, INT:casterLevel)'''

Fetch from script what skill to execute on damage.

'''OnActivate(-)'''

Thrown when a character/item activates

'''OnDeactivate(-)'''

Thrown when a character/item deactivates

'''OnCharacterUsedSourcePoint(CHARACTER:character)'''

Thrown when a character uses a source point

'''OnSkillAdded(CHARACTER:character, SKILL_ID:skillId, INT:learned)'''

Thrown when a character learns a skill

'''OnSkillActivated(CHARACTER:character, SKILL_ID:skillId)'''

Thrown when a character activates (=adds to memory) a skill

'''OnSkillDeactivated(CHARACTER:character, SKILL_ID:skillId)'''

Thrown when a character deactivates (=removes from memory) a skill

'''OnItemFlagShared(FIXEDSTRING:eventName, ITEM:item, INT:newValue)'''

Thrown when a dialog event is shared with an item

'''OnCharacterFlagShared(FIXEDSTRING:eventName, CHARACTER:character, INT:newValue)'''

Thrown when a dialog event is shared with a character

'''OnItemOffStageChanged(CHARACTER:character, INT:offstage)'''

Thrown when a character is set on/off stage

'''OnCharacterOffStageChanged(ITEM:item, INT:offstage)'''

Thrown when a item is set on/off stage

'''OnCharacterTeleported(CHARACTER:target, CHARACTER:cause, FLOAT3:oldPosition, FLOAT3:newPosition, SKILL_ID:skillId)'''

Thrown when a character gets teleported with a teleport skill

'''OnCombatTick(-)'''

Thrown when this object ticks in combat. Only thrown for objects that don't get a turn.

== INTERRUPTS ==

'''OnMovementFailed(FLOAT3:targetPos)'''

Thrown when the reaction is interrupted by a move action failing

'''OnException(-)'''

Thrown when the reaction is interrupted by an exception

'''OnBetterReactionFound(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted by another reaction

'''OnNoReactionFound(-)'''

Thrown when the reaction is interrupted because no reaction is valid

'''OnScriptDisabled(-)'''

Thrown when the reaction is interrupted because the scriptcontroller is disabled

'''OnManualInterrupt(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted using the interrupt action

'''OnRegionSwap(FIXEDSTRING:oldLevel, FIXEDSTRING:newLevel)'''

Thrown when the reaction is interrupted by a region swap

Character and Item Script Triggers, Calls, and Queries

2018-03-02T11:23:34Z

Rimevan: /* EVENTS */

This is a list of almost every character and item script event trigger, call, and query. An event is what triggers the script, and always begin with ''On''. Queries provide information and are always inside an ''IF'' or ''CHECK.'' Calls are actions that are always after THEN.

CharScript/ItemScript Functions

== CALLS ==

'''Set(OUT OBJECT:variable, OBJECT:value)'''

Set the value of a variable

'''SetVar(CHARACTER|ITEM:object, FIXEDSTRING:variableName, OBJECT:value)'''

Set the value of a global variable

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable

'''Print(OUT STRING:output, STRING:text)'''

Prints the text to the output with possible parameters: [1], [2], ...

'''Add(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Adds both values and stores it in the first variable

'''Subtract(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Subtracts both values and stores it in the first variable

'''Multiply(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Multiplies both values and stores it in the first variable

'''Divide(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Divides both values and stores it in the first variable

'''Abs(INOUT INT|FLOAT:variable)'''

Takes the absolute value of a variable

'''Clamp(INOUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Clamps a variable between min and max

'''GetRandom(OUT OBJECT:variable, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with random one of the values.

'''GetWeightedRandom(OUT OBJECT:variable, OBJECT:value, INT|FLOAT:weight, ...)'''

Gets a weighted random of the given values!

'''GetRandomBetween(OUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Gets a random value between min and max (both included)

'''GetRandomPositionInTrigger(OUT FLOAT3:variable, TRIGGER:areaTrigger)'''

Get a random position in a trigger area

'''GetElement(OUT OBJECT:variable, INT:index, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with the index one of the values (starting from 0)

'''SetPriority(FIXEDSTRING:reactionName, INT:priority)'''

Changes the priority of a reaction. Priority 0 and below are not executed!

'''DelayReaction(FIXEDSTRING:reactionName, FLOAT:timeInSeconds)'''

The reaction will not be chosen for the specified time

'''SetScriptFrame(CHARACTER:character, FIXEDSTRING:frame)'''

Sets the scriptframe on the character.

'''ClearScriptFrame(CHARACTER:character)'''

Clears the scriptframe on the character.

'''Goto(FIXEDSTRING:labelName)'''

Jumps to the label. Two label names are built-in: "Start" for the first instruction of the reaction, and "End" for the last one.

'''GotoIfEqual(OBJECT:variable, OBJECT:value, FIXEDSTRING:labelName)'''

Jumps to the label if the 2 objects are equal

'''GotoRand(FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName)'''

Jumps to a random label in the list

'''CreatePuddleAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, INT:cellAmountMin, INT:cellAmountMax, INT:growAmountMin, INT:growAmountMax, )'''

Spawn a puddle at the target's position for a certain lifetime (in turns)

'''CreateSurfaceAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, INT:lifeTime[, GAMEOBJECT:owner])'''

Spawn a surface at the target's position for a certain lifetime (in turns)

'''CreateSurfaceInPolygon(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, GAMEOBJECT|FLOAT3:point1, GAMEOBJECT|FLOAT3:point2, GAMEOBJECT|FLOAT3:point3, ...)'''

Spawn a polygon surface at the target's position. Grows <growStep> every <growTimer>.

'''CreateSurfaceInAreaTrigger(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, TRIGGER:areaTrigger)'''

Spawn a surface within <areaTrigger>. Grows <growStep> every <growTimer>.

'''CreateConeSurfaceAt(GAMEOBJECT|FLOAT3:start, GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, FLOAT:angle, FLOAT:duration)'''

Spawn a Cone surface at the target's position

'''PlayEffectAt(GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''PlayLoopEffectAt(OUT INT64:effectHandle, GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''ExplodeAt(GAMEOBJECT|FLOAT3:target, SKILL:projectileSkill, [INT:casterLevel=-1, CHARACTER|ITEM:cause])'''

Trigger an explosion of a projectile skill at the target's position. The cause will trigger NPC behavior as if the cause casted the projectile

'''DisplayText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''DisplayCombatInfoText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''StatusText(CHARACTER|ITEM:target, FIXEDSTRING:text)'''

Adds statustext above the character/item for a short amount of time. Will not replace texts or dialogtexts

'''DebugText(CHARACTER|ITEM:target, STRING:text)'''

Adds debugtext above the character/item for a short amount of time.

'''CombatLogText(CHARACTER|ITEM:target, FIXEDSTRING:text, INT:filterID, INT:broadcastID)'''

Adds combatlog text inside the combat log window. Color-/SizeFormatting should already be applied, if not color and size of the string will be NORMAL. filterID determines what filter shows/hides the text. broadcastID determines who will be able to see the message (0 hearingrange. 1 party. 2 all)

'''Log(STRING:text, ...)'''

Log's the the scriptlog. (for debugging purposes)

'''Output(STRING:text, ...)'''

Pass text with optional parameters to the output panel (e.g. Output("An int [1]", INT:10))

'''Assert(STRING:text, ...)'''

Pass text with optional parameters to display as an assert message (e.g. Assert("This number is wrong: [1]", INT:666))

'''Label(FIXEDSTRING:name)'''

Marks this line as a label where Goto actions can jump to

'''StartTimer(FIXEDSTRING:timerName, FLOAT:timeInSeconds, INT:repeatCount)'''

Start a timer which will throw the timer event. Set repeatcount < 0 for a permanent timer.

'''StopTimer(FIXEDSTRING:timerName)'''

Stop a timer which will throw the timer event

'''DialogStart(OUT INT:instanceId, STRING:dialog, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target)'''

Start a dialog between the targets. You can specify fewer targets than the maximum number.

{{warning|Starting a dialog from behaviour script will always start it as an [[Dialog_editor#Automated|Automated Dialog]]. Interactive dialogs can only be started from [[Osiris]].}}

'''DialogRequestStop(CHARACTER|ITEM:speaker, STRING:dialog)'''

Stops a certain dialog on a certain speaker

'''Check(-)'''

Reevaluate the conditions in the CHECK section of this reaction

'''Reset(-)'''

Resets the current reaction. It will start from the beginning again

'''Interrupt(FIXEDSTRING:reactionName)'''

Interrupt the reaction.

'''GlobalSetEvent(FIXEDSTRING:eventName)'''

Sets a global event. Scripts and Story can catch it.

'''GlobalClearEvent(FIXEDSTRING:eventName)'''

Clears a global event. Scripts and Story can catch it.

'''StopLoopEffect(INT64:fxHandle)'''

Stops a looping effect

'''IterateItems(FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item. If you pass a tag, it has to have that tag.

'''IterateItemsNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item in range. If you pass a tag, it has to have that tag.

'''IterateItemsOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item standing on the source. If you pass a tag, it has to have that tag.

'''IterateParty(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, CHARACTER:partyMember, FIXEDSTRING:tag])'''

Launch iterate event for each member of all parties. If you pass a party member only members of that party will be considered. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharacters(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in range. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''
Launch iterate event for each character standing on the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersInCombat(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in combat with the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateHostilesFor(CHARACTER:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character who is targetting the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''SpawnCharacter(OUT CHARACTER:result, CHARACTERTEMPLATE:rootTemplate, GAMEOBJECT|FLOAT3:position, INT:playSpawn, [INT:isSummon=0, CHARACTER:summonOwner=null, INT:overrideLevel=-1])'''

Spawns a character

'''SpawnItem(ITEMTEMPLATE:rootTemplate,GAMEOBJECT|FLOAT3:position, OUT ITEM:result)'''

Spawns an item

'''ShootLocalProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootLocalProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootWorldProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootWorldProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootLocalCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) in a direction

'''ShootLocalConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) at the target

'''ShootWorldCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Shoots a cone from worldPos in a direction. Source can be null.

'''ShootWorldConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Shoots a cone from worldPos at the target. Source can be null.

'''SetVisible(CHARACTER|ITEM:object, INT:visible)'''

Sets a character or item visible or not.

'''RotateY(INOUT FLOAT3:vector, FLOAT:degrees)'''

Rotate the vector around the Y-axis for a certain angle (in degrees)

'''SetHealth(CHARACTER|ITEM:target, FLOAT:percent)'''

Set a characters or items health on the given percentage. (percentage between 0 and 1)

'''PlaySound(CHARACTER|ITEM:target, STRING:soundEvent)'''

Plays a sound event at the target

'''PlayMusicForEveryone(STRING:musicEvent)'''

Plays a music event on all the clients

'''PlayMusicOnCharacter(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on a character for all peers (3D)

'''PlayMusicForPeer(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on the peer of the character

'''PlayMusicForPeerWithInstrument(CHARACTER:target, CHARACTER:charInstrument, STRING:musicEvent)'''

Plays a music event on the peer of the character concated with _INSTRUMENT

'''SetX(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the X component of the FLOAT3

'''SetY(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Y component of the FLOAT3

'''SetZ(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Z component of the FLOAT3

'''SetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID, FIXEDSTRING:atmosphere)'''

Changes the atmosphere of the trigger

'''ResetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID)'''

Resets the atmosphere of the trigger

'''AddStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1], [INT:force=1])'''

Adds the status influence strength on the object.

'''RemoveStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Removes the status influence strength on the object.

'''AddTemporaryStatusInfluence(CHARACTER|ITEM:source, CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Adds a temporary status influence strength on the object.. It will be gone in a few seconds if it's not set again

'''CallFunction(FIXEDSTRING:functionName)'''

Calls a function with the ID

'''SetMaterial(CHARACTER|ITEM:object, FIXEDSTRING:materialUUID, INT:duration, INT:applyOnBody, INT:applyOnArmor, INT:applyOnWeapon[)'''

Changes the material of the object for a set time (in turns), -1 is infinite. applyNormalMap: Copy the original materials normal map

'''TeleportTo(CHARACTER|ITEM:object, GAMEOBJECT|FLOAT3:target, [INT:Force=0])'''

Teleport object to or near the target

'''Transform(CHARACTER|ITEM:object, CHARACTERTEMPLATE|ITEMTEMPLATE:root [, FIXEDSTRING:fx, INT:replaceScripts=1, OUT FLOAT:currentHP])'''

Transforms <object> using <root>, returns <currentHP>, plays <fx>.

'''SaveGame(FIXEDSTRING:saveGameName)'''

Save the savegame with name <saveGameName>

'''LoadGame(FIXEDSTRING:saveGameName)'''

Load the savegame with name <saveGameName>

'''LoadLevel(FIXEDSTRING:levelName)'''

Load the level with name <levelName>

'''KillCombat(CHARACTER:character)'''

Kill all the enemies in the combat which contains <character>

'''SetTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Sets the Tag on the Object

'''ClearTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Clears the Tag on the Object

'''SetGlobalFlag(FIXEDSTRING:flagname)'''

Sets the Global Flag

'''ClearGlobalFlag(FIXEDSTRING:flagname)'''

Clears the Global Flag

'''SetFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the Object

'''ClearFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the Object

'''SetUserFlag(CHARACTER:object, FIXEDSTRING:flagname)'''

Sets the Flag on the user's characters

'''ClearUserFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the user's characters

'''SetPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the party's characters

'''ClearPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the party's characters

'''StartVoiceBark(STRING:barkName, CHARACTER:character)'''

Start a voicebark on character

'''ConfrontationDone(INT: CrimeID, CHARACTER:lead, CHARACTER:criminal, ...)'''

Resolve the crime with id CrimeID for the specified criminals

'''CrimesceneInvestigationDone(CHARACTER:investigator)'''

Crimescene is considered investigated by this NPC, start looking for culprits

'''ListAdd(LIST<OBJECT>:list, OBJECT:entry)'''

Add <entry> at the back of <list>

'''ListRemove(LIST<OBJECT>:list, INT:index)'''

Remove the entry at <index> of <list>

'''ListSet(LIST<OBJECT>:list, INT:index, OBJECT:entry)'''

Set the entry at <index> of <list> to <entry>

'''ListClear(LIST<OBJECT>:list)'''

Remove all entries of <list>

'''EndTurn(CHARACTER|ITEM:Target)'''

Ends the object's current turn

'''SetCanFight(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can fight. Optional for the whole group

'''SetCanJoinCombat(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can join combats. Optional for the whole group

'''SetIsBoss(CHARACTER|ITEM:entity, INT:enabled)'''

Enables/Disables the fact if the entity is a boss.

'''GetAIHintTriggers(OUT LIST<TRIGGER>:triggers[, [LIST]FIXEDSTRING:tags, INT:needsAllTags = -1)'''

Returns all AIHintAreaTriggers in <triggers>. Uses contraints if set.

'''SetCombatTimeout(CHARACTER|ITEM:entity, FLOAT:timer)'''

Overwrites the entity's combat timeout check.

'''ResetCombatTimeout(CHARACTER|ITEM:entity)'''

Resets the entity's combat timeout check.

'''EnterCombat(CHARACTER|ITEM:source, CHARACTER|ITEM:target)'''

Enters combat with target

'''LeaveCombat(CHARACTER|ITEM:source)'''

Leaves the combat

'''SetFaction(CHARACTER|ITEM:target, FIXEDSTRING:faction)'''

Changes the faction of a character or item

'''SetInvulnerable(CHARACTER|ITEM:target, INT:bool)'''

Makes the character or item invulnerable or not. (Allow damage)

'''JumpToTurn(CHARACTER|ITEM:Target)'''

Jumps to targets turn (ends the current turn)

'''Sleep(FLOAT:timeInSeconds)'''

Sleeps for a certain amount of time

'''CharacterAttack(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Moves in weapon range and attacks the target

'''CharacterAttackWithoutMove(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Attacks the target without checking weaponranges and without moving

'''CharacterMoveTo(GAMEOBJECT|FLOAT3:target, [INT:running=0, INT:shouldArrive=0, INT:longPath=0, FLOAT:minDistance=1.5, FLOAT:maxDistance=minDistance+2.5])'''

Move to the target. Set shouldArrive to 1 if you want a guaranteed move. (teleports on fail)

'''CharacterAiMove(FLOAT3:target, CHARACTER:targetCharacter, ITEM:targetItem)'''

Moves to the target, calculated by the AI. Should only be used with results from the AI!

'''CharacterMoveInRange(GAMEOBJECT|FLOAT3:target, FLOAT:rangeMin, FLOAT:rangeMax, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within a certain range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInWeaponRange(GAMEOBJECT|FLOAT3:target, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within weapon range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInSkillRange(GAMEOBJECT|FLOAT3:target, SKILL:skill, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within skill range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveOutOfSight(FLOAT:angle)'''

Move out of screen

'''CharacterPlayAnimation(FIXEDSTRING:animation [, INT:exitOnFinish=1, INT:waitForCompletion=1])'''

Plays a certain animation ExitOnFinish means if the exit will kill itself after it was played (revert back to still)

'''CharacterStopAnimation(-)'''

Stops all animations.

'''CharacterPickUpItem(ITEM:item)'''

Moves close enough to the item if necessary and picks it up

'''CharacterUseItem(ITEM:item [, INTEGER:LongPath])'''

Moves close enough to the item if necessary and uses it

'''CharacterMoveItem(ITEM:item, INTEGER:ignoreWeight, INTEGER:ignoreAPCost [, INTEGER:ignoreDangerousSurfaces=1, INT:amount=-1, GAMEOBJECT|FLOAT3:destination])'''

Moves close enough to the item if necessary and moves it to the destination. Will try to find a destination if not supplied.

'''CharacterAddSkill(CHARACTER:character, SKILL:skill[, INT:ShowNotification=0])'''

Adds <skill> to <character>

'''CharacterRemoveSkill(CHARACTER:character, SKILL:skill)'''

Removes <skill> from <character>

'''CharacterUseSkill(SKILL:skill, GAMEOBJECT|FLOAT3:target [, GAMEOBJECT|FLOAT3:target2, ITEM:skillItem, INT:ignoreHasSkill=0])'''

Cast a skill

'''CharacterAppearAt(GAMEOBJECT|FLOAT3:target, INT:playspawn)'''

Appear at the target

'''CharacterAppearOutOfSightTo(GAMEOBJECT:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players from a certain angle while being able to reach target

'''CharacterAppearOnTrailOutOfSightTo(CHARACTER:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players, on its previous locations, from a certain angle while being able to reach target

'''CharacterDisappear(FLOAT:angle[, INTEGER:isRunning=0])'''

Move out of screen and go of stage, will run if <isRunning> is not 0

'''CharacterSetOffStage(-)'''

Set Off Stage

'''CharacterSetOnStage(-)'''

Set On Stage

'''CharacterLookAt(GAMEOBJECT|FLOAT3|SPLINE:target[, INT:snapToTarget=0, INT:angleTolerance=0])'''

Rotates the character to look at the target (Closest spline point in case of a spline).

'''CharacterLookFrom(GAMEOBJECT|SPLINE:target[, INT:snapToTarget=0])'''

Rotates to the character so it has the same rotation as the target (Closest spline point in case of a spline).

'''CharacterFollow(CHARACTER:target, FLOAT:durationInSeconds, INT:run)'''

Follow the target for a certain time

'''CharacterFollowOwnerOrLeader(FLOAT:durationInSeconds, INT:run)'''

Follow the leader or owner for a certain time

'''CharacterWander(FLOAT|TRIGGER:range, FLOAT:durationInSeconds [, INT:run, GAMEOBJECT:anchor])'''

Wander around for a certain time

'''CharacterSwitchWeaponType(WEAPON:type)'''

If necessary switch to the new weapon type

'''CharacterFleeFrom(RELATION:relation, FLOAT:range)'''

Run away from certain characters if necessary
'''
CharacterFleeFromSurface(SURFACE:surface)'''

Run away from a certain surface if necessary

'''CharacterFleeFromDangerousSurface(-)'''

Run away from a dangerous surfaces if necessary

'''CharacterAddSourcePoints(CHARACTER:character, INT:amount)'''

Adds x source points (x can be negative to substract)

'''CharacterDie(CHARACTER:character[, DEATH:type=DoT])'''

Kills the character

'''CharacterHeal(CHARACTER:character, FLOAT:percentage)'''

Heals the character

'''CharacterConsume(CHARACTER:character, POTION:potion)'''

Makes the character consume a potion. Doesn't cost any AP and will just execute the result of the potion.

'''CharacterDisableAllCrimes(CHARACTER:target)'''

Disables all generic behaviours for <target>.

'''CharacterEnableAllCrimes(CHARACTER:target)'''

Enables all generic behaviours for <target>.
'''
CharacterEnableCrime(CHARACTER:target, STRING:crime, ...)'''

Enables the specified generic behaviours for <target>.

'''CharacterDisableCrime(CHARACTER:target, STRING:crime, ...)'''

Disables the specified generic behaviours for <target>.

'''CharacterSetLongInvestigationDuration(CHARACTER:target)'''

Doubles the time it takes for the investigation to time out. Use this when the character needs to move a long path before investigating.

'''CharacterAiCalculate(-)'''

Calculate the AI of the character

'''CharacterAiStopCalculate(-)'''

Stop the calculation of the AI of the character

'''CharacterAiFinishMoveSkill(-)'''

Finish the current MoveSkill.
'''
CharacterAiAddInterestingItem(CHARACTER:character, ITEM:item)'''

Make it interesting for the AI to destroy that Item

'''CharacterAiRemoveInterestingItem(CHARACTER:character, ITEM:item)'''

Make it no longer interesting for the AI to destroy that Item

'''CharacterSetArchetype(CHARACTER:character, ARCHETYPE:archetype)'''

Sets the archetype of the character, used in AI calculations

'''CharacterSetStoryNPC(CHARACTER:character, INT:bool)'''

Makes the character storyNPC or not.
'''
CharacterAddActionPoints(CHARACTER:character, INT:amount)'''

Give character some action points

'''CharacterSetImmortal(CHARACTER:character, INT:bool)'''

Makes the character immortal or not. (Allow dying)

'''CharacterPlayEffect(CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the character and it follows the character

'''CharacterPlayLoopEffect(OUT INT64:effectHandle, CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the character and it follows the character

'''CharacterEvent(CHARACTER:character, STRING:eventName)'''

Throw a character event which you can catch in scripts and story

'''CharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)'''

Throw a character/item event which you can catch in scripts and story

'''CharacterCharacterEvent(CHARACTER:character1, CHARACTER:character2, STRING:eventName)'''

Throw a character/character event which you can catch in scripts and story

'''CharacterSetRelationIndivToIndiv(CHARACTER:source, CHARACTER:target, INT:relation)'''

Changes the relationship between 2 characters.
'''
CharacterForceUpdate(INT:forceUpdate)'''

Makes sure the attached character is always being update or not.
'''
CharacterSetEnemy(CHARACTER:character, CHARACTER:enemy)'''

Sets the current enemy of character

'''CharacterApplyStatus(CHARACTER:character, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the character When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''CharacterRemoveStatus(CHARACTER:character, STATUS:statusId [, STATUS:reasonStatusID=null])'''

Removes the status from the character

'''CharacterDestroy(CHARACTER:character)'''

Destroys the character

'''CharacterSetCanSpotSneakers(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can spot sneaking characters.

'''CharacterSetAttackOfOpportunity(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can do attack of opportunities.

'''CharacterResurrect(CHARACTER:character [, INT:Percentage = 100])'''

Resurrects the character at [2]% health.

'''CharacterAddToInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount, INT:showInTrade=1])'''

Add the item to the character

'''CharacterRemoveFromInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount])'''

Remove the item from the character. If Amount is -1, then all are removed

'''CharacterDrinkPotion(FIXEDSTRING:statID)'''

Makes the character drink a potion from the inventory.

'''CharacterSetAnimationOverride(CHARACTER:character, FIXEDSTRING:animation)'''

Sets an animation override, only walk/run/die animations can override it.

'''CharacterUseActionPoints(CHARACTER:character, INT:amount [, OUT INT:succeeded])'''

Uses x action points

'''CharacterAddTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Adds <treasureTable> to the treasure list of <character>

'''CharacterRemoveTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Removes <treasureTable> from the treasure list of <character>

'''CharacterClearTreasureTables(CHARACTER:character)'''

Removes all treasure tables from <character>

'''CharacterSetTemporaryHostileRelation(CHARACTER:character, CHARACTER:otherCharacter)'''

Creates a temporary hostile relation between the 2 characters!

'''CharacterSetFightMode(CHARACTER:character, INT:fight [, INT:force=0])'''

Set the character in sheath/unsheated mode.

'''CharacterSetStats(CHARACTER:character, FIXEDSTRING:statsEntry [, INT:keepVitality=0, INT:keepAP=0, INT:keepLevel=0, OUT FLOAT:currentHP])'''

Applies <statsEntry> from character.xlsm to <character>, returns <currentHP>.

'''CharacterSetWalkSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:walkSpeed])'''

Sets walk speed override of <character>, removes it if <override> is 0

'''CharacterSetRunSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:runSpeed])'''

Sets run speed override of <character>, removes it if <override> is 0

'''CharacterSetHasDialog(CHARACTER:character, INTEGER:bool)'''

Enables/Disables the dialog of the character

'''CharacterInitPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStartPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStopPatrol(-)'''

Let the character stop patrolling whatever spline he's on!

'''CharacterInterruptPatrol(-)'''

Call when the patrol should interrupt so the guard stops moving to the next spline. If this is called when the character is deactivated, a caret will take his place.

'''CharacterSetAnimationSetOverride(CHARACTER:source, FIXEDSTRING:override)'''

Sets an animation set override for a character. Empty fixedstring clears the override.

'''CharacterSetFloating(CHARACTER:target, INTEGER:isFloating)'''

Sets <target> floating if <isFloating> is not 0

'''CharacterResetCooldowns(CHARACTER:target)'''

Resets the skill cooldowns for <target>

'''ItemEvent(ITEM:item, STRING:eventName)'''

Throw an item event which you can catch in scripts and story

'''ItemPlayAnimation(FIXEDSTRING:animation)'''

Plays an animation on the item

'''ItemPlayAnimationTo(FIXEDSTRING:animation, FLOAT:targetPercentage, [FLOAT:speed])'''

Plays an animation on the item to the target time (percentage of the total duration)

'''ItemPlayEffect(ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the item and it follows the item

'''ItemPlayLoopEffect(OUT INT:effectHandle, ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the item and it follows the item

'''ItemSetOnStage(ITEM:item, INTEGER:bool)'''

Sets an item on or offstage

'''ItemSetCanInteract(ITEM:item, INTEGER:bool)'''

Sets an item (not) interactible

'''ItemClose(ITEM:item)'''

Close an item

'''ItemOpen(ITEM:item)'''

Open an item

'''ItemDrop(ITEM:item)'''

Drop an item

'''ItemLock(ITEM:item, FIXEDSTRING:key)'''

Lock an item

'''ItemUnlock(ITEM:item)'''

Unlock an item

'''ItemApplyStatus(ITEM:item, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the item When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''ItemRemoveStatus(ITEM:item, STATUS:statusId)'''

Removes the status from the item

'''ItemDie(ITEM:item)'''

Kills the item

'''ItemMoveTo(GAMEOBJECT|FLOAT3:target, FLOAT:velocity, FLOAT:acceleration, INTEGER:matchTargetRotation)'''

Moves the item to the target

'''ItemToInventory(ITEM:item, CHARACTER|ITEM:target [,INT:amount=-1])'''

Moves the item to the target's inventory

'''ItemLookAt(GAMEOBJECT:target, FLOAT:degreesPerSecond)'''

Rotates the item to look at the target

'''ItemDestroy(ITEM:item)'''

Destroys the item

'''ItemSetAmount(ITEM:item, INT:amount)'''

Change the amount of the item

'''IterateItemsInInventory(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each iten in source's inventory. If you pass a tag, it has to have that tag.

'''ItemAddCharges(ITEM:TargetItem, INT:charges)'''

Add/subtract charges from an item

'''ItemResetChargesToInitial(ITEM:TargetItem)'''

Resets charges from item to initial state

'''MakePeace(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make peace between users of the characters

'''MakeWar(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make war between users of the characters

'''FindSurface(OUT FLOAT3:result, GAMEOBJECT|FLOAT3:source, FLOAT:minRange, FLOAT:maxRange, SURFACE:type [,CHARACTER:alignSource, INT:minEnemiesInSurface, INT:maxAlliesInSurface, INT:minimumCellCount])'''

Finds the closest surface of a specific type.

'''FindValidPosition(INOUT FLOAT3:position, FLOAT:radius[, CHARACTER|ITEM:object=null])'''

Finds the closest valid position (where the object can stand.)

'''FindPosition(INOUT FLOAT3:position, CHARACTER:source, INT:canStand, INT:checkSight, FLOAT:minRadius, FLOAT:maxRadius, FLOAT:rangeCheck, CHARACTER:alignSource, INT:minAllies, INT:maxAllies, INT:minEnemies, INT:maxEnemies [,FIXEDSTRING:AiHintTag=null, INT:forceHint=0, FLOAT3:SourcePosition])'''

Finds the closest position from the source (within radius) where the conditions are matched.

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable.

'''StringConcatenate(STRING:stringA, STRING:stringB, OUT STRING:resultingString)'''

Appends stringB to stringA. Resulting string is stored in the third parameter.

== QUERIES ==

GetPosition(GAMEOBJECT:object,OUT FLOAT3:src)

Get the current position of an object

GetForwardDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current forward direction of an object

GetRightDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current right direction of an object

GetUpDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current up direction of an object

GetDirection(GAMEOBJECT|FLOAT3:src,GAMEOBJECT|FLOAT3:target,OUT FLOAT3:direction[, OUT FLOAT:distance])

Get the direction from src to target (optional: returns the distance between the objects as well)

GetRotation(GAMEOBJECT:object, OUT FLOAT3:vector)

Get the rotation of an object

CharacterGetTargetSpline(INT: SplineIndex)

Returns the spline index the character is currently walking towards, or -1 if he is not active on a spline.

IsEqual(OBJECT:variable, OBJECT:variable)

Compares both objects and see if they are equal.

IsLessThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is smaller.

IsGreaterThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is bigger.

IsRandom(FLOAT:percentage)

Each time this condition is checked, it will succeed with a chance of the percentage (between 0 and 1)

IsRound(INT:roundNumber)

Checks if we are currently in combat in round x

IsInSurface(OBJECT|FLOAT3:target, SURFACE:type[, FLOAT:radius])

Check if the character, item, trigger or position is currently within the specific surface.

IsInDangerousSurface(OBJECT|FLOAT3:target[, CHARACTER:character, FLOAT:radius])

Check if <target> is currently in on a dangerous surface. Uses <character> for path influences if provided (is necessary with non-character targets)

IsInDialog(CHARACTER|ITEM:target[, INT:ignoreAutomatedDialogs=0])

Check if the character or item is currently in a dialog, optionally ignoring automated dialogs

IsInAutomatedDialog(CHARACTER|ITEM:target)

Check if the character or item is currently in an automated dialog

GetDistance(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)

Returns the distance between 2 positions

GetDistance2D(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)
Returns the 2D distance between 2 positions (ignores height)

GetInnerDistance(OUT FLOAT:distance, GAMEOBJECT:source, GAMEOBJECT:target)

Returns the distance between 2 gameobjects (character, item, trigger, ...) Their bounds are already subtracted.

GetPosition(GAMEOBJECT:object, OUT FLOAT3:position)

Returns the position of a gameobject (character, item, trigger, ...)

GetVar(OUT OBJECT:returnValue, CHARACTER|ITEM:target, FIXEDSTRING:varName)

Gets a global variable from the target

GetClosestPlayer(OUT CHARACTER:player, GAMEOBJECT|FLOAT3:source)

Gets the closest player near the source, default being being the object itself

GetPlayerCount(OUT INT:playerCount)

Gets the number of players in the party

GetPlayerByIndex(OUT CHARACTER:returnCharacter, INT:playerIndex)

Gets a player from the party by index

GetRandomCharacter(OUT CHARACTER:returnCharacter, [INT:canBeSelf=0, INT:canBePlayer=0])

Gets a random character in the current level

ContainsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if there is any surface of the type within a radius of the source

IsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if the whole radius around the source is the specified surface type

IsObjectOnObject(CHARACTER|ITEM:source,CHARACTER|ITEM:target)

Checks if the source is standing on the target

GetX(FLOAT3:vector, OUT FLOAT:value)

Returns the X component of the vector

GetY(FLOAT3:vector, OUT FLOAT:value)

Returns the Y component of the vector

GetZ(FLOAT3:vector, OUT FLOAT:value)

Returns the Z component of the vector

CanSee(GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target[, INT:addProjectileTargetGroundOffset=0])

Check if the sight is blocked between 2 points.

IsVisible(CHARACTER|ITEM:object)

Check if the object is set invisible or not with SetVisible.

GetTextDuration(CHARACTER|ITEM:object, FIXEDSRTING:key, OUT FLOAT:duration)

Gets how long a text needs to be displayed

IsCasual(-)

Returns if the current game mode is Casual

IsHardcore(-)

Returns if the current game mode is Hardcore

IsTagged(GAMEOBJECT:object, FIXEDSTRING:tag)

Check if the object is tagged.

TranslatedStringKeyExists(FIXEDSTRING:key)

Check if the TranslatedString key exists.

IsInCombat(CHARACTER|ITEM:object)

Returns true if the object is in combat.

IsInCombatWith(CHARACTER|ITEM:object, CHARACTER|ITEM:object)

Returns true if the objects are in combat with each other.

IsFacing(GAMEOBJECT:source, GAMEOBJECT|FLOAT3:target, [INT:angle=90])

Returns true if the object is facing the position within the given angle.

GameIsSaving(-)

Returns true if the game is saving.

GameIsLoading(-)

Returns true if the game is loading.

GetUserCount(OUT INT:userCount)

Returns the user count.

GetCurrentCharacter(OUT CHARACTER:character, INT:user)

Returns the character currently being controlled by the specified user.

GetCurrentLevel(OUT FIXEDSTRING:currentLevel)

Returns the current levelname

GetAIBounds(CHARACTER|ITEM:source, OUT FLOAT:bounds)

Returns AI bounds of <source> in <bounds>

HasGlobalFlag(FIXEDSTRING:flagName)

Returns if the Global Flag is set

HasFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the Object

HasUserFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the user's characters

HasPartyFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the party's characters

DialogExists(STRING:dialogue)

Returns true if the dialogue exists.

IsActive(CHARACTER|ITEM:Object)

Returns if the character or item is currently active.

ListGetSize(LIST<OBJECT>:list, out INT:size)

Returns the number of elements in <list>

ListGet(LIST<OBJECT>:list, INT:index, out OBJECT:entry)

Returns <entry> at <index> of <list>

ListGetRandom(LIST<OBJECT>:list, out OBJECT:entry)

Returns a random <entry> of <list>

IsBoss(CHARACTER|ITEM:Object)

Returns true if the entity is tagged as a boss

IsProjectileSkill(SKILL:skill)

Returns true if the skill is a ranged skill (uses a projectile)

IsValidSkillTarget(CHARACTER:source, OBJECT|FLOAT3:target, SKILLID:skill[, INTEGER:ignoreRangeCheck=0])

Checks whether <target> is a valid target for <skill> at <source>

GetFaction(OUT FIXEDSTRING:faction, CHARACTER|ITEM:character)

Returns the faction of the provided character or item

IsInActiveTurn(CHARACTER|ITEM:target)

Returns true if it's the character's or item's turn in combat.

IsSkillActive(CHARACTER:character, SKILL:skillId)

Returns true if <character> has <skillId> active (in memory).

HasSkillAi(SKILLID:skillId)

Returns true if the skill is using the new Ai system

IsInArena(CHARACTER::character)

Returns true if the character is in an arena fight

CrimeGetType(INTEGER:crimeId, OUT STRING:crimeType)

Returns the type of the crime with this id.

CrimeGetCriminals(INTEGER:crimeId, OUT CHARACTER:criminal1, OUT CHARACTER:criminal2, OUT CHARACTER:criminal3, OUT CHARACTER:criminal4)

Returns the criminals of that crime. They might all be null.

IsSourceSkill(SKILL:skill)

Returns true if the skill is a source skill.

IsInGameMasterMode(-)

Returns true if the game in game master mode.

CharacterGet(OUT CHARACTER:character, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo, COMPAREFUNC:compareFunc[, RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf, FIXEDSTRING:tag])

Get a character within a certain range conforming to the filled in restraints.

CharacterCount(OUT INT:count, GAMEOBJECT|FLOAT3:src, FLOAT:range, [RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf])

Counts the characters within a certain range conforming to the filled in restraints.

CharacterGetOwner(OUT CHARACTER:owner, CHARACTER:source)

Get the character's owner

CharacterGetFollow(OUT CHARACTER:to follow, CHARACTER:source)

Get the character to follow

CharacterGetEnemy(OUT CHARACTER:current enemy, CHARACTER:source)

Get current enemy of character

CharacterCanCast(CHARACTER:source, SKILL:skillId, [ITEM:skillItem=null, INT:ignoreActionPoints=0])

Check if the character source can cast the skill: will check cooldown, actionpoints

CharacterCanSitOnItem(CHARACTER:source, ITEM:item)

Check if the character source can sit or lie on an item.

CharacterCanDrinkPotion(CHARACTER:source, FIXEDSTRING:potionID[, INT:ignoreActionPoints=0])

Check if the character source can drink the potion: will check inv and actionpoints

CharacterCanUseItem(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in the world

CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in his inventory

CharacterCanSee(CHARACTER:watchingChar, CHARACTER|ITEM:target [, INT:forceUpdate=0])

Check if character has target in his line of sight.

CharacterCanShoot(CHARACTER:source, GAMEOBJECT|FLOAT3:target)

Check if the character can shoot the target.

CharacterIsPlayer(CHARACTER:character)

Check if the character is a player

CharacterIsInParty(CHARACTER:character)

Check if the character is in the party

CharacterIsEnemy(CHARACTER:source, CHARACTER:target)

Check if target is enemy of source

CharacterIsAlly(CHARACTER:source, CHARACTER:target)

Check if target is ally of source

CharacterIsNeutral(CHARACTER:source, CHARACTER:target)

Check if target is neutral of source

CharacterIsDead(CHARACTER:character)

Check if character is dead

CharacterIsMoving(CHARACTER:character)

Check if character is moving (speed > 0)

CharacterIsSummon(CHARACTER:character)

Check if character is a summon

CharacterIsPartyFollower(CHARACTER:character)

Check if character is a party follower

CharacterIsStoryNPC(CHARACTER:character)

Check if character is a story NPC

CharacterInWeaponRange(CHARACTER:character, CHARACTER:target)

Check if target is in the current's weapon range

CharacterInTouchRange(CHARACTER:character, CHARACTER:targetChar)

Check if target is in the character's touch range

CharacterHasStatus(CHARACTER:character, STATUS:statusId[, FIXEDSTRING:extraData])

Check if character currently has the status. ExtraData can be filled in for some statuses: - Consume: statsid of the item - Shield: skillid of the shield

CharacterGetStatusSourceCharacter(CHARACTER:character, STATUS:statusId, OUT CHARACTER:source[, FIXEDSTRING:extraData])

Get the source character of a status

CharacterGetStatusSourceItem(CHARACTER:character, STATUS:statusId, OUT ITEM:source[, FIXEDSTRING:extraData])

Get the source item of a status

CharacterHasTalent(CHARACTER:character, TALENT:talent)

Check if character currently has the talent

CharacterHasSkill(CHARACTER:character, SKILL:skillId)

Check if character currently has the skill

CharacterHasWeaponType(CHARACTER:character, WEAPON:weaponTYPE [, INT:equipped])

Check if character currently has a weapon of this type in his inventory or equipped

CharacterGetStat(OUT FLOAT:statValue, CHARACTER:character, CHARACTERSTAT:statType)

Returns the current value of the stat (Vitality, ...)

CharacterGetSightRange(OUT FLOAT:range, CHARACTER:character)

Returns the character's sight range

CharacterGetWeaponRange(OUT FLOAT:minRange, OUT FLOAT:maxRange, CHARACTER:character)

Returns the character's current weapon range

CharacterGetTouchRange(OUT FLOAT:touchRange, CHARACTER:character)

Returns the character's current touch range

CharacterGetSkillRange(OUT FLOAT:minRange, OUT FLOAT:maxRange,CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterGetSkillImpactRange(OUT FLOAT:areaRange, CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterIsInTrigger(CHARACTER:character, TRIGGER:trigger)

Check if character is in given trigger

CharacterGetAbility(OUT INT:value, CHARACTER:character, ABILITY:ability)

Returns the character's value of the specified ability

CharacterGetHostileCount(OUT INT:value, CHARACTER:character)

Returns how many characters are targeting this character right now... You can iterate over them with IterateEnemiesOf.

CharacterCanFight(CHARACTER:character)

Returns true if the character can fight.

CharacterGetTemplate(CHARACTER:character, OUT CHARACTERTEMPLATE:root)

Returns the roottemplate of the character.

CharacterCanSpotSneakers(CHARACTER:character)

Returns true if the character can spot sneaking characters

CharacterIsFloating(CHARACTER:character)

Check if character is a floating character

CharacterInCreation(CHARACTER:character)

Returns true if the character is in character creation

CharacterAvoidsTraps(CHARACTER:character)

Returns true if the character avoids traps

CharacterCheckRelation(CHARACTER:character, RELATION:relation)

Returns true if relation check succeeds

CharacterIsBetterOrEqualClass(CHARACTER:character, INT:currentScore, OUT INT:newScore, INT warriorScore, INT rogueScore, INT mageScore, INT clericScore, INT rangerScore)

Returns true if score is higher or equal than the current score

CharacterHasBeenHitBy(CHARACTER:character, DAMAGE_TYPE:damageType)

Returns true if the character was hit by this type.

CharacterHasCastedSpellLastTurn(CHARACTER:character)

Returns true if the character has casted a spell in his last turn.

CharacterHasHadStatus(CHARACTER:character, STATUS:status)

Returns true if the character has had a specific status this combat.

CharacterHasAnimationOverride(CHARACTER:character)

Returns true if the character has an animation override.

CharacterCanUnlock(CHARACTER:character, ITEM:item)

Returns true if the character can unlock the item (if the item is already unlocked it returns true!)

CharacterGetReservedUserID(OUT INT:user, CHARACTER:character)

Returns the character's reserved User id.

CharacterGetRace(CHARACTER:character, OUT FIXEDSTRING:race)

Returns the <character>'s race in <race>.

CharacterIsRace(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character>'s race is <race>.

CharacterCanMoveItem(CHARACTER:character, ITEM:item, FLOAT:minRadius, FLOAT:maxRadius [, OUT FLOAT3:destination])

Returns true + <destination> if <character> can move <item> somewhere between <minRadius> and <maxRadius>.

CharacterGetDeathType(CHARACTER:character, OUT FIXEDSTRING:deathType)

Returns death type of <character> in <deathType>.

CharacterGetStillAnimation(CHARACTER:object, OUT FIXEDSTRING:stillAnimation)

Returns the still animation to play

CrimeTransferLeadership(INT: CrimeID[, FIXEDSTRING:Tag1,...])

Try and transfer the leadership of this crime to someone else.

CrimeGetLeadInvestigator(OUT CHARACTER:lead, INT: CrimeID)

Returns the lead investigator for the crime.

CharacterCanHitTargetWithRangedWeapon(CHARACTER:source, OBJECT|FLOAT3:target[, SKILL:skill = null])

Returns true if <source> can hit <target> with currently equipped ranged weapon. Will use <skill> instead of equipped weapon if provided.

CharacterHasRangedWeapon(CHARACTER:character[, INT:checkInventory = 0])

Returns true if <character> has has ranged weapon. Checks for non-wielded weapons if <checkInventory> is 1

CheckInteractionReach(CHARACTER:character, CHARACTER|ITEM: target)

Returns true if <character> could interact with <target>. This is not checking ranges, but checking if there's too much of a height difference or too many obstacles in between.

CharacterGetSourcePoints(CHARACTER:character, OUT INT: amount)

Returns the amount of sourcepoints of <character>.

CharacterAiIsCalculating(-)

Returns if the character is still calculating the AI.

CharacterAiFetchMoveSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3:target)

Returns if the character has a Move Skill command to execute according to the AI.

CharacterAiFetchSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3 endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target, OUT FLOAT3:target2, OUT CHARACTER:target2, OUT ITEM:target)

Returns if the character has a Skill command to execute according to the AI.

CharacterAiFetchConsumeCommand(OUT ITEM:item)

Returns if the character has a Consume command to execute according to the AI.

CharacterAiFetchAttackCommand(OUT FLOAT3:endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target)

Returns if the character has a Attack command to execute according to the AI.

CharacterAiFetchFallbackCommand(OUT FLOAT3:targetPosition, OUT FLOAT3:lookAtPosition)

Returns if the character has a Fallback command to execute according to the AI.

CharacterGetArchetype(CHARACTER:character, OUT ARCHETYPE:archetype)

Returns the archetype of the character.

CharacterIsPolymorphedInto(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character> is polymorphed into <race>. Race can be a race (like HUMAN), but also a template (in case of a polymorph skill like Chicken Touch).

CharacterIsPolymorphInteractionDisabled(CHARACTER:character)

Returns true if <character> has his interaction disabled because of a polymorph.

ItemGet(OUT ITEM:item, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo [, COMPAREFUNC:compareFunc, FIXEDSTRING:rootTemplate, FIXEDSTRING:tag])

Get an item within a certain range conforming to the filled in restraints.

ItemGetFromInventory(OUT ITEM:item, CHARACTER|ITEM:object [, FIXEDSTRING:statsId, FIXEDSTRING:tag, INT:isEquiped])

Returns the first item in the inventory conforming to the filled in restraints.

ItemIsInCharacterInventory(ITEM:item, CHARACTER:object)

Returns if the item is in the inventory of the character

ItemIsInTrigger(ITEM:item, TRIGGER:trigger)

Check if item is in given trigger

ItemGetStat(OUT FLOAT:statValue, ITEM:item, ITEMSTAT:statType)

Returns the current value of the stat (Weight, ...)

ItemIsMoving(ITEM:item)

Returns if the item is moving or not.

ItemIsFalling(ITEM:item)

Returns if the item is falling or not. (after teleport)

ItemIsOpening(ITEM:item)

Returns if the item is opening or not.

ItemIsClosing(ITEM:item)

Returns if the item is closing or not.

ItemIsLocked(ITEM:item)

Returns if the item is locked or not.

ItemIsMovable(ITEM:item)

Returns if the item is movable or not.

ItemCanBeLockPicked(ITEM:item)

Returns if the item is can be opened by lockpicking.

ItemIsOpen(ITEM:item)

Returns if the item is open or not.

IsStoryItem(ITEM:item)

Returns if the item is a story item.

ItemHasStatus(ITEM:item, STATUS:statusId)

Returns if the item has the status.

ItemIsDestroyed(ITEM:item)

Returns if the item is destroyed.

ItemGetTemplate(ITEM:item, OUT ITEMTEMPLATE:root)

Returns the roottemplate of the item.

ItemGetSkillId(ITEM:item, OUT SKILL:root)

Returns the skillid of the item if it has one.

ItemGetItemType(ITEM:item, OUT FIXEDSTRING:itemType)

Returns the itemtype of the item: common, unique, rare, ...

ItemGetStatusSourceCharacter(ITEM:item, STATUS:statusId, OUT CHARACTER:source)

Get the source character of a status

ItemGetStatusSourceItem(ITEM:item, STATUS:statusId, OUT ITEM:source)

Get the source item of a status

ItemCanBeMoved(ITEM:item)

Returns if the item can be moved.

== EVENTS ==

OnCharacterEvent(CHARACTER:character, STRING:eventName)

Thrown from scripts or story

OnCharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)
Thrown from scripts or story

OnCharacterCharacterEvent(CHARACTER:character, CHARACTER:character, STRING:eventName)

Thrown from scripts or story

OnItemEvent(ITEM:item, STRING:eventName)
Thrown from scripts or story

OnItemDestroyed(ITEM:item)

Thrown when an item is destroyed

OnItemDestroying(ITEM:item)
Thrown when an item is being destroyed

OnItemOpened(ITEM:item)

Thrown when an item is opened

OnItemClosed(ITEM:item)
Thrown when an item is closed

OnItemDropped(ITEM:item, STRING:itemTemplate)

Thrown when an item is dropped

OnGlobalFlagSet(FIXEDSTRING:eventName)
Thrown when a global event is set

OnGlobalFlagCleared(FIXEDSTRING:eventName)

Thrown when a global event is cleared

OnCharacterFlagSet(FIXEDSTRING:eventName, CHARACTER:character)
Thrown when a dialog event is set on a character

OnCharacterFlagCleared(FIXEDSTRING:eventName, CHARACTER:character)

Thrown when a dialog event is cleared on a character

OnItemFlagSet(FIXEDSTRING:eventName, ITEM:item)
Thrown when a dialog event is set on an item

OItemFlagCleared(FIXEDSTRING:eventName, ITEM:item)

Thrown when a dialog event is cleared on an item

OnTimer(FIXEDSTRING:timerName)
Thrown when a timer has ended

OnInit(-)

Thrown when the script is set

OnLoaded(INT:major, INT:minor, INT:revision, INT:build)

Thrown when the script is loaded from the savegame

OnShutdown(-)

Thrown when the character's script is removed

OnVariableCleared(FIXEDSTRING:varName)

Thrown when this object's script variable is cleared from Osiris with ClearVarObject

OnCombatStarted(CHARACTER:source, ITEM:source)

Thrown when the character entered a combat

OnCombatSwitched(CHARACTER:source, ITEM:source)

Thrown when the character switch from one combat to another

OnCombatEnded(CHARACTER:source, ITEM:source)

Thrown when the character left the combat

OnTurn(CHARACTER:source, ITEM:source)

Thrown when the character's turn starts

OnTurnEnded(CHARACTER:source, ITEM:source)

Thrown when the character's turn ended

OnCharacterVitalityChanged(CHARACTER:character, FLOAT:percentage)

Thrown when the characters's vitality changed

OnItemVitalityChanged(ITEM:item, FLOAT:percentage)

Thrown when the item's vitality changed

OnAttackOfOpportunity(CHARACTER:target)

Thrown when the characters gets an attack of opportunity on an enemy

OnDamage(DAMAGE:type, FLOAT:percentage, CHARACTER:source, ITEM:source)

Thrown when the object receives damage

OnMiss(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)

Thrown when the character dodges something

OnCriticalHit(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)

Thrown when the character is critical hit

OnBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)

Thrown when the character blocks something

OnDie(CHARACTER:character, DAMAGE:type, CHARACTER:source, ITEM:source)

Thrown when the character dies

OnCharacterStatusAttempt(CHARACTER:character, STATUS:status)

Thrown when the character attempts to gain a status

OnCharacterStatusApplied(CHARACTER:character, STATUS:status)

Thrown when the character gains a status

OnCharacterStatusRemoved(CHARACTER:character, STATUS:status)

Thrown when the character loses a status

OnItemStatusAttempt(ITEM:item, STATUS:status)

Thrown when the item attempts to gain a status

OnItemStatus(ITEM:item, STATUS:status)

Thrown when the item gains a status

OnItemStatusRemoved(ITEM:item, STATUS:status)

Thrown when the item loses a status

OnStatusCreateVisuals(STATUS:status)

Thrown when the item should create the visuals for this status

OnStatusDestroyVisuals(STATUS:status)

Thrown when the item should destroy the visuals for this status

OnSight(CHARACTER:character)

Thrown when the character sees another character

OnLostSight(CHARACTER:character)

Thrown when the character doesn't see another character anymore

OnUseItem(CHARACTER:source, ITEM:item)

Thrown when a character uses an item

OnPickupItem(CHARACTER:source, ITEM:item)

Thrown when a character picks up an item

OnCharacterMovedItem(CHARACTER:source, ITEM:item)

Thrown when a character moved an item

OnItemEquipped(CHARACTER:source, ITEM:item)

Thrown when a character equips an item

OnItemUnequipped(CHARACTER:source, ITEM:item)

Thrown when a character unequips an item

'''OnIterateCharacter(CHARACTER:character, FIXEDSTRING:eventId)'''

Thrown by iterators

'''OnIterateItem(ITEM:source, FIXEDSTRING:eventId)'''

Thrown by iterators

'''OnIterateCount(FIXEDSTRING:eventId, INTEGER:Count)'''

Thrown by iterators after all iterations to inform you of the count.

'''OnStoryOverride(-)'''

Throw when story overrides what the character was doing: teleport, movement, on/offstage

'''OnTriggerEnter(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)'''

Thrown by a character or item entering an EventTrigger

'''OnTriggerLeave(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)'''

Thrown by a character or item leaving an EventTrigger

'''OnEnemyChanged(CHARACTER:character, CHARACTER:newEnemy)'''

Thrown when the character's currentenemy changes

'''OnTalentUnlocked(CHARACTER:character, TALENT:newTalent)'''

Thrown when the character unlocks a new talent

'''OnCharacterClassChanged(CHARACTER:character, FIXEDSTRING:class)'''

Thrown when the character changes class in the character creation screen

'''OnCharacterCreationStarted(CHARACTER:character, TRIGGER:creationPoint)'''

Thrown when the character creation has started, and gives where the character should walk to

'''OnCharacterCreationStopped(CHARACTER:character)'''

Thrown when the character creation has stopped

'''OnFunction(FIXEDSTRING:functionName)'''

Throws an event on itself with the functionName. This is to fake function calls

'''OnSkillCast(CHARACTER:character, SKILL_ID:skillID)'''

Thrown when the character casts a skill

'''OnSkillCombatComment(CHARACTER:character, SKILL_ID:skillID)'''

Thrown when the character needs to make a comment

'''OnCharacterUsedSkillOnMe(CHARACTER:character, SKILL_ID:skillID)'''

Thrown when you are hit by a skill from a character

'''OnItemUnlocked(ITEM: item, CHARACTER:character, ITEM:key)'''

Thrown when an item gets unlocked by a character.

'''OnAutomatedDialogEnded(STRING:dialogName, INT:instanceID)'''

Thrown when a automated dialog is ended for this speaker

'''OnAutomatedDialogStarted(STRING:dialogName, INT:instanceID)'''

Thrown when a automated dialog is started for this speaker

'''OnDialogEnded(STRING:dialogName, INT:instanceID)'''

Thrown when a dialog is ended for this speaker

'''OnCrimeSensibleAction(FIXEDSTRING:regionID, INT:crimeID, FIXEDSTRING:reactionName, STRING:primaryDialog, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, INT:IsPrimary)'''

Thrown when a character needs to perform a sensible action against criminals

'''OnCrimeInterrogationRequest(FIXEDSTRING:regionID, INT:crimeID, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4, STRING:interrogationDialog)'''

Thrown when a character needs to perform an interrogation against criminals

'''OnCrimeInvestigate(FLOAT3:CrimePosition, INT:crimeID)'''

One NPC investigates a crimescene

'''OnCrimeAlarmed(FLOAT3:CrimePosition, INT:crimeID)'''

All NPCs in a crimearea start looking around.

'''OnCrimeReturnToNormal(-)'''

Investigation or Alarm timed out.

'''OnCrimeAborted(-)'''

The game interrupted the sensible action of this NPC.

'''OnSplineControlPointReached(INT:Index, INT:EndReached, STRING:EventString)'''

Thrown when a character reached a spline node.

''''OnFinishCalculationAi(-)'''

Thrown when the calculation of the AI is finished.

'''OnGrenadeLand(INT:hitObstacle, CHARACTER:caster)'''

Thrown when the grenades lands

'''FetchCharacterApplyStatusData(CHARACTER:character, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)'''

Fetch from script which statuses to remove and apply.

'''FetchItemApplyStatusData(ITEM:item, STATUS:status) RETURN(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns)'''

Fetch from script which statuses to remove and apply.

'''FetchItemSkillOnDamage(INT:damage, DAMAGE_TYPE:damageType) RETURN(INT:hasSkill, SKILL_ID:skillID, INT:casterLevel)'''

Fetch from script what skill to execute on damage.

'''OnActivate(-)'''

Thrown when a character/item activates

'''OnDeactivate(-)'''

Thrown when a character/item deactivates

'''OnCharacterUsedSourcePoint(CHARACTER:character)'''

Thrown when a character uses a source point

'''OnSkillAdded(CHARACTER:character, SKILL_ID:skillId, INT:learned)'''

Thrown when a character learns a skill

'''OnSkillActivated(CHARACTER:character, SKILL_ID:skillId)'''

Thrown when a character activates (=adds to memory) a skill

'''OnSkillDeactivated(CHARACTER:character, SKILL_ID:skillId)'''

Thrown when a character deactivates (=removes from memory) a skill

'''OnItemFlagShared(FIXEDSTRING:eventName, ITEM:item, INT:newValue)'''

Thrown when a dialog event is shared with an item

'''OnCharacterFlagShared(FIXEDSTRING:eventName, CHARACTER:character, INT:newValue)'''

Thrown when a dialog event is shared with a character

'''OnItemOffStageChanged(CHARACTER:character, INT:offstage)'''

Thrown when a character is set on/off stage

'''OnCharacterOffStageChanged(ITEM:item, INT:offstage)'''

Thrown when a item is set on/off stage

'''OnCharacterTeleported(CHARACTER:target, CHARACTER:cause, FLOAT3:oldPosition, FLOAT3:newPosition, SKILL_ID:skillId)'''

Thrown when a character gets teleported with a teleport skill

'''OnCombatTick(-)'''

Thrown when this object ticks in combat. Only thrown for objects that don't get a turn.

== INTERRUPTS ==

'''OnMovementFailed(FLOAT3:targetPos)'''

Thrown when the reaction is interrupted by a move action failing

'''OnException(-)'''

Thrown when the reaction is interrupted by an exception

'''OnBetterReactionFound(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted by another reaction

'''OnNoReactionFound(-)'''

Thrown when the reaction is interrupted because no reaction is valid

'''OnScriptDisabled(-)'''

Thrown when the reaction is interrupted because the scriptcontroller is disabled

'''OnManualInterrupt(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted using the interrupt action

'''OnRegionSwap(FIXEDSTRING:oldLevel, FIXEDSTRING:newLevel)'''

Thrown when the reaction is interrupted by a region swap

Character and Item Script Triggers, Calls, and Queries

2018-03-02T10:58:50Z

Rimevan:

This is a list of almost every character and item script event trigger, call, and query. An event is what triggers the script, and always begin with ''On''. Queries provide information and are always inside an ''IF'' or ''CHECK.'' Calls are actions that are always after THEN.

CharScript/ItemScript Functions

== CALLS ==

'''Set(OUT OBJECT:variable, OBJECT:value)'''

Set the value of a variable

'''SetVar(CHARACTER|ITEM:object, FIXEDSTRING:variableName, OBJECT:value)'''

Set the value of a global variable

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable

'''Print(OUT STRING:output, STRING:text)'''

Prints the text to the output with possible parameters: [1], [2], ...

'''Add(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Adds both values and stores it in the first variable

'''Subtract(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT|FLOAT3:value)'''

Subtracts both values and stores it in the first variable

'''Multiply(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Multiplies both values and stores it in the first variable

'''Divide(INOUT INT|FLOAT|FLOAT3:variable, INT|FLOAT:value)'''

Divides both values and stores it in the first variable

'''Abs(INOUT INT|FLOAT:variable)'''

Takes the absolute value of a variable

'''Clamp(INOUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Clamps a variable between min and max

'''GetRandom(OUT OBJECT:variable, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with random one of the values.

'''GetWeightedRandom(OUT OBJECT:variable, OBJECT:value, INT|FLOAT:weight, ...)'''

Gets a weighted random of the given values!

'''GetRandomBetween(OUT INT|FLOAT:variable, INT|FLOAT:min, INT|FLOAT:max)'''

Gets a random value between min and max (both included)

'''GetRandomPositionInTrigger(OUT FLOAT3:variable, TRIGGER:areaTrigger)'''

Get a random position in a trigger area

'''GetElement(OUT OBJECT:variable, INT:index, OBJECT:value, OBJECT:value, OBJECT:value)'''

Fills in the variable with the index one of the values (starting from 0)

'''SetPriority(FIXEDSTRING:reactionName, INT:priority)'''

Changes the priority of a reaction. Priority 0 and below are not executed!

'''DelayReaction(FIXEDSTRING:reactionName, FLOAT:timeInSeconds)'''

The reaction will not be chosen for the specified time

'''SetScriptFrame(CHARACTER:character, FIXEDSTRING:frame)'''

Sets the scriptframe on the character.

'''ClearScriptFrame(CHARACTER:character)'''

Clears the scriptframe on the character.

'''Goto(FIXEDSTRING:labelName)'''

Jumps to the label. Two label names are built-in: "Start" for the first instruction of the reaction, and "End" for the last one.

'''GotoIfEqual(OBJECT:variable, OBJECT:value, FIXEDSTRING:labelName)'''

Jumps to the label if the 2 objects are equal

'''GotoRand(FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName, FIXEDSTRING:labelName)'''

Jumps to a random label in the list

'''CreatePuddleAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, INT:cellAmountMin, INT:cellAmountMax, INT:growAmountMin, INT:growAmountMax, )'''

Spawn a puddle at the target's position for a certain lifetime (in turns)

'''CreateSurfaceAt(GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, INT:lifeTime[, GAMEOBJECT:owner])'''

Spawn a surface at the target's position for a certain lifetime (in turns)

'''CreateSurfaceInPolygon(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, GAMEOBJECT|FLOAT3:point1, GAMEOBJECT|FLOAT3:point2, GAMEOBJECT|FLOAT3:point3, ...)'''

Spawn a polygon surface at the target's position. Grows <growStep> every <growTimer>.

'''CreateSurfaceInAreaTrigger(GAMEOBJECT:owner, SURFACE:type, FLOAT:duration, FLOAT:growTimer, INT:growStep, TRIGGER:areaTrigger)'''

Spawn a surface within <areaTrigger>. Grows <growStep> every <growTimer>.

'''CreateConeSurfaceAt(GAMEOBJECT|FLOAT3:start, GAMEOBJECT|FLOAT3:target, SURFACE:type, FLOAT:radius, FLOAT:angle, FLOAT:duration)'''

Spawn a Cone surface at the target's position

'''PlayEffectAt(GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''PlayLoopEffectAt(OUT INT64:effectHandle, GAMEOBJECT|FLOAT3:target, STRING:effectName)'''

Plays an effect at the target's position

'''ExplodeAt(GAMEOBJECT|FLOAT3:target, SKILL:projectileSkill, [INT:casterLevel=-1, CHARACTER|ITEM:cause])'''

Trigger an explosion of a projectile skill at the target's position. The cause will trigger NPC behavior as if the cause casted the projectile

'''DisplayText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''DisplayCombatInfoText(CHARACTER|ITEM:target, FIXEDSTRING:text, FLOAT:timeInSeconds)'''

Displays text above the character/item for a certain amount of time. It will replace the current text, including dialogtext

'''StatusText(CHARACTER|ITEM:target, FIXEDSTRING:text)'''

Adds statustext above the character/item for a short amount of time. Will not replace texts or dialogtexts

'''DebugText(CHARACTER|ITEM:target, STRING:text)'''

Adds debugtext above the character/item for a short amount of time.

'''CombatLogText(CHARACTER|ITEM:target, FIXEDSTRING:text, INT:filterID, INT:broadcastID)'''

Adds combatlog text inside the combat log window. Color-/SizeFormatting should already be applied, if not color and size of the string will be NORMAL. filterID determines what filter shows/hides the text. broadcastID determines who will be able to see the message (0 hearingrange. 1 party. 2 all)

'''Log(STRING:text, ...)'''

Log's the the scriptlog. (for debugging purposes)

'''Output(STRING:text, ...)'''

Pass text with optional parameters to the output panel (e.g. Output("An int [1]", INT:10))

'''Assert(STRING:text, ...)'''

Pass text with optional parameters to display as an assert message (e.g. Assert("This number is wrong: [1]", INT:666))

'''Label(FIXEDSTRING:name)'''

Marks this line as a label where Goto actions can jump to

'''StartTimer(FIXEDSTRING:timerName, FLOAT:timeInSeconds, INT:repeatCount)'''

Start a timer which will throw the timer event. Set repeatcount < 0 for a permanent timer.

'''StopTimer(FIXEDSTRING:timerName)'''

Stop a timer which will throw the timer event

'''DialogStart(OUT INT:instanceId, STRING:dialog, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target, CHARACTER|ITEM:target)'''

Start a dialog between the targets. You can specify fewer targets than the maximum number.

{{warning|Starting a dialog from behaviour script will always start it as an [[Dialog_editor#Automated|Automated Dialog]]. Interactive dialogs can only be started from [[Osiris]].}}

'''DialogRequestStop(CHARACTER|ITEM:speaker, STRING:dialog)'''

Stops a certain dialog on a certain speaker

'''Check(-)'''

Reevaluate the conditions in the CHECK section of this reaction

'''Reset(-)'''

Resets the current reaction. It will start from the beginning again

'''Interrupt(FIXEDSTRING:reactionName)'''

Interrupt the reaction.

'''GlobalSetEvent(FIXEDSTRING:eventName)'''

Sets a global event. Scripts and Story can catch it.

'''GlobalClearEvent(FIXEDSTRING:eventName)'''

Clears a global event. Scripts and Story can catch it.

'''StopLoopEffect(INT64:fxHandle)'''

Stops a looping effect

'''IterateItems(FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item. If you pass a tag, it has to have that tag.

'''IterateItemsNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item in range. If you pass a tag, it has to have that tag.

'''IterateItemsOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each item standing on the source. If you pass a tag, it has to have that tag.

'''IterateParty(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, CHARACTER:partyMember, FIXEDSTRING:tag])'''

Launch iterate event for each member of all parties. If you pass a party member only members of that party will be considered. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharacters(FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersNear(GAMEOBJECT:source, FLOAT:radius, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in range. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersOnObject(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''
Launch iterate event for each character standing on the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateCharactersInCombat(CHARACTER|ITEM:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character in combat with the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''IterateHostilesFor(CHARACTER:source, FIXEDSTRING:eventname, [COMPARE:howTo, COMPAREFUNC:compareFunc, FIXEDSTRING:tag])'''

Launch iterate event for each character who is targetting the source. If you pass compare parameters, it will iterate over them in the requested order. If you pass a tag, it has to have that tag.

'''SpawnCharacter(OUT CHARACTER:result, CHARACTERTEMPLATE:rootTemplate, GAMEOBJECT|FLOAT3:position, INT:playSpawn, [INT:isSummon=0, CHARACTER:summonOwner=null, INT:overrideLevel=-1])'''

Spawns a character

'''SpawnItem(ITEMTEMPLATE:rootTemplate,GAMEOBJECT|FLOAT3:position, OUT ITEM:result)'''

Spawns an item

'''ShootLocalProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootLocalProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Spawns a projectile at the source (with offset, can be null) shooting at the target

'''ShootWorldProjectile(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootWorldProjectileAt(SKILL:projectileSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Spawns a projectile at worldPos shooting at the target. Source can be null.

'''ShootLocalCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,FLOAT3:direction,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) in a direction

'''ShootLocalConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:localOffset,GAMEOBJECT|FLOAT3:target,[INT:casterLevel, CHARACTER|ITEM:caster])'''

Shoots a cone from source (with offset, can be null) at the target

'''ShootWorldCone(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,FLOAT3:direction,[INT:casterLevel])'''

Shoots a cone from worldPos in a direction. Source can be null.

'''ShootWorldConeAt(SKILL:coneSkill,CHARACTER|ITEM:source,FLOAT3:worldPos,GAMEOBJECT|FLOAT3:target,[INT:casterLevel])'''

Shoots a cone from worldPos at the target. Source can be null.

'''SetVisible(CHARACTER|ITEM:object, INT:visible)'''

Sets a character or item visible or not.

'''RotateY(INOUT FLOAT3:vector, FLOAT:degrees)'''

Rotate the vector around the Y-axis for a certain angle (in degrees)

'''SetHealth(CHARACTER|ITEM:target, FLOAT:percent)'''

Set a characters or items health on the given percentage. (percentage between 0 and 1)

'''PlaySound(CHARACTER|ITEM:target, STRING:soundEvent)'''

Plays a sound event at the target

'''PlayMusicForEveryone(STRING:musicEvent)'''

Plays a music event on all the clients

'''PlayMusicOnCharacter(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on a character for all peers (3D)

'''PlayMusicForPeer(CHARACTER:target, STRING:musicEvent)'''

Plays a music event on the peer of the character

'''PlayMusicForPeerWithInstrument(CHARACTER:target, CHARACTER:charInstrument, STRING:musicEvent)'''

Plays a music event on the peer of the character concated with _INSTRUMENT

'''SetX(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the X component of the FLOAT3

'''SetY(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Y component of the FLOAT3

'''SetZ(INOUT FLOAT3:vector, FLOAT|INT:value)'''

Sets the Z component of the FLOAT3

'''SetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID, FIXEDSTRING:atmosphere)'''

Changes the atmosphere of the trigger

'''ResetAtmosphere(FIXEDSTRING:atmosphereTriggerUUID)'''

Resets the atmosphere of the trigger

'''AddStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1], [INT:force=1])'''

Adds the status influence strength on the object.

'''RemoveStatusInfluence(CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Removes the status influence strength on the object.

'''AddTemporaryStatusInfluence(CHARACTER|ITEM:source, CHARACTER|ITEM:object, STATUS:statusId, FLOAT:strength, [FIXEDSTRING:extraData=""], [INT:isWeather=1])'''

Adds a temporary status influence strength on the object.. It will be gone in a few seconds if it's not set again

'''CallFunction(FIXEDSTRING:functionName)'''

Calls a function with the ID

'''SetMaterial(CHARACTER|ITEM:object, FIXEDSTRING:materialUUID, INT:duration, INT:applyOnBody, INT:applyOnArmor, INT:applyOnWeapon[)'''

Changes the material of the object for a set time (in turns), -1 is infinite. applyNormalMap: Copy the original materials normal map

'''TeleportTo(CHARACTER|ITEM:object, GAMEOBJECT|FLOAT3:target, [INT:Force=0])'''

Teleport object to or near the target

'''Transform(CHARACTER|ITEM:object, CHARACTERTEMPLATE|ITEMTEMPLATE:root [, FIXEDSTRING:fx, INT:replaceScripts=1, OUT FLOAT:currentHP])'''

Transforms <object> using <root>, returns <currentHP>, plays <fx>.

'''SaveGame(FIXEDSTRING:saveGameName)'''

Save the savegame with name <saveGameName>

'''LoadGame(FIXEDSTRING:saveGameName)'''

Load the savegame with name <saveGameName>

'''LoadLevel(FIXEDSTRING:levelName)'''

Load the level with name <levelName>

'''KillCombat(CHARACTER:character)'''

Kill all the enemies in the combat which contains <character>

'''SetTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Sets the Tag on the Object

'''ClearTag(CHARACTER|ITEM:object, FIXEDSTRING:tag)'''

Clears the Tag on the Object

'''SetGlobalFlag(FIXEDSTRING:flagname)'''

Sets the Global Flag

'''ClearGlobalFlag(FIXEDSTRING:flagname)'''

Clears the Global Flag

'''SetFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the Object

'''ClearFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the Object

'''SetUserFlag(CHARACTER:object, FIXEDSTRING:flagname)'''

Sets the Flag on the user's characters

'''ClearUserFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the user's characters

'''SetPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Sets the Flag on the party's characters

'''ClearPartyFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagname)'''

Clears the Flag on the party's characters

'''StartVoiceBark(STRING:barkName, CHARACTER:character)'''

Start a voicebark on character

'''ConfrontationDone(INT: CrimeID, CHARACTER:lead, CHARACTER:criminal, ...)'''

Resolve the crime with id CrimeID for the specified criminals

'''CrimesceneInvestigationDone(CHARACTER:investigator)'''

Crimescene is considered investigated by this NPC, start looking for culprits

'''ListAdd(LIST<OBJECT>:list, OBJECT:entry)'''

Add <entry> at the back of <list>

'''ListRemove(LIST<OBJECT>:list, INT:index)'''

Remove the entry at <index> of <list>

'''ListSet(LIST<OBJECT>:list, INT:index, OBJECT:entry)'''

Set the entry at <index> of <list> to <entry>

'''ListClear(LIST<OBJECT>:list)'''

Remove all entries of <list>

'''EndTurn(CHARACTER|ITEM:Target)'''

Ends the object's current turn

'''SetCanFight(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can fight. Optional for the whole group

'''SetCanJoinCombat(CHARACTER|ITEM:entity, INT:enabled[, INT:wholeGroup=0])'''

Enables/Disables the fact if the entity can join combats. Optional for the whole group

'''SetIsBoss(CHARACTER|ITEM:entity, INT:enabled)'''

Enables/Disables the fact if the entity is a boss.

'''GetAIHintTriggers(OUT LIST<TRIGGER>:triggers[, [LIST]FIXEDSTRING:tags, INT:needsAllTags = -1)'''

Returns all AIHintAreaTriggers in <triggers>. Uses contraints if set.

'''SetCombatTimeout(CHARACTER|ITEM:entity, FLOAT:timer)'''

Overwrites the entity's combat timeout check.

'''ResetCombatTimeout(CHARACTER|ITEM:entity)'''

Resets the entity's combat timeout check.

'''EnterCombat(CHARACTER|ITEM:source, CHARACTER|ITEM:target)'''

Enters combat with target

'''LeaveCombat(CHARACTER|ITEM:source)'''

Leaves the combat

'''SetFaction(CHARACTER|ITEM:target, FIXEDSTRING:faction)'''

Changes the faction of a character or item

'''SetInvulnerable(CHARACTER|ITEM:target, INT:bool)'''

Makes the character or item invulnerable or not. (Allow damage)

'''JumpToTurn(CHARACTER|ITEM:Target)'''

Jumps to targets turn (ends the current turn)

'''Sleep(FLOAT:timeInSeconds)'''

Sleeps for a certain amount of time

'''CharacterAttack(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Moves in weapon range and attacks the target

'''CharacterAttackWithoutMove(CHARACTER|ITEM|FLOAT3:target [,INT:alwaysHit])'''

Attacks the target without checking weaponranges and without moving

'''CharacterMoveTo(GAMEOBJECT|FLOAT3:target, [INT:running=0, INT:shouldArrive=0, INT:longPath=0, FLOAT:minDistance=1.5, FLOAT:maxDistance=minDistance+2.5])'''

Move to the target. Set shouldArrive to 1 if you want a guaranteed move. (teleports on fail)

'''CharacterAiMove(FLOAT3:target, CHARACTER:targetCharacter, ITEM:targetItem)'''

Moves to the target, calculated by the AI. Should only be used with results from the AI!

'''CharacterMoveInRange(GAMEOBJECT|FLOAT3:target, FLOAT:rangeMin, FLOAT:rangeMax, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within a certain range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInWeaponRange(GAMEOBJECT|FLOAT3:target, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within weapon range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveInSkillRange(GAMEOBJECT|FLOAT3:target, SKILL:skill, INT:running, [LIST<TRIGGER>:hintTriggers=null, INT:mustBeInTrigger=0])'''

Move within skill range of target. Optionally pass hinttriggers in which the result is preferred/necessary.

'''CharacterMoveOutOfSight(FLOAT:angle)'''

Move out of screen

'''CharacterPlayAnimation(FIXEDSTRING:animation [, INT:exitOnFinish=1, INT:waitForCompletion=1])'''

Plays a certain animation ExitOnFinish means if the exit will kill itself after it was played (revert back to still)

'''CharacterStopAnimation(-)'''

Stops all animations.

'''CharacterPickUpItem(ITEM:item)'''

Moves close enough to the item if necessary and picks it up

'''CharacterUseItem(ITEM:item [, INTEGER:LongPath])'''

Moves close enough to the item if necessary and uses it

'''CharacterMoveItem(ITEM:item, INTEGER:ignoreWeight, INTEGER:ignoreAPCost [, INTEGER:ignoreDangerousSurfaces=1, INT:amount=-1, GAMEOBJECT|FLOAT3:destination])'''

Moves close enough to the item if necessary and moves it to the destination. Will try to find a destination if not supplied.

'''CharacterAddSkill(CHARACTER:character, SKILL:skill[, INT:ShowNotification=0])'''

Adds <skill> to <character>

'''CharacterRemoveSkill(CHARACTER:character, SKILL:skill)'''

Removes <skill> from <character>

'''CharacterUseSkill(SKILL:skill, GAMEOBJECT|FLOAT3:target [, GAMEOBJECT|FLOAT3:target2, ITEM:skillItem, INT:ignoreHasSkill=0])'''

Cast a skill

'''CharacterAppearAt(GAMEOBJECT|FLOAT3:target, INT:playspawn)'''

Appear at the target

'''CharacterAppearOutOfSightTo(GAMEOBJECT:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players from a certain angle while being able to reach target

'''CharacterAppearOnTrailOutOfSightTo(CHARACTER:target, FLOAT:angle, INT:playspawn)'''

Appears out of sight to the players, on its previous locations, from a certain angle while being able to reach target

'''CharacterDisappear(FLOAT:angle[, INTEGER:isRunning=0])'''

Move out of screen and go of stage, will run if <isRunning> is not 0

'''CharacterSetOffStage(-)'''

Set Off Stage

'''CharacterSetOnStage(-)'''

Set On Stage

'''CharacterLookAt(GAMEOBJECT|FLOAT3|SPLINE:target[, INT:snapToTarget=0, INT:angleTolerance=0])'''

Rotates the character to look at the target (Closest spline point in case of a spline).

'''CharacterLookFrom(GAMEOBJECT|SPLINE:target[, INT:snapToTarget=0])'''

Rotates to the character so it has the same rotation as the target (Closest spline point in case of a spline).

'''CharacterFollow(CHARACTER:target, FLOAT:durationInSeconds, INT:run)'''

Follow the target for a certain time

'''CharacterFollowOwnerOrLeader(FLOAT:durationInSeconds, INT:run)'''

Follow the leader or owner for a certain time

'''CharacterWander(FLOAT|TRIGGER:range, FLOAT:durationInSeconds [, INT:run, GAMEOBJECT:anchor])'''

Wander around for a certain time

'''CharacterSwitchWeaponType(WEAPON:type)'''

If necessary switch to the new weapon type

'''CharacterFleeFrom(RELATION:relation, FLOAT:range)'''

Run away from certain characters if necessary
'''
CharacterFleeFromSurface(SURFACE:surface)'''

Run away from a certain surface if necessary

'''CharacterFleeFromDangerousSurface(-)'''

Run away from a dangerous surfaces if necessary

'''CharacterAddSourcePoints(CHARACTER:character, INT:amount)'''

Adds x source points (x can be negative to substract)

'''CharacterDie(CHARACTER:character[, DEATH:type=DoT])'''

Kills the character

'''CharacterHeal(CHARACTER:character, FLOAT:percentage)'''

Heals the character

'''CharacterConsume(CHARACTER:character, POTION:potion)'''

Makes the character consume a potion. Doesn't cost any AP and will just execute the result of the potion.

'''CharacterDisableAllCrimes(CHARACTER:target)'''

Disables all generic behaviours for <target>.

'''CharacterEnableAllCrimes(CHARACTER:target)'''

Enables all generic behaviours for <target>.
'''
CharacterEnableCrime(CHARACTER:target, STRING:crime, ...)'''

Enables the specified generic behaviours for <target>.

'''CharacterDisableCrime(CHARACTER:target, STRING:crime, ...)'''

Disables the specified generic behaviours for <target>.

'''CharacterSetLongInvestigationDuration(CHARACTER:target)'''

Doubles the time it takes for the investigation to time out. Use this when the character needs to move a long path before investigating.

'''CharacterAiCalculate(-)'''

Calculate the AI of the character

'''CharacterAiStopCalculate(-)'''

Stop the calculation of the AI of the character

'''CharacterAiFinishMoveSkill(-)'''

Finish the current MoveSkill.
'''
CharacterAiAddInterestingItem(CHARACTER:character, ITEM:item)'''

Make it interesting for the AI to destroy that Item

'''CharacterAiRemoveInterestingItem(CHARACTER:character, ITEM:item)'''

Make it no longer interesting for the AI to destroy that Item

'''CharacterSetArchetype(CHARACTER:character, ARCHETYPE:archetype)'''

Sets the archetype of the character, used in AI calculations

'''CharacterSetStoryNPC(CHARACTER:character, INT:bool)'''

Makes the character storyNPC or not.
'''
CharacterAddActionPoints(CHARACTER:character, INT:amount)'''

Give character some action points

'''CharacterSetImmortal(CHARACTER:character, INT:bool)'''

Makes the character immortal or not. (Allow dying)

'''CharacterPlayEffect(CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the character and it follows the character

'''CharacterPlayLoopEffect(OUT INT64:effectHandle, CHARACTER:character, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the character and it follows the character

'''CharacterEvent(CHARACTER:character, STRING:eventName)'''

Throw a character event which you can catch in scripts and story

'''CharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)'''

Throw a character/item event which you can catch in scripts and story

'''CharacterCharacterEvent(CHARACTER:character1, CHARACTER:character2, STRING:eventName)'''

Throw a character/character event which you can catch in scripts and story

'''CharacterSetRelationIndivToIndiv(CHARACTER:source, CHARACTER:target, INT:relation)'''

Changes the relationship between 2 characters.
'''
CharacterForceUpdate(INT:forceUpdate)'''

Makes sure the attached character is always being update or not.
'''
CharacterSetEnemy(CHARACTER:character, CHARACTER:enemy)'''

Sets the current enemy of character

'''CharacterApplyStatus(CHARACTER:character, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the character When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''CharacterRemoveStatus(CHARACTER:character, STATUS:statusId [, STATUS:reasonStatusID=null])'''

Removes the status from the character

'''CharacterDestroy(CHARACTER:character)'''

Destroys the character

'''CharacterSetCanSpotSneakers(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can spot sneaking characters.

'''CharacterSetAttackOfOpportunity(CHARACTER:character, INT:enabled)'''

Enables/Disables the fact if the character can do attack of opportunities.

'''CharacterResurrect(CHARACTER:character [, INT:Percentage = 100])'''

Resurrects the character at [2]% health.

'''CharacterAddToInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount, INT:showInTrade=1])'''

Add the item to the character

'''CharacterRemoveFromInventory(CHARACTER:character, FIXEDSTRING:itemStatsObject[, INT:amount])'''

Remove the item from the character. If Amount is -1, then all are removed

'''CharacterDrinkPotion(FIXEDSTRING:statID)'''

Makes the character drink a potion from the inventory.

'''CharacterSetAnimationOverride(CHARACTER:character, FIXEDSTRING:animation)'''

Sets an animation override, only walk/run/die animations can override it.

'''CharacterUseActionPoints(CHARACTER:character, INT:amount [, OUT INT:succeeded])'''

Uses x action points

'''CharacterAddTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Adds <treasureTable> to the treasure list of <character>

'''CharacterRemoveTreasureTable(CHARACTER:character, FIXEDSTRING:treasureTable)'''

Removes <treasureTable> from the treasure list of <character>

'''CharacterClearTreasureTables(CHARACTER:character)'''

Removes all treasure tables from <character>

'''CharacterSetTemporaryHostileRelation(CHARACTER:character, CHARACTER:otherCharacter)'''

Creates a temporary hostile relation between the 2 characters!

'''CharacterSetFightMode(CHARACTER:character, INT:fight [, INT:force=0])'''

Set the character in sheath/unsheated mode.

'''CharacterSetStats(CHARACTER:character, FIXEDSTRING:statsEntry [, INT:keepVitality=0, INT:keepAP=0, INT:keepLevel=0, OUT FLOAT:currentHP])'''

Applies <statsEntry> from character.xlsm to <character>, returns <currentHP>.

'''CharacterSetWalkSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:walkSpeed])'''

Sets walk speed override of <character>, removes it if <override> is 0

'''CharacterSetRunSpeedOverride(CHARACTER:character, INTEGER:override [, FLOAT:runSpeed])'''

Sets run speed override of <character>, removes it if <override> is 0

'''CharacterSetHasDialog(CHARACTER:character, INTEGER:bool)'''

Enables/Disables the dialog of the character

'''CharacterInitPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStartPatrol(SPLINE:spline, INT:splineIndex, INT:reversed, INT:running)'''

Start patroling from the given index along the given spline with the given character.

'''CharacterStopPatrol(-)'''

Let the character stop patrolling whatever spline he's on!

'''CharacterInterruptPatrol(-)'''

Call when the patrol should interrupt so the guard stops moving to the next spline. If this is called when the character is deactivated, a caret will take his place.

'''CharacterSetAnimationSetOverride(CHARACTER:source, FIXEDSTRING:override)'''

Sets an animation set override for a character. Empty fixedstring clears the override.

'''CharacterSetFloating(CHARACTER:target, INTEGER:isFloating)'''

Sets <target> floating if <isFloating> is not 0

'''CharacterResetCooldowns(CHARACTER:target)'''

Resets the skill cooldowns for <target>

'''ItemEvent(ITEM:item, STRING:eventName)'''

Throw an item event which you can catch in scripts and story

'''ItemPlayAnimation(FIXEDSTRING:animation)'''

Plays an animation on the item

'''ItemPlayAnimationTo(FIXEDSTRING:animation, FLOAT:targetPercentage, [FLOAT:speed])'''

Plays an animation on the item to the target time (percentage of the total duration)

'''ItemPlayEffect(ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays an effect on the item and it follows the item

'''ItemPlayLoopEffect(OUT INT:effectHandle, ITEM:item, STRING:effect [,FIXEDSTRING:boneName])'''

Plays a looping effect on the item and it follows the item

'''ItemSetOnStage(ITEM:item, INTEGER:bool)'''

Sets an item on or offstage

'''ItemSetCanInteract(ITEM:item, INTEGER:bool)'''

Sets an item (not) interactible

'''ItemClose(ITEM:item)'''

Close an item

'''ItemOpen(ITEM:item)'''

Open an item

'''ItemDrop(ITEM:item)'''

Drop an item

'''ItemLock(ITEM:item, FIXEDSTRING:key)'''

Lock an item

'''ItemUnlock(ITEM:item)'''

Unlock an item

'''ItemApplyStatus(ITEM:item, STATUS:statusId [, INT:turns=null, INT:force=0])'''

Applies the status to the item When turns is -1 it's a permanent status When turns is -2 it's a keep alive status (which means it will die if it's not applied again within 1 second)

'''ItemRemoveStatus(ITEM:item, STATUS:statusId)'''

Removes the status from the item

'''ItemDie(ITEM:item)'''

Kills the item

'''ItemMoveTo(GAMEOBJECT|FLOAT3:target, FLOAT:velocity, FLOAT:acceleration, INTEGER:matchTargetRotation)'''

Moves the item to the target

'''ItemToInventory(ITEM:item, CHARACTER|ITEM:target [,INT:amount=-1])'''

Moves the item to the target's inventory

'''ItemLookAt(GAMEOBJECT:target, FLOAT:degreesPerSecond)'''

Rotates the item to look at the target

'''ItemDestroy(ITEM:item)'''

Destroys the item

'''ItemSetAmount(ITEM:item, INT:amount)'''

Change the amount of the item

'''IterateItemsInInventory(CHARACTER|ITEM:source, FIXEDSTRING:eventname[, FIXEDSTRING:tag])'''

Launch iterate event for each iten in source's inventory. If you pass a tag, it has to have that tag.

'''ItemAddCharges(ITEM:TargetItem, INT:charges)'''

Add/subtract charges from an item

'''ItemResetChargesToInitial(ITEM:TargetItem)'''

Resets charges from item to initial state

'''MakePeace(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make peace between users of the characters

'''MakeWar(CHARACTER:Source, CHARACTER:Target[, INT:IgnoreVote = 1])'''

Make war between users of the characters

'''FindSurface(OUT FLOAT3:result, GAMEOBJECT|FLOAT3:source, FLOAT:minRange, FLOAT:maxRange, SURFACE:type [,CHARACTER:alignSource, INT:minEnemiesInSurface, INT:maxAlliesInSurface, INT:minimumCellCount])'''

Finds the closest surface of a specific type.

'''FindValidPosition(INOUT FLOAT3:position, FLOAT:radius[, CHARACTER|ITEM:object=null])'''

Finds the closest valid position (where the object can stand.)

'''FindPosition(INOUT FLOAT3:position, CHARACTER:source, INT:canStand, INT:checkSight, FLOAT:minRadius, FLOAT:maxRadius, FLOAT:rangeCheck, CHARACTER:alignSource, INT:minAllies, INT:maxAllies, INT:minEnemies, INT:maxEnemies [,FIXEDSTRING:AiHintTag=null, INT:forceHint=0, FLOAT3:SourcePosition])'''

Finds the closest position from the source (within radius) where the conditions are matched.

'''Cast(OUT OBJECT variable, OBJECT value)'''

Casts the value to the variable.

'''StringConcatenate(STRING:stringA, STRING:stringB, OUT STRING:resultingString)'''

Appends stringB to stringA. Resulting string is stored in the third parameter.

== QUERIES ==

GetPosition(GAMEOBJECT:object,OUT FLOAT3:src)

Get the current position of an object

GetForwardDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current forward direction of an object

GetRightDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current right direction of an object

GetUpDirection(GAMEOBJECT:object,OUT FLOAT3:direction)

Get the current up direction of an object

GetDirection(GAMEOBJECT|FLOAT3:src,GAMEOBJECT|FLOAT3:target,OUT FLOAT3:direction[, OUT FLOAT:distance])

Get the direction from src to target (optional: returns the distance between the objects as well)

GetRotation(GAMEOBJECT:object, OUT FLOAT3:vector)

Get the rotation of an object

CharacterGetTargetSpline(INT: SplineIndex)

Returns the spline index the character is currently walking towards, or -1 if he is not active on a spline.

IsEqual(OBJECT:variable, OBJECT:variable)

Compares both objects and see if they are equal.

IsLessThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is smaller.

IsGreaterThen(INT|FLOAT:variable, INT|FLOAT:variable)

Compares both objects and see if the first one is bigger.

IsRandom(FLOAT:percentage)

Each time this condition is checked, it will succeed with a chance of the percentage (between 0 and 1)

IsRound(INT:roundNumber)

Checks if we are currently in combat in round x

IsInSurface(OBJECT|FLOAT3:target, SURFACE:type[, FLOAT:radius])

Check if the character, item, trigger or position is currently within the specific surface.

IsInDangerousSurface(OBJECT|FLOAT3:target[, CHARACTER:character, FLOAT:radius])

Check if <target> is currently in on a dangerous surface. Uses <character> for path influences if provided (is necessary with non-character targets)

IsInDialog(CHARACTER|ITEM:target[, INT:ignoreAutomatedDialogs=0])

Check if the character or item is currently in a dialog, optionally ignoring automated dialogs

IsInAutomatedDialog(CHARACTER|ITEM:target)

Check if the character or item is currently in an automated dialog

GetDistance(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)

Returns the distance between 2 positions

GetDistance2D(OUT FLOAT:distance, GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target)
Returns the 2D distance between 2 positions (ignores height)

GetInnerDistance(OUT FLOAT:distance, GAMEOBJECT:source, GAMEOBJECT:target)

Returns the distance between 2 gameobjects (character, item, trigger, ...) Their bounds are already subtracted.

GetPosition(GAMEOBJECT:object, OUT FLOAT3:position)

Returns the position of a gameobject (character, item, trigger, ...)

GetVar(OUT OBJECT:returnValue, CHARACTER|ITEM:target, FIXEDSTRING:varName)

Gets a global variable from the target

GetClosestPlayer(OUT CHARACTER:player, GAMEOBJECT|FLOAT3:source)

Gets the closest player near the source, default being being the object itself

GetPlayerCount(OUT INT:playerCount)

Gets the number of players in the party

GetPlayerByIndex(OUT CHARACTER:returnCharacter, INT:playerIndex)

Gets a player from the party by index

GetRandomCharacter(OUT CHARACTER:returnCharacter, [INT:canBeSelf=0, INT:canBePlayer=0])

Gets a random character in the current level

ContainsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if there is any surface of the type within a radius of the source

IsSurface(GAMEOBJECT|FLOAT3:source, FLOAT:radius, SURFACE:type,)

Checks if the whole radius around the source is the specified surface type

IsObjectOnObject(CHARACTER|ITEM:source,CHARACTER|ITEM:target)

Checks if the source is standing on the target

GetX(FLOAT3:vector, OUT FLOAT:value)

Returns the X component of the vector

GetY(FLOAT3:vector, OUT FLOAT:value)

Returns the Y component of the vector

GetZ(FLOAT3:vector, OUT FLOAT:value)

Returns the Z component of the vector

CanSee(GAMEOBJECT|FLOAT3:source, GAMEOBJECT|FLOAT3:target[, INT:addProjectileTargetGroundOffset=0])

Check if the sight is blocked between 2 points.

IsVisible(CHARACTER|ITEM:object)

Check if the object is set invisible or not with SetVisible.

GetTextDuration(CHARACTER|ITEM:object, FIXEDSRTING:key, OUT FLOAT:duration)

Gets how long a text needs to be displayed

IsCasual(-)

Returns if the current game mode is Casual

IsHardcore(-)

Returns if the current game mode is Hardcore

IsTagged(GAMEOBJECT:object, FIXEDSTRING:tag)

Check if the object is tagged.

TranslatedStringKeyExists(FIXEDSTRING:key)

Check if the TranslatedString key exists.

IsInCombat(CHARACTER|ITEM:object)

Returns true if the object is in combat.

IsInCombatWith(CHARACTER|ITEM:object, CHARACTER|ITEM:object)

Returns true if the objects are in combat with each other.

IsFacing(GAMEOBJECT:source, GAMEOBJECT|FLOAT3:target, [INT:angle=90])

Returns true if the object is facing the position within the given angle.

GameIsSaving(-)

Returns true if the game is saving.

GameIsLoading(-)

Returns true if the game is loading.

GetUserCount(OUT INT:userCount)

Returns the user count.

GetCurrentCharacter(OUT CHARACTER:character, INT:user)

Returns the character currently being controlled by the specified user.

GetCurrentLevel(OUT FIXEDSTRING:currentLevel)

Returns the current levelname

GetAIBounds(CHARACTER|ITEM:source, OUT FLOAT:bounds)

Returns AI bounds of <source> in <bounds>

HasGlobalFlag(FIXEDSTRING:flagName)

Returns if the Global Flag is set

HasFlag(CHARACTER|ITEM:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the Object

HasUserFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the user's characters

HasPartyFlag(CHARACTER:object, FIXEDSTRING:flagName)

Returns if the Flag is set on the party's characters

DialogExists(STRING:dialogue)

Returns true if the dialogue exists.

IsActive(CHARACTER|ITEM:Object)

Returns if the character or item is currently active.

ListGetSize(LIST<OBJECT>:list, out INT:size)

Returns the number of elements in <list>

ListGet(LIST<OBJECT>:list, INT:index, out OBJECT:entry)

Returns <entry> at <index> of <list>

ListGetRandom(LIST<OBJECT>:list, out OBJECT:entry)

Returns a random <entry> of <list>

IsBoss(CHARACTER|ITEM:Object)

Returns true if the entity is tagged as a boss

IsProjectileSkill(SKILL:skill)

Returns true if the skill is a ranged skill (uses a projectile)

IsValidSkillTarget(CHARACTER:source, OBJECT|FLOAT3:target, SKILLID:skill[, INTEGER:ignoreRangeCheck=0])

Checks whether <target> is a valid target for <skill> at <source>

GetFaction(OUT FIXEDSTRING:faction, CHARACTER|ITEM:character)

Returns the faction of the provided character or item

IsInActiveTurn(CHARACTER|ITEM:target)

Returns true if it's the character's or item's turn in combat.

IsSkillActive(CHARACTER:character, SKILL:skillId)

Returns true if <character> has <skillId> active (in memory).

HasSkillAi(SKILLID:skillId)

Returns true if the skill is using the new Ai system

IsInArena(CHARACTER::character)

Returns true if the character is in an arena fight

CrimeGetType(INTEGER:crimeId, OUT STRING:crimeType)

Returns the type of the crime with this id.

CrimeGetCriminals(INTEGER:crimeId, OUT CHARACTER:criminal1, OUT CHARACTER:criminal2, OUT CHARACTER:criminal3, OUT CHARACTER:criminal4)

Returns the criminals of that crime. They might all be null.

IsSourceSkill(SKILL:skill)

Returns true if the skill is a source skill.

IsInGameMasterMode(-)

Returns true if the game in game master mode.

CharacterGet(OUT CHARACTER:character, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo, COMPAREFUNC:compareFunc[, RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf, FIXEDSTRING:tag])

Get a character within a certain range conforming to the filled in restraints.

CharacterCount(OUT INT:count, GAMEOBJECT|FLOAT3:src, FLOAT:range, [RELATION: relation, SURFACE:surface, STATUS:status, TALENT:talent, CHARACTER:inSightOf])

Counts the characters within a certain range conforming to the filled in restraints.

CharacterGetOwner(OUT CHARACTER:owner, CHARACTER:source)

Get the character's owner

CharacterGetFollow(OUT CHARACTER:to follow, CHARACTER:source)

Get the character to follow

CharacterGetEnemy(OUT CHARACTER:current enemy, CHARACTER:source)

Get current enemy of character

CharacterCanCast(CHARACTER:source, SKILL:skillId, [ITEM:skillItem=null, INT:ignoreActionPoints=0])

Check if the character source can cast the skill: will check cooldown, actionpoints

CharacterCanSitOnItem(CHARACTER:source, ITEM:item)

Check if the character source can sit or lie on an item.

CharacterCanDrinkPotion(CHARACTER:source, FIXEDSTRING:potionID[, INT:ignoreActionPoints=0])

Check if the character source can drink the potion: will check inv and actionpoints

CharacterCanUseItem(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in the world

CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])

Check if the character source can use the item in his inventory

CharacterCanSee(CHARACTER:watchingChar, CHARACTER|ITEM:target [, INT:forceUpdate=0])

Check if character has target in his line of sight.

CharacterCanShoot(CHARACTER:source, GAMEOBJECT|FLOAT3:target)

Check if the character can shoot the target.

CharacterIsPlayer(CHARACTER:character)

Check if the character is a player

CharacterIsInParty(CHARACTER:character)

Check if the character is in the party

CharacterIsEnemy(CHARACTER:source, CHARACTER:target)

Check if target is enemy of source

CharacterIsAlly(CHARACTER:source, CHARACTER:target)

Check if target is ally of source

CharacterIsNeutral(CHARACTER:source, CHARACTER:target)

Check if target is neutral of source

CharacterIsDead(CHARACTER:character)

Check if character is dead

CharacterIsMoving(CHARACTER:character)

Check if character is moving (speed > 0)

CharacterIsSummon(CHARACTER:character)

Check if character is a summon

CharacterIsPartyFollower(CHARACTER:character)

Check if character is a party follower

CharacterIsStoryNPC(CHARACTER:character)

Check if character is a story NPC

CharacterInWeaponRange(CHARACTER:character, CHARACTER:target)

Check if target is in the current's weapon range

CharacterInTouchRange(CHARACTER:character, CHARACTER:targetChar)

Check if target is in the character's touch range

CharacterHasStatus(CHARACTER:character, STATUS:statusId[, FIXEDSTRING:extraData])

Check if character currently has the status. ExtraData can be filled in for some statuses: - Consume: statsid of the item - Shield: skillid of the shield

CharacterGetStatusSourceCharacter(CHARACTER:character, STATUS:statusId, OUT CHARACTER:source[, FIXEDSTRING:extraData])

Get the source character of a status

CharacterGetStatusSourceItem(CHARACTER:character, STATUS:statusId, OUT ITEM:source[, FIXEDSTRING:extraData])

Get the source item of a status

CharacterHasTalent(CHARACTER:character, TALENT:talent)

Check if character currently has the talent

CharacterHasSkill(CHARACTER:character, SKILL:skillId)

Check if character currently has the skill

CharacterHasWeaponType(CHARACTER:character, WEAPON:weaponTYPE [, INT:equipped])

Check if character currently has a weapon of this type in his inventory or equipped

CharacterGetStat(OUT FLOAT:statValue, CHARACTER:character, CHARACTERSTAT:statType)

Returns the current value of the stat (Vitality, ...)

CharacterGetSightRange(OUT FLOAT:range, CHARACTER:character)

Returns the character's sight range

CharacterGetWeaponRange(OUT FLOAT:minRange, OUT FLOAT:maxRange, CHARACTER:character)

Returns the character's current weapon range

CharacterGetTouchRange(OUT FLOAT:touchRange, CHARACTER:character)

Returns the character's current touch range

CharacterGetSkillRange(OUT FLOAT:minRange, OUT FLOAT:maxRange,CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterGetSkillImpactRange(OUT FLOAT:areaRange, CHARACTER:character, SKILL:skillId)

Returns the character's skill range

CharacterIsInTrigger(CHARACTER:character, TRIGGER:trigger)

Check if character is in given trigger

CharacterGetAbility(OUT INT:value, CHARACTER:character, ABILITY:ability)

Returns the character's value of the specified ability

CharacterGetHostileCount(OUT INT:value, CHARACTER:character)

Returns how many characters are targeting this character right now... You can iterate over them with IterateEnemiesOf.

CharacterCanFight(CHARACTER:character)

Returns true if the character can fight.

CharacterGetTemplate(CHARACTER:character, OUT CHARACTERTEMPLATE:root)

Returns the roottemplate of the character.

CharacterCanSpotSneakers(CHARACTER:character)

Returns true if the character can spot sneaking characters

CharacterIsFloating(CHARACTER:character)

Check if character is a floating character

CharacterInCreation(CHARACTER:character)

Returns true if the character is in character creation

CharacterAvoidsTraps(CHARACTER:character)

Returns true if the character avoids traps

CharacterCheckRelation(CHARACTER:character, RELATION:relation)

Returns true if relation check succeeds

CharacterIsBetterOrEqualClass(CHARACTER:character, INT:currentScore, OUT INT:newScore, INT warriorScore, INT rogueScore, INT mageScore, INT clericScore, INT rangerScore)

Returns true if score is higher or equal than the current score

CharacterHasBeenHitBy(CHARACTER:character, DAMAGE_TYPE:damageType)

Returns true if the character was hit by this type.

CharacterHasCastedSpellLastTurn(CHARACTER:character)

Returns true if the character has casted a spell in his last turn.

CharacterHasHadStatus(CHARACTER:character, STATUS:status)

Returns true if the character has had a specific status this combat.

CharacterHasAnimationOverride(CHARACTER:character)

Returns true if the character has an animation override.

CharacterCanUnlock(CHARACTER:character, ITEM:item)

Returns true if the character can unlock the item (if the item is already unlocked it returns true!)

CharacterGetReservedUserID(OUT INT:user, CHARACTER:character)

Returns the character's reserved User id.

CharacterGetRace(CHARACTER:character, OUT FIXEDSTRING:race)

Returns the <character>'s race in <race>.

CharacterIsRace(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character>'s race is <race>.

CharacterCanMoveItem(CHARACTER:character, ITEM:item, FLOAT:minRadius, FLOAT:maxRadius [, OUT FLOAT3:destination])

Returns true + <destination> if <character> can move <item> somewhere between <minRadius> and <maxRadius>.

CharacterGetDeathType(CHARACTER:character, OUT FIXEDSTRING:deathType)

Returns death type of <character> in <deathType>.

CharacterGetStillAnimation(CHARACTER:object, OUT FIXEDSTRING:stillAnimation)

Returns the still animation to play

CrimeTransferLeadership(INT: CrimeID[, FIXEDSTRING:Tag1,...])

Try and transfer the leadership of this crime to someone else.

CrimeGetLeadInvestigator(OUT CHARACTER:lead, INT: CrimeID)

Returns the lead investigator for the crime.

CharacterCanHitTargetWithRangedWeapon(CHARACTER:source, OBJECT|FLOAT3:target[, SKILL:skill = null])

Returns true if <source> can hit <target> with currently equipped ranged weapon. Will use <skill> instead of equipped weapon if provided.

CharacterHasRangedWeapon(CHARACTER:character[, INT:checkInventory = 0])

Returns true if <character> has has ranged weapon. Checks for non-wielded weapons if <checkInventory> is 1

CheckInteractionReach(CHARACTER:character, CHARACTER|ITEM: target)

Returns true if <character> could interact with <target>. This is not checking ranges, but checking if there's too much of a height difference or too many obstacles in between.

CharacterGetSourcePoints(CHARACTER:character, OUT INT: amount)

Returns the amount of sourcepoints of <character>.

CharacterAiIsCalculating(-)

Returns if the character is still calculating the AI.

CharacterAiFetchMoveSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3:target)

Returns if the character has a Move Skill command to execute according to the AI.

CharacterAiFetchSkillCommand(OUT SKILL:skill, OUT ITEM:skillItem, OUT FLOAT3 endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target, OUT FLOAT3:target2, OUT CHARACTER:target2, OUT ITEM:target)

Returns if the character has a Skill command to execute according to the AI.

CharacterAiFetchConsumeCommand(OUT ITEM:item)

Returns if the character has a Consume command to execute according to the AI.

CharacterAiFetchAttackCommand(OUT FLOAT3:endPosition, OUT FLOAT3:target, OUT CHARACTER:target, OUT ITEM:target)

Returns if the character has a Attack command to execute according to the AI.

CharacterAiFetchFallbackCommand(OUT FLOAT3:targetPosition, OUT FLOAT3:lookAtPosition)

Returns if the character has a Fallback command to execute according to the AI.

CharacterGetArchetype(CHARACTER:character, OUT ARCHETYPE:archetype)

Returns the archetype of the character.

CharacterIsPolymorphedInto(CHARACTER:character, FIXEDSTRING:race)

Returns true if <character> is polymorphed into <race>. Race can be a race (like HUMAN), but also a template (in case of a polymorph skill like Chicken Touch).

CharacterIsPolymorphInteractionDisabled(CHARACTER:character)

Returns true if <character> has his interaction disabled because of a polymorph.

ItemGet(OUT ITEM:item, GAMEOBJECT|FLOAT3:src, FLOAT:range, COMPARE:howTo [, COMPAREFUNC:compareFunc, FIXEDSTRING:rootTemplate, FIXEDSTRING:tag])

Get an item within a certain range conforming to the filled in restraints.

ItemGetFromInventory(OUT ITEM:item, CHARACTER|ITEM:object [, FIXEDSTRING:statsId, FIXEDSTRING:tag, INT:isEquiped])

Returns the first item in the inventory conforming to the filled in restraints.

ItemIsInCharacterInventory(ITEM:item, CHARACTER:object)

Returns if the item is in the inventory of the character

ItemIsInTrigger(ITEM:item, TRIGGER:trigger)

Check if item is in given trigger

ItemGetStat(OUT FLOAT:statValue, ITEM:item, ITEMSTAT:statType)

Returns the current value of the stat (Weight, ...)

ItemIsMoving(ITEM:item)

Returns if the item is moving or not.

ItemIsFalling(ITEM:item)

Returns if the item is falling or not. (after teleport)

ItemIsOpening(ITEM:item)

Returns if the item is opening or not.

ItemIsClosing(ITEM:item)

Returns if the item is closing or not.

ItemIsLocked(ITEM:item)

Returns if the item is locked or not.

ItemIsMovable(ITEM:item)

Returns if the item is movable or not.

ItemCanBeLockPicked(ITEM:item)

Returns if the item is can be opened by lockpicking.

ItemIsOpen(ITEM:item)

Returns if the item is open or not.

IsStoryItem(ITEM:item)

Returns if the item is a story item.

ItemHasStatus(ITEM:item, STATUS:statusId)

Returns if the item has the status.

ItemIsDestroyed(ITEM:item)

Returns if the item is destroyed.

ItemGetTemplate(ITEM:item, OUT ITEMTEMPLATE:root)

Returns the roottemplate of the item.

ItemGetSkillId(ITEM:item, OUT SKILL:root)

Returns the skillid of the item if it has one.

ItemGetItemType(ITEM:item, OUT FIXEDSTRING:itemType)

Returns the itemtype of the item: common, unique, rare, ...

ItemGetStatusSourceCharacter(ITEM:item, STATUS:statusId, OUT CHARACTER:source)

Get the source character of a status

ItemGetStatusSourceItem(ITEM:item, STATUS:statusId, OUT ITEM:source)

Get the source item of a status

ItemCanBeMoved(ITEM:item)

Returns if the item can be moved.

== EVENTS ==

OnCharacterEvent(CHARACTER:character, STRING:eventName)

Thrown from scripts or story

OnCharacterItemEvent(CHARACTER:character, ITEM:item, STRING:eventName)
Thrown from scripts or story

OnCharacterCharacterEvent(CHARACTER:character, CHARACTER:character, STRING:eventName)

Thrown from scripts or story

OnItemEvent(ITEM:item, STRING:eventName)
Thrown from scripts or story

OnItemDestroyed(ITEM:item)

Thrown when an item is destroyed

OnItemDestroying(ITEM:item)
Thrown when an item is being destroyed

OnItemOpened(ITEM:item)

Thrown when an item is opened

OnItemClosed(ITEM:item)
Thrown when an item is closed

OnItemDropped(ITEM:item, STRING:itemTemplate)

Thrown when an item is dropped

OnGlobalFlagSet(FIXEDSTRING:eventName)
Thrown when a global event is set

OnGlobalFlagCleared(FIXEDSTRING:eventName)

Thrown when a global event is cleared

OnCharacterFlagSet(FIXEDSTRING:eventName, CHARACTER:character)
Thrown when a dialog event is set on a character

OnCharacterFlagCleared(FIXEDSTRING:eventName, CHARACTER:character)

Thrown when a dialog event is cleared on a character

OnItemFlagSet(FIXEDSTRING:eventName, ITEM:item)
Thrown when a dialog event is set on an item

OItemFlagCleared(FIXEDSTRING:eventName, ITEM:item)

Thrown when a dialog event is cleared on an item

OnTimer(FIXEDSTRING:timerName)
Thrown when a timer has ended

OnInit(-)

Thrown when the script is set

OnLoaded(INT:major, INT:minor, INT:revision, INT:build)

Thrown when the script is loaded from the savegame

OnShutdown(-)

Thrown when the character's script is removed

OnVariableCleared(FIXEDSTRING:varName)

Thrown when this object's script variable is cleared from Osiris with ClearVarObject

OnCombatStarted(CHARACTER:source, ITEM:source)

Thrown when the character entered a combat

OnCombatSwitched(CHARACTER:source, ITEM:source)

Thrown when the character switch from one combat to another

OnCombatEnded(CHARACTER:source, ITEM:source)

Thrown when the character left the combat

OnTurn(CHARACTER:source, ITEM:source)

Thrown when the character's turn starts

OnTurnEnded(CHARACTER:source, ITEM:source)

Thrown when the character's turn ended

OnCharacterVitalityChanged(CHARACTER:character, FLOAT:percentage)

Thrown when the characters's vitality changed

OnItemVitalityChanged(ITEM:item, FLOAT:percentage)

Thrown when the item's vitality changed

OnAttackOfOpportunity(CHARACTER:target)

Thrown when the characters gets an attack of opportunity on an enemy

OnDamage(DAMAGE:type, FLOAT:percentage, CHARACTER:source, ITEM:source)

Thrown when the object receives damage

OnMiss(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)

Thrown when the character dodges something

OnCriticalHit(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)

Thrown when the character is critical hit

OnBlock(CHARACTER:source, ITEM:source, CHARACTER:target, ITEM:target)

Thrown when the character blocks something

OnDie(CHARACTER:character, DAMAGE:type, CHARACTER:source, ITEM:source)

Thrown when the character dies

OnCharacterStatusAttempt(CHARACTER:character, STATUS:status)

Thrown when the character attempts to gain a status

OnCharacterStatusApplied(CHARACTER:character, STATUS:status)

Thrown when the character gains a status

OnCharacterStatusRemoved(CHARACTER:character, STATUS:status)

Thrown when the character loses a status

OnItemStatusAttempt(ITEM:item, STATUS:status)

Thrown when the item attempts to gain a status

OnItemStatus(ITEM:item, STATUS:status)

Thrown when the item gains a status

OnItemStatusRemoved(ITEM:item, STATUS:status)

Thrown when the item loses a status

OnStatusCreateVisuals(STATUS:status)

Thrown when the item should create the visuals for this status

OnStatusDestroyVisuals(STATUS:status)

Thrown when the item should destroy the visuals for this status

OnSight(CHARACTER:character)

Thrown when the character sees another character

OnLostSight(CHARACTER:character)

Thrown when the character doesn't see another character anymore

OnUseItem(CHARACTER:source, ITEM:item)

Thrown when a character uses an item

OnPickupItem(CHARACTER:source, ITEM:item)

Thrown when a character picks up an item

OnCharacterMovedItem(CHARACTER:source, ITEM:item)

Thrown when a character moved an item

OnItemEquipped(CHARACTER:source, ITEM:item)

Thrown when a character equips an item

OnItemUnequipped(CHARACTER:source, ITEM:item)

Thrown when a character unequips an item

OnIterateCharacter(CHARACTER:character, FIXEDSTRING:eventId)

Thrown by iterators

OnIterateItem(ITEM:source, FIXEDSTRING:eventId)

Thrown by iterators

OnIterateCount(FIXEDSTRING:eventId, INTEGER:Count)

Thrown by iterators after all iterations to inform you of the count.

OnStoryOverride(-)

Throw when story overrides what the character was doing: teleport, movement, on/offstage

OnTriggerEnter(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)

Thrown by a character or item entering an EventTrigger

OnTriggerLeave(CHARACTER:character, ITEM:item, FIXEDSTRING:eventId)

Thrown by a character or item leaving an EventTrigger

OnEnemyChanged(CHARACTER:character, CHARACTER:newEnemy)

Thrown when the character's currentenemy changes

OnTalentUnlocked(CHARACTER:character, TALENT:newTalent)

Thrown when the character unlocks a new talent

OnCharacterClassChanged(CHARACTER:character, FIXEDSTRING:class)

Thrown when the character changes class in the character creation screen

OnCharacterCreationStarted(CHARACTER:character, TRIGGER:creationPoint)

Thrown when the character creation has started, and gives where the character should walk to

OnCharacterCreationStopped(CHARACTER:character)

Thrown when the character creation has stopped

OnFunction(FIXEDSTRING:functionName)

Throws an event on itself with the functionName. This is to fake function calls

OnSkillCast(CHARACTER:character, SKILL_ID:skillID)

Thrown when the character casts a skill

OnSkillCombatComment(CHARACTER:character, SKILL_ID:skillID)

Thrown when the character needs to make a comment

OnCharacterUsedSkillOnMe(CHARACTER:character, SKILL_ID:skillID)

Thrown when you are hit by a skill from a character

OnItemUnlocked(ITEM: item, CHARACTER:character, ITEM:key)

Thrown when an item gets unlocked by a character.

OnAutomatedDialogEnded(STRING:dialogName, INT:instanceID)

Thrown when a automated dialog is ended for this speaker

OnAutomatedDialogStarted(STRING:dialogName, INT:instanceID)

Thrown when a automated dialog is started for this speaker

OnDialogEnded(STRING:dialogName, INT:instanceID)

Thrown when a dialog is ended for this speaker

OnCrimeSensibleAction(INT:IsPrimary; FIXEDSTRING:regionID, INT:crimeID, FIXEDSTRING:reactionName, STRING:primaryDialog, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4)

Thrown when a character needs to perform a sensible action against criminals

OnCrimeInterrogationRequest(FIXEDSTRING:regionID, INT:crimeID, CHARACTER:criminal1, CHARACTER:criminal2, CHARACTER:criminal3, CHARACTER:criminal4)

Thrown when a character needs to perform an interrogation against criminals

OnCrimeInvestigate(INT:crimeID; FLOAT3:CrimePosition)

One NPC investigates a crimescene

OnCrimeAlarmed(INT:crimeID; FLOAT3:CrimePosition)

All NPCs in a crimearea start looking around.

OnCrimeReturnToNormal(-)

Investigation or Alarm timed out.

OnCrimeAborted(-)

The game interrupted the sensible action of this NPC.

OnSplineControlPointReached(INT:Index, INT:EndReached, STRING:EventString)

Thrown when a character reached a spline node.

OnFinishCalculationAi(-)

Thrown when the calculation of the AI is finished.

OnGrenadeLand(INT:hitObstacle, CHARACTER:caster)

Thrown when the grenades lands

FetchCharacterApplyStatusData(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns; CHARACTER:character, STATUS:status)

Fetch from script which statuses to remove and apply.

FetchItemApplyStatusData(LIST<STATUS>:removeStatuses, STATUS:applyStatus, INT:turns; ITEM:item, STATUS:status)

Fetch from script which statuses to remove and apply.

FetchItemSkillOnDamage(INT:hasSkill, SKILL_ID:skillID, INT:casterLevel; INT:damage, DAMAGE_TYPE:damageType)

Fetch from script what skill to execute on damage.

'''OnActivate(-)'''

Thrown when a character/item activates

'''OnDeactivate(-)'''

Thrown when a character/item deactivates

'''OnCharacterUsedSourcePoint(CHARACTER:character)'''

Thrown when a character uses a source point

'''OnSkillAdded(CHARACTER:character, SKILL_ID:skillId, INT:learned)'''

Thrown when a character learns a skill

'''OnSkillActivated(CHARACTER:character, SKILL_ID:skillId)'''

Thrown when a character activates (=adds to memory) a skill

'''OnSkillDeactivated(CHARACTER:character, SKILL_ID:skillId)'''

Thrown when a character deactivates (=removes from memory) a skill

'''OnItemFlagShared(FIXEDSTRING:eventName, ITEM:item, INT:newValue)'''

Thrown when a dialog event is shared with an item

'''OnCharacterFlagShared(FIXEDSTRING:eventName, CHARACTER:character, INT:newValue)'''

Thrown when a dialog event is shared with a character

'''OnItemOffStageChanged(CHARACTER:character, INT:offstage)'''

Thrown when a character is set on/off stage

'''OnCharacterOffStageChanged(ITEM:item, INT:offstage)'''

Thrown when a item is set on/off stage

'''OnCharacterTeleported(CHARACTER:target, CHARACTER:cause, FLOAT3:oldPosition, FLOAT3:newPosition, SKILL_ID:skillId)'''

Thrown when a character gets teleported with a teleport skill

'''OnCombatTick(-)'''

Thrown when this object ticks in combat. Only thrown for objects that don't get a turn.

== INTERRUPTS ==

'''OnMovementFailed(FLOAT3:targetPos)'''

Thrown when the reaction is interrupted by a move action failing

'''OnException(-)'''

Thrown when the reaction is interrupted by an exception

'''OnBetterReactionFound(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted by another reaction

'''OnNoReactionFound(-)'''

Thrown when the reaction is interrupted because no reaction is valid

'''OnScriptDisabled(-)'''

Thrown when the reaction is interrupted because the scriptcontroller is disabled

'''OnManualInterrupt(FIXEDSTRING:reactionName)'''

Thrown when the reaction is interrupted using the interrupt action

'''OnRegionSwap(FIXEDSTRING:oldLevel, FIXEDSTRING:newLevel)'''

Thrown when the reaction is interrupted by a region swap

Scripting surface transform types

2018-03-01T10:41:16Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following surface transform types can be used in script:
<ul>
<li>None</li>
<li>Ignite</li>
<li>Bless</li>
<li>Purify</li>
<li>Curse</li>
<li>Electrify</li>
<li>Melt</li>
<li>Freeze</li>
<li>Condense</li>
<li>Vaporize</li>
<li>Bloodify</li>
<li>Contaminate</li>
<li>Oilify</li>
<li>Shatter</li>
</ul>

CombatAi Archetypes And Modifiers

2018-03-01T10:40:50Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following archetypes already exist in D:OS2 and can have their modifiers overridden:
<ul>
<li>base</li>
<li>berserker</li>
<li>bomber</li>
<li>healer</li>
<li>mage</li>
<li>melee</li>
<li>ranged</li>
<li>ranger</li>
<li>rogue</li>
<li>warrior</li>
</ul>

The following table lists all modifiers, their default value in the base archetype, and a short desciption on how their used. More information on the italic terms and a basic explanation on how scores work for Ai can be found [[Combat_AI#How_does_it_work|here]]:
{| class="wikitable"
|-
! Modifier !! Base Value !! Description
|-
| SCORE_MOD || 100.0 || A general modifier that you probably shouldn't change, but you're welcome to try
|-
| MULTIPLIER_DAMAGE_SELF_POS || 1.0 || Damage score on self that's considered positive (e.g. when removing the Burning status, which 'removes' damage)
|-
| MULTIPLIER_DAMAGE_SELF_NEG || 1.0 || Damage score on self that's considered negative (this is just damage)
|-
| MULTIPLIER_DAMAGE_ENEMY_POS || 1.0 || Same as MULTIPLIER_DAMAGE_SELF_POS, but for enemies (this is just damage)
|-
| MULTIPLIER_DAMAGE_ENEMY_NEG || 1.0 || Same as MULTIPLIER_DAMAGE_SELF_NEG, but for enemies (e.g. when removing the Burning status, which 'removes' damage)
|-
| MULTIPLIER_DAMAGE_ALLY_POS || 1.0 || Same as MULTIPLIER_DAMAGE_SELF_POS, but for allies
|-
| MULTIPLIER_DAMAGE_ALLY_NEG || 1.5 || Same as MULTIPLIER_DAMAGE_SELF_NEG, but for allies
|-
| MULTIPLIER_DAMAGE_NEUTRAL_POS || 1.0 || Same as MULTIPLIER_DAMAGE_SELF_POS, but for neutrals
|-
| MULTIPLIER_DAMAGE_NEUTRAL_NEG || 1.0 || Same as MULTIPLIER_DAMAGE_SELF_NEG, but for neutrals
|-
| MULTIPLIER_HEAL_SELF_POS || 1.0 || Healing score on self that's considered positive (this is just healing)
|-
| MULTIPLIER_HEAL_SELF_NEG || 1.0 || Healing score on self that's considered negative (e.g. when removing the Restoration status, which 'removes' healing)
|-
| MULTIPLIER_HEAL_ENEMY_POS || 1.0 || Same as MULTIPLIER_HEAL_SELF_POS, but for enemies (e.g. when removing the Restoration status, which 'removes' healing)
|-
| MULTIPLIER_HEAL_ENEMY_NEG || 1.0 || Same as MULTIPLIER_HEAL_SELF_NEG, but for enemies (this is just healing)
|-
| MULTIPLIER_HEAL_ALLY_POS || 1.0 || Same as MULTIPLIER_HEAL_SELF_POS, but for allies
|-
| MULTIPLIER_HEAL_ALLY_NEG || 1.0 || Same as MULTIPLIER_HEAL_SELF_NEG, but for allies
|-
| MULTIPLIER_HEAL_NEUTRAL_POS || 1.0 || Same as MULTIPLIER_HEAL_SELF_POS, but for neutrals
|-
| MULTIPLIER_HEAL_NEUTRAL_NEG || 1.0 || Same as MULTIPLIER_HEAL_SELF_NEG, but for neutrals
|-
| MULTIPLIER_DOT_SELF_POS || 1.0 || Same as MULTIPLIER_DAMAGE_SELF_POS, but for damage over time
|-
| MULTIPLIER_DOT_SELF_NEG || 1.0 || Same as MULTIPLIER_DAMAGE_SELF_NEG, but for damage over time
|-
| MULTIPLIER_DOT_ENEMY_POS || 1.0 || Same as MULTIPLIER_DAMAGE_ENEMY_POS, but for damage over time
|-
| MULTIPLIER_DOT_ENEMY_NEG || 1.0 || Same as MULTIPLIER_DAMAGE_ENEMY_NEG, but for damage over time
|-
| MULTIPLIER_DOT_ALLY_POS || 1.0 || Same as MULTIPLIER_DAMAGE_ALLY_POS, but for damage over time
|-
| MULTIPLIER_DOT_ALLY_NEG || 1.0 || Same as MULTIPLIER_DAMAGE_ALLY_NEG, but for damage over time
|-
| MULTIPLIER_DOT_NEUTRAL_POS || 1.0 || Same as MULTIPLIER_NEUTRAL_SELF_POS, but for damage over time
|-
| MULTIPLIER_DOT_NEUTRAL_NEG || 1.0 || Same as MULTIPLIER_NEUTRAL_SELF_NEG, but for damage over time
|-
| MULTIPLIER_HOT_SELF_POS || 1.0 || Same as MULTIPLIER_HEAL_SELF_POS, but for healing over time
|-
| MULTIPLIER_HOT_SELF_NEG || 1.0 || Same as MULTIPLIER_HEAL_SELF_NEG, but for healing over time
|-
| MULTIPLIER_HOT_ENEMY_POS || 1.0 || Same as MULTIPLIER_HEAL_ENEMY_POS, but for healing over time
|-
| MULTIPLIER_HOT_ENEMY_NEG || 1.0 || Same as MULTIPLIER_HEAL_ENEMY_NEG, but for healing over time
|-
| MULTIPLIER_HOT_ALLY_POS || 1.0 || Same as MULTIPLIER_HEAL_ALLY_POS, but for healing over time
|-
| MULTIPLIER_HOT_ALLY_NEG || 1.0 || Same as MULTIPLIER_HEAL_ALLY_NEG, but for healing over time
|-
| MULTIPLIER_HOT_NEUTRAL_POS || 1.0 || Same as MULTIPLIER_NEUTRAL_SELF_POS, but for healing over time
|-
| MULTIPLIER_HOT_NEUTRAL_NEG || 1.0 || Same as MULTIPLIER_NEUTRAL_SELF_NEG, but for healing over time
|-
| MULTIPLIER_CONTROL_SELF_POS || 1.0 || Control score on self that's considered positive. Control score comes from the statuses KnockedDown, Blind, ShacklesOfPain, Fear, Charmed, Incapacitated, and any Consume status that makes you lose control. (e.g. removing KnockedDown)
|-
| MULTIPLIER_CONTROL_SELF_NEG || 2.0 || Control score on self that's considered negative. (e.g. applying KnockedDown)
|-
| MULTIPLIER_CONTROL_ENEMY_POS || 1.0 || Same as MULTIPLIER_CONTROL_SELF_POS, but for enemies (e.g. applying KnockedDown)
|-
| MULTIPLIER_CONTROL_ENEMY_NEG || 1.0 || Same as MULTIPLIER_CONTROL_SELF_NEG, but for enemies (e.g. removing KnockedDown)
|-
| MULTIPLIER_CONTROL_ALLY_POS || 1.0 || Same as MULTIPLIER_CONTROL_SELF_POS, but for allies
|-
| MULTIPLIER_CONTROL_ALLY_NEG || 2.0 || Same as MULTIPLIER_CONTROL_SELF_NEG, but for allies
|-
| MULTIPLIER_CONTROL_NEUTRAL_POS || 1.0 || Same as MULTIPLIER_CONTROL_SELF_POS, but for neutrals
|-
| MULTIPLIER_CONTROL_NEUTRAL_NEG || 1.0 || Same as MULTIPLIER_CONTROL_SELF_NEG, but for neutrals
|-
| MULTIPLIER_BOOST_SELF_POS || 1.0 || Boost score on self that's considered positive (e.g. buffs like resistance increase)
|-
| MULTIPLIER_BOOST_SELF_NEG || 1.0 || Boost score on self that's considered negative (e.g. debuffs like a intelligence penalty)
|-
| MULTIPLIER_BOOST_ENEMY_POS || 1.0 || Same as MULTIPLIER_BOOST_ENEMY_POS, but for enemies (e.g. debuffs like a intelligence penalty)
|-
| MULTIPLIER_BOOST_ENEMY_NEG || 1.0 || Same as MULTIPLIER_BOOST_ENEMY_NEG, but for enemies (e.g. buffs like resistance increase)
|-
| MULTIPLIER_BOOST_ALLY_POS || 1.0 || Same as MULTIPLIER_BOOST_ALLY_POS, but for allies
|-
| MULTIPLIER_BOOST_ALLY_NEG || 1.0 || Same as MULTIPLIER_BOOST_ALLY_NEG, but for allies
|-
| MULTIPLIER_BOOST_NEUTRAL_POS || 1.0 || Same as MULTIPLIER_BOOST_NEUTRAL_POS, but for neutrals
|-
| MULTIPLIER_BOOST_NEUTRAL_NEG || 1.0 || Same as MULTIPLIER_BOOST_NEUTRAL_NEG, but for neutrals
|-
| MULTIPLIER_ARMOR_SELF_POS || 0.75 || Armor (both physical and magical) score on self that's considered positive (e.g. when removing the Acid status, which 'removes' armor damage)
|-
| MULTIPLIER_ARMOR_SELF_NEG || 0.75 || Armor score on self that's considered negative (this is just armor damage)
|-
| MULTIPLIER_ARMOR_ENEMY_POS || 0.75 || Same as MULTIPLIER_ARMOR_ENEMY_POS, but for enemies (this is just armor damage)
|-
| MULTIPLIER_ARMOR_ENEMY_NEG || 0.75 || Same as MULTIPLIER_ARMOR_ENEMY_NEG, but for enemies (e.g. when removing the Acid status, which 'removes' armor damage)
|-
| MULTIPLIER_ARMOR_ALLY_POS || 0.75 || Same as MULTIPLIER_ARMOR_ALLY_POS, but for allies
|-
| MULTIPLIER_ARMOR_ALLY_NEG || 1.50 || Same as MULTIPLIER_ARMOR_ALLY_NEG, but for allies
|-
| MULTIPLIER_ARMOR_NEUTRAL_POS || 0.75 || Same as MULTIPLIER_ARMOR_NEUTRAL_POS, but for neutrals
|-
| MULTIPLIER_ARMOR_NEUTRAL_NEG || 0.75 || Same as MULTIPLIER_ARMOR_NEUTRAL_NEG, but for neutrals
|-
| MULTIPLIER_FREE_ACTION || 0.25 || The 'final' score of an action (combined score of damage, heal, dot, hot, armor, boost, and control) is multiplied by a CostModifier and divided by an ActionCostModifier. If an action is free (meaning 0 AP) the ActionCostModifier will be equal to MULTIPLIER_FREE_ACTION
|-
| MULTIPLIER_ACTION_COST_MULTIPLIER || 1.00 || Used in the ActionCostModifier explained in MULTIPLIER_FREE_ACTION. MULTIPLIER_ACTION_COST_MULTIPLIER is multiplied with the AP cost of the action itself and added to the ActionCostModifier
|-
| MULTIPLIER_MOVEMENT_COST_MULTPLIER || 0.90 || Used in the ActionCostModifier explained in MULTIPLIER_FREE_ACTION. MULTIPLIER_MOVEMENT_COST_MULTIPLIER is multiplied with the AP cost of the movement needed to execute the action and added to the ActionCostModifier
|-
| MULTIPLIER_INVISIBLE_MOVEMENT_COST_MULTPLIER || 0.30 || If the player is sneaking or invisible this modifier is used on top of MULTIPLIER_MOVEMENT_COST_MULTIPLIER
|-
| MULTIPLIER_SOURCE_COST_MULTIPLIER || 1.00 || Used in the ActionCostModifier explained in MULTIPLIER_FREE_ACTION. MULTIPLIER_SOURCE_COST_MULTIPLIER is multiplied with the SP cost of the action itself and added to the ActionCostModifier
|-
| MULTIPLIER_COOLDOWN_MULTIPLIER || 0.01 || Used in the CostModifier explained in MULTIPLIER_FREE_ACTION. MULTIPLIER_COOLDOWN_MULTIPLIER is used in combination with the cooldown of the action and a higher MULTIPLIER_COOLDOWN_MULTIPLIER results in a lower CostModifier
|-
| MULTIPLIER_LOW_ITEM_AMOUNT_MULTIPLIER || 0.45 || Used in the CostModifier explained in MULTIPLIER_FREE_ACTION. MULTIPLIER_LOW_ITEM_AMOUNT_MULTIPLIER is used in combination with MULTIPLIER_HIGH_ITEM_AMOUNT_MULTIPLIER and we lerp between the LOW and HIGH value based on the health of the source character before multiplying it with the CostModifier. This way we make sure that lower health characters are more likely to use items
|-
| MULTIPLIER_HIGH_ITEM_AMOUNT_MULTIPLIER || 1.00 || See MULTIPLIER_LOW_ITEM_AMOUNT_MULTIPLIER
|-
| MULTIPLIER_CANNOT_EXECUTE_THIS_TURN || 0.50 || Used in the CostModifier explained in MULTIPLIER_FREE_ACTION. MULTIPLIER_CANNOT_EXECUTE_THIS_TURN is multiplied with the CostModifier if the action can not be executed this turn
|-
| MULTIPLIER_TARGET_MY_ENEMY || 1.50 || Used whtn the target of the action is attacking the source character
|-
| MULTIPLIER_TARGET_MY_HOSTILE || 3.00 || Used when the target of the action is already under attack by the source character
|-
| MULTIPLIER_TARGET_SUMMON || 0.35 || Used when the target is a summon
|-
| MULTIPLIER_TARGET_AGGRO_MARKED || 5.00 || Used when the target has the status AggroMarked
|-
| MULTIPLIER_TARGET_HOSTILE_COUNT_ONE || 0.50 || Used when the target already is under attack by another character
|-
| MULTIPLIER_TARGET_HOSTILE_COUNT_TWO_OR_MORE || 0.25 || Used when the target already is under attack by 2 or more characters
|-
| MULTIPLIER_TARGET_IN_SIGHT || 1.05 || Used when the target is in sight from the current position of the source character
|-
| MULTIPLIER_TARGET_INCAPACITATED || 0.20 || Used when the character is incapacitated (e.g. due to Frozen status)
|-
| MULTIPLIER_TARGET_KNOCKED_DOWN || 1.25 || Used when the character has the KnockedDown status. Replaces MULTIPLIER_TARGET_INCAPACITATED (because KnockedDown is also incapacitates)
|-
| MULTIPLIER_TARGET_PREFERRED || 20.00 || Used when the target has the AI_PREFERRED_TARGET tag
|-
| MULTIPLIER_TARGET_UNPREFERRED || 0.20 || Used when the target has the AI_UNPREFERRED_TARGET tag
|-
| ENDPOS_NEARBY_DISTANCE || 6.00 || The maximum distance that's considered to be 'nearby'. Is used in combination with several other modifiers
|-
| MULTIPLIER_ENDPOS_ALLIES_NEARBY || 0.00 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_ALLIES_NEARBY is multiplied with the amount of allies nearby (defined by ENDPOS_NEARBY_DISTANCE) and added to the PositionScore
|-
| MULTIPLIER_ENDPOS_ENEMIES_NEARBY || 0.00 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_ENEMIES_NEARBY is multiplied with the amount of enemies nearby (defined by ENDPOS_NEARBY_DISTANCE) and added to the PositionScore
|-
| MULTIPLIER_ENDPOS_STENCH || 0.25 || Used when the target has the Stench talen
|-
| MULTIPLIER_ENDPOS_FLANKED || 0.05 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_FLANKED is multiplied with the amount of characters that would flank the source character and added to the PositionScore
|-
| MULTIPLIER_ENDPOS_HEIGHT_DIFFERENCE || 0.002 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_HEIGHT_DIFFERENCE is multiplied with the height difference between the current and the new position and added to the PositionScore
|-
| MULTIPLIER_ENDPOS_TURNED_INVISIBLE || 0.01 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_TURNED_INVISIBLE is used when invisible for the difference between the old and new position and substracted from the PositionScore (going invisible and not moving is bad)
|-
| MULTIPLIER_ENDPOS_NOT_IN_AIHINT || 0.01 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_NOT_IN_AIHINT is substracted from the PositionScore if it's not in an AiHint (and if it's not forced, because then the action would be completely aborted)
|-
| MULTIPLIER_ENDPOS_NOT_IN_SMOKE || 0.00 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_NOT_IN_SMOKE is added the the PositionScore when the position is not inside a smoke surface
|-
| MULTIPLIER_ENDPOS_NOT_IN_DANGEROUS_SURFACE || 0.10 || Used when calculating the PositionScore. MULTIPLIER_ENDPOS_NOT_IN_DANGEROUS_SURFACE is added the the PositionScore when the position is inside a dangerous surface that has positive effects (e.g. when you heal from a poison surface)
|-
| DANGEROUS_ITEM_NEARBY || 0.00 || Used when calculating the PositionScore. DANGEROUS_ITEM_NEARBY is multiplied by all dangerous items (e.g. barrels) nearby (defined by ENDPOS_NEARBY_DISTANCE) and added to the PositionScore
|-
| FALLBACK_ALLIES_NEARBY || 0.00 || Replaces MULTIPLIER_ENDPOS_ALLIES_NEARBY when calculating the PositionScore for the fallback action
|-
| FALLBACK_ENEMIES_NEARBY || 0.00 || Replaces MULTIPLIER_ENDPOS_ENEMIES_NEARBY when calculating the PositionScore for the fallback action
|-
| FALLBACK_WANTED_ENEMY_DISTANCE || 5.00 || The distance the source character will try to create when it has to use its fallback action
|-
| MOVESKILL_AP_DIFF_REQUIREMENT || 2.00 || The minimum amount of AP the source character can save if it uses a jump/teleport skill instead of walking to its target position
|-
| MOVESKILL_ITEM_AP_DIFF_REQUIREMENT || 3.00 || The minimum amount of AP the source character can save if it uses a jump/teleport skill by item instead of walking to its target position
|-
| MULTIPLIER_SCORE_ON_NEUTRAL || -0.1 || The target multiplier for neutral targets
|-
| MULTIPLIER_SCORE_ON_ALLY || -1.10 || The target multiplier for allied targets
|-
| MULTIPLIER_SCORE_OUT_OF_COMBAT || 0.25 || The target multiplier for targets that are not part of the source character's combat
|-
| MAX_SCORE_ON_NEUTRAL || 0.00 || Not used at the time of writing
|-
| MAX_HEAL_MULTIPLIER || 0.50 || A multiplier to determine the importance of healing someone that's close to dying. Has to be in between 0.00 and 1.00
|-
| MAX_HEAL_SELF_MULTIPLIER || 1.00 || A multiplier to determine the importance of healing self when close to dying. Has to be in between 0.00 and 1.00
|-
| MULTIPLIER_VITALITYBOOST || 0.50 || Used for vitality boosts gained by statuses or potions
|-
| MULTIPLIER_DAMAGEBOOST || 0.50 || Used for damage boosts gained by statuses or potions
|-
| MULTIPLIER_BONUS_WEAPON_BOOST || 0.50 || Used for bonus weapon boosts gained by statuses or potions
|-
| MULTIPLIER_ARMORBOOST || 0.50 || Used for armor boosts gained by statuses or potions
|-
| MULTIPLIER_KILL_ENEMY || 2.50 || Target multiplier used when an enemy target will die due to the action
|-
| MULTIPLIER_KILL_ENEMY_SUMMON || 1.10 || Target multiplier used when an enemy summon target will die due to the action
|-
| MULTIPLIER_KILL_ALLY || 1.50 || Target multiplier used when an allied target will die due to the action
|-
| MULTIPLIER_KILL_ALLY_SUMMON || 1.10 || Target multiplier used when an alied summon target will die due to the action
|-
| MULTIPLIER_EXPLOSION_DISTANCE_MIN || 0.50 || Not used at the time of writing
|-
| MULTIPLIER_SURFACE_STATUS_ON_MOVE || 0.75 || Multiplier used by scores that are caused by surfaces, but only if a character moves
|-
| SURFACE_DAMAGE_MAX_TURNS || 2.00 || Maximum amount of turns Ai takes into account for damage caused by surfaces
|-
| MULTIPLIER_STATUS_REMOVE || 1.00 || Multiplier used for the score caused by status removal
|-
| MULTIPLIER_STATUS_FAILED || 0.50 || Multiplier used for the score that a status would have had if it would apply. This score is then added to the MinimumScore
|-
| MULTIPLIER_STATUS_CANCEL_INVISIBILITY || 0.50 || Multiplier used when an action cancels the Invisibility status that the source character has. The score of the Invisibility status is calculated and multiplied with MULTIPLIER_STATUS_CANCEL_INVISIBILITY
|-
| MULTIPLIER_STATUS_CANCEL_SLEEPING || 0.50 || Multiplier used when an action cancels the Sleeping status that the source character has. The score of the Sleeping status is calculated and multiplied with MULTIPLIER_STATUS_CANCEL_SLEEPING
|-
| MULTIPLIER_STATUS_OVERWRITE || 0.50 || Multiplier used for the score that a status would have had if we don't overwrite it. This score is then added to the MinimumScore
|-
| MULTIPLIER_LOSE_CONTROL || 1.00 || Multiplier used for consume statuses that make the target lose control
|-
| MULTIPLIER_INCAPACITATE || 1.25 || Multiplier used for Incapacitated statuses
|-
| MULTIPLIER_KNOCKDOWN || 1.75 || Multiplier used for Knockdown status
|-
| MULTIPLIER_CHARMED || 2.50 || Multiplier used for Charmed status
|-
| MULTIPLIER_FEAR || 1.00 || Multiplier used for the Fear status
|-
| MULTIPLIER_BLIND || 0.80 || Multiplier used for the Blind status
|-
| MULTIPLIER_INVISIBLE || 0.20 || Multiplier used for the Invisible status
|-
| MULTIPLIER_MUTE || 0.80 || Multiplier used for the Mute status
|-
| MULTIPLIER_SOURCE_MUTE || 4.00 || Multiplier used for the SourceMute status
|-
| MULTIPLIER_SHACKLES_OF_PAIN || 0.50 || Multiplier used for the ShacklesOfPain status
|-
| MULTIPLIER_HEAL_SHARING || 0.50 || Multiplier used for the HealSharing status
|-
| MULTIPLIER_DECAYING_TOUCH || 0.75 || Multiplier used for the DecayingTouch status
|-
| MULTIPLIER_DISARMED || 0.80 || Multiplier used for the Disarmed status
|-
| MULTIPLIER_WINDWALKER || 0.50 || Multiplier used for the Windwalker status
|-
| MULTIPLIER_GUARDIAN_ANGEL || 0.20 || Multiplier used for the GuardianAngel status
|-
| MULTIPLIER_ACTIVE_DEFENSE || 1.00 || Multiplier used for the ActiveDefense status
|-
| MULTIPLIER_SPARK || 0.40 || Multiplier used for the Spark status
|-
| MULTIPLIER_DAMAGE_ON_MOVE || 10.00 || Multiplier used for the DamageOnMove status
|-
| MULTIPLIER_DEATH_RESIST || 4.00 || Multiplier used for Consume statuses with IsResistingDeath property
|-
| MULTIPLIER_RESURRECT || 4.00 || Multiplier used for the resurrect property in skills
|-
| SKILL_JUMP_MINIMUM_DISTANCE || 8.00 || Minimum distance a character has to jump to use the skill
|-
| SKILL_TELEPORT_MINIMUM_DISTANCE || 6.00 || Minimum distance an object has to be teleported to use the skill
|-
| MULTIPLIER_ADD_ARMOR || 0.50 || Multiplier that's removed from the boost score if we're trying to add physical armor when it's already full
|-
| MULTIPLIER_ADD_MAGIC_ARMOR || 0.50 || Multiplier that's removed from the boost score if we're trying to add magical armor when it's already full
|-
| MULTIPLIER_REMOVE_ARMOR || 0.50 || Multiplier that's added to the boost score if we're completely removing physical armor
|-
| MULTIPLIER_REMOVE_MAGIC_ARMOR || 0.50 || Multiplier that's added to the boost score if we're completely removing magical armor
|-
| MULTIPLIER_SURFACE_REMOVE || 0.35 || Multiplier used for scores of surfaces that get removed
|-
| MULTIPLIER_DESTROY_INTERESTING_ITEM || 0.50 || Multiplier added to the score when destroying an interesting item (e.g. an oil barrel)
|-
| MULTIPLIER_CRITICAL || 1.00 || Used for critical boosts gained by statuses or potions
|-
| MULTIPLIER_ACC_BOOST || 0.25 || Used for accuracy boosts gained by statuses or potions
|-
| MULTIPLIER_DODGE_BOOST || 0.80 || Used for dodge boosts gained by statuses or potions
|-
| MULTIPLIER_MOVEMENT_BOOST || 0.30 || Used for movement boosts gained by statuses or potions
|-
| MULTIPLIER_RESISTANCE || 0.80 || Used for resistance boosts gained by statuses or potions
|-
| MULTIPLIER_AP_RECOVERY || 1.20 || Used for ap recovery boosts gained by statuses or potions
|-
| MULTIPLIER_AP_BOOST || 0.60 || Used for ap boosts gained by statuses or potions
|-
| MULTIPLIER_AP_MAX || 0.10 || Used for ap max boosts gained by statuses or potions
|-
| MULTIPLIER_AP_COSTBOOST || 2.00 || Used for ap cost boosts gained by statuses or potions
|-
| MULTIPLIER_SOURCE_POINT || 0.75 || Used for sp boosts gained by statuses or potions
|-
| MULTIPLIER_SP_COSTBOOST || 2.00 || Used for sp cost boosts gained by statuses or potions
|-
| MULTIPLIER_MAIN_ATTRIB || 1.00 || Used for attribute boosts gained by statuses or potions, if that attribute is the highest attribute of the character
|-
| MULTIPLIER_SECONDARY_ATTRIB || 0.50 || Used for attribute boosts gained by statuses or potions, if that attribute is not the highest attribute of the character
|-
| MULTIPLIER_CONTACT_BOOST || 0.50 || Used for contact boosts gained by statuses or potions (freeze on contact, poison on contact, ...)
|-
| MIN_TURNS_SCORE_EXISTING_STATUS || 1 || The minimum amount of turns used when calculating the score of an existing status (could be 0, but still exist)
|-
| TURNS_REPLACEMENT_INFINITE || 5 || If anything is applied/removed with an infinite turn amount it is replaced with TURNS_REPLACEMENT_INFINITE
|-
| MULTIPLIER_PUDDLE_RADIUS || 1.00 || Not used at the time of writing
|-
| MULTIPLIER_COMBO_SCORE_INTERACTION || 0.90 || Multiplier used for possible surface interaction scores (we place water -> could be electrified)
|-
| MULTIPLIER_COMBO_SCORE_POSITIONING || 0.00 || Same as MULTIPLIER_COMBO_SCORE_INTERACTION, but for calculating the PositionScore
|-
| MULTIPLIER_POSITION_LEAVE || -1.00 || Modifier used for jump and teleportation skills for the PositionScore of the position we're leaving
|-
| MULTIPLIER_GROUNDED || -0.05 || Used for grounded attribute gained by statuses or potions
|-
| MULTIPLIER_DEFLECT_PROJECTILES || 0.20 || Used for deflect projectiles attribute gained by statuses or potions
|-
| MULTIPLIER_SUMMON_PATH_INFLUENCES || 0.04 || Used when calculate the score of a summon position (e.g. when a summon has doesn't like fire surfaces due to path influences)
|-
| BUFF_DIST_MAX || 30.0 || Maximum distance at which Ai will use buffs. The score of buffs is lerped based on the distance between BUFF_DIST_MIN and BUFF_DIST_MAX
|-
| BUFF_DIST_MIN || 10.0 || See BUFF_DIST_MAX
|-
| MULTIPLIER_POS_SECONDARY_SURFACE || 0.25 || Multiplier for positive surface scores on allies that are secondary. E.g. blessed surface on an ally that's caused by a placed fire surface that's connected to a blessed surface.
|-
| ENABLE_ACTIVE_DEFENSE_OFFENSIVE_USE || 0 || When != 0 Ai will use the ActiveDefense skill in an offensive way (e.g. just target it in the middle of a group of enemies)
|-
| ENABLE_SAVING_ACTION_POINTS || 1 || When != 0 Ai will move less to save AP if it can't execute an attack anyways
|-
| MULTIPLIER_SHIELD_BLOCK || 1.00 || Multiplier used to determine how important it is that a target has a shield with a chance to block
|-
| MULTIPLIER_REFLECT_DAMAGE || 0.25 || Multiplier used for damage that's reflected due to retribution
|}

Scripting death types

2018-03-01T10:40:14Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following death types can be used in script:
<ul>
<li>None</li>
<li>Physical</li>
<li>Piercing</li>
<li>Arrow</li>
<li>DoT</li>
<li>Incinerate</li>
<li>Acid</li>
<li>Electrocution</li>
<li>FrozenShatter</li>
<li>PetrifiedShatter</li>
<li>Explode</li>
<li>Surrender</li>
<li>Hang</li>
<li>KnockedDown</li>
<li>Lifetime</li>
</ul>

Scripting ability types

2018-03-01T10:40:05Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following ability types can be used in script:
<ul>
<li>WarriorLore</li>
<li>RangerLore</li>
<li>RogueLore</li>
<li>SingleHanded</li>
<li>TwoHanded</li>
<li>Reflection</li>
<li>Ranged</li>
<li>Shield</li>
<li>Reflexes</li>
<li>PhysicalArmorMastery</li>
<li>MagicArmorMastery</li>
<li>VitalityMastery</li>
<li>Sourcery</li>
<li>Telekinesis</li>
<li>FireSpecialist</li>
<li>WaterSpecialist</li>
<li>AirSpecialist</li>
<li>EarthSpecialist</li>
<li>Necromancy</li>
<li>Summoning</li>
<li>Polymorph</li>
<li>Repair</li>
<li>Sneaking</li>
<li>Pickpocket</li>
<li>Thievery</li>
<li>Loremaster</li>
<li>Crafting</li>
<li>Barter</li>
<li>Charm</li>
<li>Intimidate</li>
<li>Reason</li>
<li>Charisma</li>
<li>Leadership</li>
<li>Luck</li>
<li>DualWielding</li>
<li>Wand</li>
<li>Perseverance</li>
<li>Runecrafting</li>
<li>Brewmaster</li>
</ul>

Scripting compare functions

2018-03-01T10:39:48Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following compare functions can be used in script:
<ul>
<li>Distance</li>
<li>Level</li>
<li>Vitality</li>
<li>VitalityPoints</li>
<li>Magic</li>
<li>MagicPoints</li>
<li>ActionPoints</li>
<li>APMaximum</li>
<li>APStart</li>
<li>APRecovery</li>
<li>Experience</li>
<li>Reputation</li>
<li>Karma</li>
<li>Strength</li>
<li>Finesse</li>
<li>Intelligence</li>
<li>Constitution</li>
<li>Memory</li>
<li>Wits</li>
<li>TrapWits</li>
<li>Movement</li>
<li>FireResistance</li>
<li>EarthResistance</li>
<li>WaterResistance</li>
<li>AirResistance</li>
<li>PoisonResistance</li>
<li>PiercingResistance</li>
<li>PhysicalResistance</li>
<li>CorrosiveResistance</li>
<li>MagicResistance</li>
<li>ShadowResistance</li>
<li>Sight</li>
<li>Hearing</li>
<li>Initiative</li>
<li>Armor</li>
<li>ArmorPoints</li>
<li>GoldValue</li>
</ul>

Scripting compare types

2018-03-01T10:39:37Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following compare types can be used in script:
<ul>
<li>Highest</li>
<li>Lowest</li>
<li>Random</li>
</ul>

Scripting talent types

2018-03-01T10:39:25Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following talent types can be used in script:
<ul>
<li>ItemMovement</li>
<li>ItemCreation</li>
<li>Flanking</li>
<li>AttackOfOpportunity</li>
<li>Backstab</li>
<li>Trade</li>
<li>Lockpick</li>
<li>ChanceToHitRanged</li>
<li>ChanceToHitMelee</li>
<li>Damage</li>
<li>ActionPoints</li>
<li>ActionPoints2</li>
<li>Criticals</li>
<li>IncreasedArmor</li>
<li>Sight</li>
<li>ResistFear</li>
<li>ResistKnockdown</li>
<li>ResistStun</li>
<li>ResistPoison</li>
<li>ResistSilence</li>
<li>ResistDead</li>
<li>Carry</li>
<li>Throwing</li>
<li>Repair</li>
<li>ExpGain</li>
<li>ExtraStatPoints</li>
<li>ExtraSkillPoints</li>
<li>Durability</li>
<li>Awareness</li>
<li>Vitality</li>
<li>FireSpells</li>
<li>WaterSpells</li>
<li>AirSpells</li>
<li>EarthSpells</li>
<li>Charm</li>
<li>Intimidate</li>
<li>Reason</li>
<li>Luck</li>
<li>Initiative</li>
<li>InventoryAccess</li>
<li>AvoidDetection</li>
<li>AnimalEmpathy</li>
<li>Escapist</li>
<li>StandYourGround</li>
<li>SurpriseAttack</li>
<li>LightStep</li>
<li>ResurrectToFullHealth</li>
<li>Scientist</li>
<li>Raistlin</li>
<li>MrKnowItAll</li>
<li>WhatARush</li>
<li>FaroutDude</li>
<li>Leech</li>
<li>ElementalAffinity</li>
<li>FiveStarRestaurant</li>
<li>Bully</li>
<li>ElementalRanger</li>
<li>LightningRod</li>
<li>Politician</li>
<li>WeatherProof</li>
<li>LoneWolf</li>
<li>Zombie</li>
<li>Demon</li>
<li>IceKing</li>
<li>Courageous</li>
<li>GoldenMage</li>
<li>WalkItOff</li>
<li>FolkDancer</li>
<li>SpillNoBlood</li>
<li>Stench</li>
<li>Kickstarter</li>
<li>WarriorLoreNaturalArmor</li>
<li>WarriorLoreNaturalHealth</li>
<li>WarriorLoreNaturalResistance</li>
<li>RangerLoreArrowRecover</li>
<li>RangerLoreEvasionBonus</li>
<li>RangerLoreRangedAPBonus</li>
<li>RogueLoreDaggerAPBonus</li>
<li>RogueLoreDaggerBackStab</li>
<li>RogueLoreMovementBonus</li>
<li>RogueLoreHoldResistance</li>
<li>NoAttackOfOpportunity</li>
<li>WarriorLoreGrenadeRange</li>
<li>RogueLoreGrenadePrecision</li>
<li>WandCharge</li>
<li>DualWieldingDodging</li>
<li>Human_Inventive</li>
<li>Human_Civil</li>
<li>Dwarf_Sneaking</li>
<li>Dwarf_Sturdy</li>
<li>Elf_CorpseEating</li>
<li>Elf_Lore</li>
<li>Lizard_Persuasion</li>
<li>Lizard_Resistance</li>
<li>Perfectionist</li>
<li>Executioner</li>
<li>ViolentMagic</li>
<li>QuickStep</li>
<li>Quest_SpidersKiss_Str</li>
<li>Quest_SpidersKiss_Int</li>
<li>Quest_SpidersKiss_Per</li>
<li>Quest_SpidersKiss_Null</li>
<li>Memory</li>
<li>BeastMaster</li>
<li>LivingArmor</li>
<li>Torturer</li>
<li>Ambidextrous</li>
<li>Unstable</li>
<li>Quest_TradeSecrets</li>
<li>Quest_GhostTree</li>
<li>ResurrectExtraHealth</li>
<li>NaturalConductor</li>
<li>Quest_Rooted</li>
</ul>

Scripting damage types

2018-03-01T10:39:11Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following damage types can be used in script:
<ul>
<li>Physical</li>
<li>Piercing</li>
<li>Corrosive</li>
<li>Magic</li>
<li>Chaos</li>
<li>Shadow</li>
<li>Fire</li>
<li>Air</li>
<li>Water</li>
<li>Earth</li>
<li>Poison</li>
</ul>

Scripting weapon types

2018-03-01T10:38:55Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following weapon types can be used in script:
<ul>
<li>None</li>
<li>Sword</li>
<li>Club</li>
<li>Axe</li>
<li>Staff</li>
<li>Bow</li>
<li>Crossbow</li>
<li>Spear</li>
<li>Knife</li>
<li>Wand</li>
<li>Arrow</li>
</ul>

Scripting itemstat types

2018-03-01T10:38:39Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following itemstat types can be used in script:
<ul>
<li>Weight</li>
<li>Value</li>
<li>Vitality</li>
<li>VitalityPoints</li>
</ul>

Scripting characterstat types

2018-03-01T10:38:21Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following characterstat types can be used in script:
<ul>
<li>Level</li>
<li>Vitality</li>
<li>VitalityPoints</li>
<li>VitalityMax</li>
<li>Magic</li>
<li>MagicPoints</li>
<li>ActionPoints</li>
<li>APMaximum</li>
<li>APStart</li>
<li>APRecovery</li>
<li>Experience</li>
<li>Reputation</li>
<li>Karma</li>
<li>Strength</li>
<li>Finesse</li>
<li>Intelligence</li>
<li>Constitution</li>
<li>Memory</li>
<li>Wits</li>
<li>TrapWits</li>
<li>Movement</li>
<li>FireResistance</li>
<li>EarthResistance</li>
<li>WaterResistance</li>
<li>AirResistance</li>
<li>PoisonResistance</li>
<li>PiercingResistance</li>
<li>PhysicalResistance</li>
<li>CorrosiveResistance</li>
<li>MagicResistance</li>
<li>ShadowResistance</li>
<li>Sight</li>
<li>Hearing</li>
<li>Initiative</li>
<li>Weight</li>
<li>TrapDetection</li>
<li>Willpower</li>
<li>Bodybuilding</li>
<li>PhysicalArmor</li>
<li>MagicArmor</li>
<li>PhysicalArmorPoints</li>
<li>MagicArmorPoints</li>
</ul>

Scripting status types

2018-03-01T10:38:05Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following status types can be used in script:
<ul>
<li>HIT</li>
<li>DYING</li>
<li>HEAL</li>
<li>MUTED</li>
<li>CHARMED</li>
<li>KNOCKED_DOWN</li>
<li>SUMMONING</li>
<li>HEALING</li>
<li>THROWN</li>
<li>SHIELD</li>
<li>TELEPORT_FALLING</li>
<li>CONSUME</li>
<li>COMBAT</li>
<li>AOO</li>
<li>STORY_FROZEN</li>
<li>SNEAKING</li>
<li>UNLOCK</li>
<li>FEAR</li>
<li>BOOST</li>
<li>UNSHEATHED</li>
<li>STANCE</li>
<li>SITTING</li>
<li>LYING</li>
<li>BLIND</li>
<li>SMELLY</li>
<li>CLEAN</li>
<li>INFECTIOUS_DISEASED</li>
<li>INVISIBLE</li>
<li>ROTATE</li>
<li>ENCUMBERED</li>
<li>IDENTIFY</li>
<li>REPAIR</li>
<li>MATERIAL</li>
<li>LEADERSHIP</li>
<li>EXPLODE</li>
<li>ADRENALINE</li>
<li>SHACKLES_OF_PAIN</li>
<li>SHACKLES_OF_PAIN_CASTER</li>
<li>WIND_WALKER</li>
<li>DARK_AVENGER</li>
<li>REMORSE</li>
<li>DECAYING_TOUCH</li>
<li>UNHEALABLE</li>
<li>FLANKED</li>
<li>CHANNELING</li>
<li>DRAIN</li>
<li>LINGERING_WOUNDS</li>
<li>INFUSED</li>
<li>SPIRIT_VISION</li>
<li>SPIRIT</li>
<li>DAMAGE</li>
<li>FORCE_MOVE</li>
<li>CLIMBING</li>
<li>INCAPACITATED</li>
<li>INSURFACE</li>
<li>SOURCE_MUTED</li>
<li>OVERPOWER</li>
<li>COMBUSTION</li>
<li>POLYMORPHED</li>
<li>DAMAGE_ON_MOVE</li>
<li>DEMONIC_BARGAIN</li>
<li>GUARDIAN_ANGEL</li>
<li>THICK_OF_THE_FIGHT</li>
<li>FLOATING</li>
<li>CHALLENGE</li>
<li>DISARMED</li>
<li>HEAL_SHARING</li>
<li>HEAL_SHARING_CASTER</li>
<li>EXTRA_TURN</li>
<li>ACTIVE_DEFENSE</li>
<li>SPARK</li>
<li>PLAY_DEAD</li>
<li>CONSTRAINED</li>
<li>EFFECT</li>
<li>DEACTIVATED</li>
</ul>

Scripting surface types

2018-03-01T10:37:37Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following surface types can be used in behavior scripts:
<ul>
<li>SurfaceNone</li>
<li>SurfaceFire</li>
<li>SurfaceFireBlessed</li>
<li>SurfaceFireCursed</li>
<li>SurfaceFirePurified</li>
<li>SurfaceWater</li>
<li>SurfaceWaterElectrified</li>
<li>SurfaceWaterFrozen</li>
<li>SurfaceWaterBlessed</li>
<li>SurfaceWaterElectrifiedBlessed</li>
<li>SurfaceWaterFrozenBlessed</li>
<li>SurfaceWaterCursed</li>
<li>SurfaceWaterElectrifiedCursed</li>
<li>SurfaceWaterFrozenCursed</li>
<li>SurfaceWaterPurified</li>
<li>SurfaceWaterElectrifiedPurified</li>
<li>SurfaceWaterFrozenPurified</li>
<li>SurfaceBlood</li>
<li>SurfaceBloodElectrified</li>
<li>SurfaceBloodFrozen</li>
<li>SurfaceBloodBlessed</li>
<li>SurfaceBloodElectrifiedBlessed</li>
<li>SurfaceBloodFrozenBlessed</li>
<li>SurfaceBloodCursed</li>
<li>SurfaceBloodElectrifiedCursed</li>
<li>SurfaceBloodFrozenCursed</li>
<li>SurfaceBloodPurified</li>
<li>SurfaceBloodElectrifiedPurified</li>
<li>SurfaceBloodFrozenPurified</li>
<li>SurfacePoison</li>
<li>SurfacePoisonBlessed</li>
<li>SurfacePoisonCursed</li>
<li>SurfacePoisonPurified</li>
<li>SurfaceOil</li>
<li>SurfaceOilBlessed</li>
<li>SurfaceOilCursed</li>
<li>SurfaceOilPurified</li>
<li>SurfaceLava</li>
<li>SurfaceSource</li>
<li>SurfaceWeb</li>
<li>SurfaceWebBlessed</li>
<li>SurfaceWebCursed</li>
<li>SurfaceWebPurified</li>
<li>SurfaceDeepwater</li>
<li>SurfaceFireCloud</li>
<li>SurfaceFireCloudBlessed</li>
<li>SurfaceFireCloudCursed</li>
<li>SurfaceFireCloudPurified</li>
<li>SurfaceWaterCloud</li>
<li>SurfaceWaterCloudElectrified</li>
<li>SurfaceWaterCloudBlessed</li>
<li>SurfaceWaterCloudElectrifiedBlessed</li>
<li>SurfaceWaterCloudCursed</li>
<li>SurfaceWaterCloudElectrifiedCursed</li>
<li>SurfaceWaterCloudPurified</li>
<li>SurfaceWaterCloudElectrifiedPurified</li>
<li>SurfaceBloodCloud</li>
<li>SurfaceBloodCloudElectrified</li>
<li>SurfaceBloodCloudBlessed</li>
<li>SurfaceBloodCloudElectrifiedBlessed</li>
<li>SurfaceBloodCloudCursed</li>
<li>SurfaceBloodCloudElectrifiedCursed</li>
<li>SurfaceBloodCloudPurified</li>
<li>SurfaceBloodCloudElectrifiedPurified</li>
<li>SurfacePoisonCloud</li>
<li>SurfacePoisonCloudBlessed</li>
<li>SurfacePoisonCloudCursed</li>
<li>SurfacePoisonCloudPurified</li>
<li>SurfaceSmokeCloud</li>
<li>SurfaceSmokeCloudBlessed</li>
<li>SurfaceSmokeCloudCursed</li>
<li>SurfaceSmokeCloudPurified</li>
<li>SurfaceExplosionCloud</li>
<li>SurfaceFrostCloud</li>
<li>SurfaceDeathfogCloud</li>
</ul>

Scripting relation types

2018-03-01T10:37:12Z

Rimevan:

This list is purely for values that can be used in script. More information on these values can be found [[Scripting#Variables|here]]. 
The following relation types can be used in behavior scripts:
<ul>
<li>Unknown</li>
<li>Ally</li>
<li>Enemy</li>
<li>Neutral</li>
<li>Player</li>
<li>Multiplayer</li>
<li>Party</li>
<li>PlayersNoSummon</li>
<li>All</li>
</ul>

Combat AI

2018-02-20T15:05:30Z

Rimevan: /* Skill overrides */

=Introduction=
Ai 2.0 or, as we'd like to call it, Jane (used to be an abbreviation, but we already forgot about it the next day) no longer uses a script for every single skill to reason about its usage. Almost all logic has been moved to code, and all that's left in script is starting the Ai calculation, stopping the Ai calculation, and executing the action that has been selected by Ai. This script logic can be found in DefaultBehaviour.charScript. The Ai now takes into account the properties of a skill, the statuses that are applied, the weapons that are used, the items nearby, etc. Besides being smarter in general it also fixes a lot of issues with Ai ending turns we had in D:OS. It (attempts) to simulate what's going to happen if it will use a certain skill at a certain target and assign a score to it. The action with the highest score will be executed. All this happens automatically, so a new skill or status can be used by Ai without any extra steps. Of course, there are exceptions, and you'd still like to guide or override the Ai from time to time. That's what this page tries to cover in detail.

=How does it work=
When trying to guide or override the Ai it's useful to know why the Ai is doing what it's doing. I'll try to explain the general approach the Ai takes in one turn to decide what action it will take, and try to refrain from using too many implementation details. First of all, let me explain a couple of terms up front that might also also be useful when touching [[CombatAi_Archetypes_And_Modifiers|archetypes and modifiers]]:
<ul>
<li>Action: walking to a position (if needed) and using a skill on one or multiple targets, or a fallback (finding a preferable position if no other action is viable)</li>
<li>ActionScore: the score of the use of a skill</li>
<li>PositionScore: the score of a position, based on surfaces that may be on that position, allies or enemies in the vicinity, etc.</li>
<li>MovementScore: the score of moving from A to B, based on PositionScores on the path from A to B</li>
<li>ActionCostModifier: the modifier combined from multiple modifiers that determines the total 'action cost' of an action, including AP and SP</li>
<li>CostModifier: the modifier combined from multiple modifiers that determines the total 'cost' of an action. Affected by e.g. items being used, cooldowns, etc.</li>
</ul>
 
Let's say the Ai has the Projectile_Fireball skill and go through the steps that the Ai takes to calculate the scores for possible actions:
# Check first: can we cast this skill? Skill conditions, cooldowns, difficulty mode, statuses preventing us from casting, etc. No need to calculate anything if we can't even cast.
# Find interesting targets to cast the skill on. Ai checks for characters, items (barrels could explode), and positions on the terrain. We run a simulation on each of these targets to see what effect it will have. This simulation on every target gives us damage scores, health scores, buff scores, etc. for every object we hit (the ActionScore).
# Calculate the 'final' score of every Action (at this point this is purely the skill being casted). The different scores are thrown together, affected by a whole bunch of target specific [[CombatAi_Archetypes_And_Modifiers|modifiers]], and balanced so that we end up with one single value for the score.
# Only the interesting Actions, based on the 'final' score in the previous step, will be investigated further. We start to find a good position to cast from. The character might not be able to cast from it's current position (out of sight, out of range, etc.), or the character might not like its current position due to nearby enemies. PositionScores will be calculated and we hope to find a good position for every action.
# After finding a good position we start calculating the MovementScore. Does the character need to walk through a fire surface? Could we jump instead of walking? Do I have enough AP to even walk there this turn?
# In the end only one Action will be on top. We have a skill (or default attack), a target, a position, and even the path has been checked. The action will be fetched from script and executed.
# What if we don't have any Action that is deemed positive? That's when the fallback action kicks in. The fallback action tries to find a good position for the character and walks there.

=Guiding Ai=
There are multiple ways to guide Ai into certain actions or behaviour. Skill conditions, archetypes and modifiers, and AiHints are all supported by Ai and are used by Ai during the score calculation. Any other way to guide Ai might result in incorrect behaviour (but you're welcome to try).
===Skill conditions===
[[File:CombatAi_SkillConditions.PNG|none]]
The skill conditions panel you get when adding a skill to a character

The skill conditions panel can be used to set conditions for casting a skill (e.g. prohibit using a skill if the caster is still full health), set flags for the skill, or apply a simple score modifier.
<ul>
<li>AiFlags: AiFlags can be set on a [[#AiFlags|skill on a global level]], but they can also be set in the skill conditions. A list of the flags and what they do can be found [[CombatAi_AiFlags|here]]. It is possible to use multiple flags by concatenating them with a semicolon (';')</li>
<li>MinimumImpact: The skill should impact at least this amount of characters in a positive way, or else it can not be used. Positive in this case means it's benefitial for the caster: e.g. healing an ally, or damaging an enemy</li>
<li>OnlyCastOnSelf: The skill can only be cast on self. Can be used, for example, to force a character to only use the bless skill on itself</li>
<li>StartRound: The skill can only be used from this round. Everything below and including 1 means it can be used from the start</li>
<li>HasNoMagicalArmor: The skill can only be used if the source/target has no magical armor</li>
<li>HasNoPhysicalArmor: The skill can only be used if the source/target has no physical armor</li>
<li>MaximumHealthPercentage: The skill can only be used if the source/target has a health percentage lower or equal to this value</li>
<li>MinimumHealthPercentage: The skill can only be used if the source/target has a health percentage higher or equal to this value</li>
<li>Tags: The skill can only be used if the source/target has these tags</li>
</ul>
You may have noticed that the italic conditions in above list are listed twice in the skill conditions. It's possible to set these for both the source (the caster of the skill) and the target of the skill (if the skill has a direct target).
Tip: Tags can be used for any skill condition that is not part of the standard skill conditions. You can create a custom tag and a script that assigns/removes a tag based on scripted conditions.
 
The last skill conditions are the difficulty modes. These are simple checkboxes to enable/disable a skill on a certain difficulty. The very last thing on the list, the score modifier, is exactly what it says it is: a score modifier. If you want the Ai to use a skill more often, even if it's not that good at all, you could increase the score modifier. You could also use to, for example, force Ai to cast a certain skill after an event: set a high score modifier and set a source tag condition for a tag that you apply via script.
 
===Archetypes and modifiers===
[[File:CombatAi_Archetype.PNG|none]]
The EXTERN script variable that sets the archetype

The EXTERN Archetype parameter in the DefaultBehaviour script allows you to set the archetype of a character. It can also be set using the CharacterSetArchetype call in script. Archetypes are linked to a text file that contain modifiers for Ai. These modifiers are used when calculating the scores for all the skills and are delicately balanced. And you can change them.
 
You can find the archetype files in: Public/YourMod/AI/Archetypes/ (if the directory doesn't exist you can just create it yourself). All .txt files in the Archetypes folder will be shown as options in script. The archetypes in this folder are used for Explorer and Classic mode. If you want to override modifiers from archetypes for Tactician and Hardcore mode you can place these in a folder called TACTICIAN inside the Archetypes folder. So, let's say we want to override a modifier in the base archetype (an already existing archetype in D:OS2). We'd have to create a new text file called base.txt and give it the following content:
<pre>
// We want self-healing to be more common in our mod -> yes, comments work in these files!
MULTIPLIER_HEAL_SELF_POS 10.0 // This will override the modifier MULTIPLIER_HEAL_SELF_POS located in the D:OS2 base archetype with our own value of 10.0. Only int and float values are allowed in these files
</pre>
Or we'd like to create a completely new archetype called myFirstArchetype. We'd have to create a text file called myFirstArchetype.txt and give it the following content:
<pre>
// We copy over all modifiers from the base archetype because we don't want to specify every single modifier
USING base

MULTIPLIER_HEAL_SELF_POS 10.0 // Because I'm unoriginal
</pre>
If you place a .txt file containing the above snippet in your Archetypes folder you'll have the archetype myFirstArchetype showing up in script.
 
The only information you're still missing now is a list of all the modifiers and archetypes and what they do. You can find that list right [[CombatAi_Archetypes_And_Modifiers|here]].
 
===AiHints===
[[File:CombatAi_AiHints.PNG|none]]
The EXTERN script variables AiHints and StayInAiHints

You can assign a tag to the EXTERN AiHint parameter in the DefaultBehaviour script for the Ai to use. Ai will find AiHintAreaTriggers with this tag and use these during the calculation. The AiHintAreaTriggers with the specified tag (referred to ai AiHints from now on) are areas where the Ai would prefer to stand when attacking. You could use this when you, for example, want a ranger to prefer standing on some platforms in the back instead of on the lower ground. Keep in mind that it does not force the Ai to stay in the AiHint. For that you also need to enable the StayInAiHints parameter in the same DefaultBehaviour script. This forces the Ai to always stand in the AiHint, even if it blocks it from attacking. There's only 2 exceptions to this rule:
# All of the AiHints are filled with dangerous surfaces (all of them full of fire for example)
# The character has been moved outside of the AiHint (started outside of it or has been teleported for example) and is not able to attack anyone from any AiHints. In this case it will try to attack anyone without moving.
 
===Tags===
Sometimes you'd like to make sure Ai prefers a target, or doesn't, or even totally ignores a target. There are some tags you can set on objects to make it work:
<ul>
<li>AI_PREFERRED_TARGET: boosts any score on this target. This will not only increase being attacked by enemies, but also being healed by allies</li>
<li>AI_UNPREFERRED_TARGET: decreases any score on this target. This will not only decrease being attacked by enemies, but also being healed by allies</li>
<li>AI_IGNORED_TARGET: completely ignored by Ai. Damage doesn't matter, healing doesn't matter, killing doesn't matter.</li>
</ul>

=Overriding Ai=
It's strongly advised to not override the Ai, but we understand that it's needed from time to time. Below are some supported ways to override the Ai and some tips and tricks you might want to use.
===Skills===
The skills in [[skill_creation|SkillData]] have several properties that affect the Ai in a special way.
====Skill overrides====
Several skill types have the possibility to be overwritten with the score of a specified Target skill (can not be of any other type) in the AiCalculationSkillOverride column. If a skill has an override it will calculate the score by simulating with the Target skill instead of the original skill. This can be used to make the Ai think a skill will do something that it won't actually do, but some skills actually need to have an override skill:
<ul>
<li>Summon skills: Ai does not know what kind of impact a summon will have. The AiCalculationSkillOverride skill will be used to calculate the impact of the summon.</li>
<li>Projectile skills with a filled in SpawnObject: Just like with Summon skills Ai does not know what kind of impact a summon will have. The AiCalculationSkillOverride skill will be used to calculate the impact of the summon.</li>
<li>Target skills: The AiCalculationSkillOverride skill will be used to calculate the score on the target.</li>
<li>Rain and Shout skills: The AiCalculationSkillOverride skill will be used on all targets that would get hit by the original skill to calculate the score on the target.</li>
</ul>
Next to Summon and Projectile skills it is also supported by Shout and Target skills.
 
The override skill can be fairly simple, just like the Target_DummyTargetSkill that we use in a couple of cases. However, it's advised to make the override skill as accurate as possible. E.g.: for a Summon skill that spawns a summon that does only fire damage you shouldn't use an override skill that only does physical damage. Ai might then cast the summon in the middle of a group of enemies that are all immune to fire damage. Use a target skill that represents the actual summon as accurate as you possibly can.

====AiFlags====
The AiFlags column is used to set flags specifically for Ai. A list of the flags and what they do can be found [[CombatAi_AiFlags|here]]. It is possible to use multiple flags by concatenating them with a semicolon (';').
===Scripting===
Overriding Ai with scripting is relatively easy: make sure the priority of your REACTION is higher than 60 (higher than all REACTIONs related to Ai) and the Ai won't execute anymore.

=Unsupported properties=
Some skill and status properties are not supported for Ai. If it's not supported Ai will ignore the property altogether and it might do unexpected things. Try to avoid these properties for Ai and use the CanNotUse [[#AiFlags|AiFlag]] to prevent the Ai from casting any skills with these properties.
===Skills===
<ul>
<li>Chaos damage type (random damage type)</li>
<li>Spawning multiple summons</li>
<li>Zone skills with a push distance</li>
<li>Skills with the Sabotage property</li>
<li>Skills with the Equalize property</li>
<li>Skills with the SwapSurfaces property</li>
<li>Skills with the CreateConeSurface property</li>
<li>Projectile skills with an angle and multiple targets</li>
</ul>
===Statuses===
<ul>
<li>Surface absorption boostst</li>
<li>Adding skills</li>
<li>The statuses STANCE, SMELLY, CLEAN, DARK_AVENGER, REMORSE, UNHEALABLE, CHANNELING, INFUSED, LINGERING_WOUNDS, SPIRIT_VISION, FORCE_MOVE, DEMONIC_BARGAIN, FLOATING, CHALLENGE, and EXTRA_TURN</li>
<li>Consume statuses that set weapon overrides</li>
<li>Consume statuses that reset cooldowns</li>
</ul>

Script editor

2017-10-02T09:15:59Z

Rimevan:

==Description==
The Script Editor allows you to create and edit scripts. You can also use it to [[script_debugger|debug scripts]].

== Using the Script Editor ==
[[File:ScriptEditor_StepByStep.png|none]]
The Script Editor with each component numbered and an absurd amount of errors to illustrate a stressful situation

 
The Script Editor consists of the following components:
# [[#Menu|Menu]]
# [[#Quick Menu|Quick Menu]]
# [[#Solution Explorer|Solution Explorer]]
# [[#Script Editor|Script Editor]]
# [[#Debug Panel|Debug Panel]]

 
===Menu===
====File====
[[File:ScriptEditor_Menu_File.PNG|none]]
A closeup of the File menu

The File menu allows you to create, save, open, or reload script files. It also allows you to exit the editor.
====Edit====
[[File:ScriptEditor_Menu_Edit.PNG|none]]
A closeup of the Edit menu

The Edit menu allows you to undo or redo, cut/copy/paste, select all, or find within scripts.
====View====
[[File:ScriptEditor_Menu_View.PNG|none]]
A closeup of the View menu

The View menu allows you to show the Solution Panel, the Errors Panel, the Watch Panel, and the Output Panel.
====Build====
[[File:ScriptEditor_Menu_Build.PNG|none]]
A closeup of the Build menu

The Build menu allows you to build the current file, build all files, rebuild all files, and reload the object lists.
====Debug====
[[File:ScriptEditor_Menu_Debug.PNG|none]]
A closeup of the Debug menu

The Debug menu allows you to pause, continue, and step when debugging. These are not available while editing scripts. More information can be found [[script_debugger|here]].

 
===Quick Menu===
The Quick Menu contains the most used options from the Menu and a couple more. All debugging related options on the Quick Menu are explained in detail on the [[script_debugger|debug scripts]] page.
From left to right the Quick Menu buttons do the following:
# Create a new script file
# Open a script file
# Save a script file
# Save all script files
# Cut selected text
# Copy selected text
# Paste text
# Build the current script
# Build all scripts
# Rebuild all scripts
# Reload the object lists
# Collapse all regions by one level in the current script
# Expand all regions by one level in the current script

 
===Solution Explorer===
[[File:ScriptEditor_Solution_Panel.PNG|none]]
The solution explorer

The solution explorer shows the scripts in their respective project and folder as they appear in the Data folder. You can filter by typing in the filter textbox at the bottom and quickly clear the filter by pressing the X next to the filter. The Solution Explorer will only show files with the extensions .charScript, .itemScript, and .gameScript.

 

===Script Editor===
[[File:ScriptEditor_Script_Editor.PNG|none]]
The script editor

The script editor is a simple text editor, which also correctly color codes the script. It allows you to expand or collapse regions that are automatically created for each section (INIT, BEHAVIOUR, STORY, and EVENTS) and for each REACTION, EVENT, and SCRIPTFRAME. The status at the top of the script editor shows you whether the file has been built succesfully (meaning without any errors). A file can only be built when it is linked to a script resource.

 
===Debug Panel===
[[File:ScriptEditor_Debug_Panel.PNG|none]]
The debug panel, containing the error panel, watch panel, and output panel

The debug panel contains three panels: error panel, watch panel, and output panel. The watch panel and output panel are explained in detail on the [[script_debugger|script debugger]] page. The error panel contains both errors and warnings that occured during the latest build (could be a single script or a full build of all scripts). It will show you the error/warning, the file, the line, and -if applicable- the template. Double clicking the error will automatically open the relevant script at the correct line and show the error/warning with a red/yellow highlight. If an error description is preceded by [Instantiating] it will open the affected character or item. Instantation errors usually mean that an EXTERN variable has been filled in incorrectly on a character or item.

 
===Find Panel===
[[File:ScriptEditor_Find_Panel.PNG|none]]
The find panel

The find panel (CTRL+F) allows you to search in the current script or in all scripts, with the options to match case or match the whole word.

Scripting

2017-09-13T18:30:22Z

Rimevan: /* Common Mistakes */

=Introduction=
The scripting system is currently used for the behaviour of characters and items. For characters this is only part of the behaviour, as many more systems are influencing this in the following priority:
<ul>
<li>Story: executing Osiris Tasks</li>
<li>Dialogs: dialog behaviour and animations</li>
<li>Statuses: dying, frozen, petrified, ...</li>
<li>Scripts: executing the current reaction or scriptframe</li></ul>
Scripts are the lowest priority and will only execute if none of the other systems want to do something. For items it's a lot simpler, as the scripting system is the only thing that influences the items behaviour.
 
=Sections=
Before any section in a script, we can INCLUDE files. When you INCLUDE a file, you're telling the system to parse that file first.
 
===INIT===
In the INIT section you can declare global variables and inherit from other scripts. Global variables always start with % and can be accessed and modified everywhere (including other scripts, osiris, and in code). There are also EXTERN variables, which are exposed when you assign a script to an object so you can change the value for local instances of the script. The INIT section also contains the special variable '__Me', which contains the owner of the script. This is a character or item depending on the script type. Code will automatically fill this variable. 
Inheritance is done with the USING keyword and copies everything from the other script into the current script. This includes all global variables, reactions, scriptframes, and events. You can use USING SHARED if you intend to overwrite reactions, events, or scriptframes. 
An example INIT section:
<pre>
INIT
USING SHARED Base
CHARACTER:__Me
CHARACTER:%AnotherCharacter=null
FLOAT3:%CurrentPosition=null
EXTERN INT:%CanRun=1
</pre>

If you want to override a specific reaction, event, or scriptframe you have to specify this with the OVERRIDE keyword:
<pre>
REACTION TestReaction, 5 OVERRIDE
EVENT TestEvent OVERRIDE
SCRIPTFRAME TestFrame OVERRIDE
</pre>
If needed, you can also only inherit specific reactions, events, or scriptframes:
<pre>
USING ScriptName REACTION ReactionName,NewPriority
USING ScriptName EVENT EventName
USING ScriptName SCRIPTFRAME ScriptFrameName
</pre>
 
===BEHAVIOUR===
This section contains the actual behaviour of the object. It solely consists of a whole bunch of reactions, of which only 1 reaction can be active at the same time. The current reaction gets selected based on its priority and its CHECK. The priority defines how much it wants to be executed and the CHECK decided whether its possible to be executed. The reaction with the highest priority whose CHECK succeeds will be selected for execution:
<ul>
<li>The whole list of reactions is always sorted from HIGH to LOW priorities.</li>
<li>We then check in that order all the reactions with a higher priority of the current reaction and see if their CHECK succeeds.</li>
<li>As soon as a higher priority reaction's CHECK succeeds, it interrupts the current reaction and will start executing.</li>
</ul>
Important note: only the CHECKs of higher priority reactions are evaluated every frame. This means that the current reaction's CHECK is NOT reevaluated while it's executing! It could become invalid during the execution. This is also true when calling Reset(): execution simply restarts at the beginning of the current reaction without evaluating the CHECK conditions again.
On top of the priority and CHECKs there's also the USAGE keyword. A reaction needs to specify a USAGE context. You can pick the following USAGE contexts:
<ul>
<li>USAGE COMBAT: can only be executed during combat when its the turn of the object</li>
<li>USAGE WAITING: can only be executed during combat when waiting for its turn</li>
<li>USAGE PEACE: can only be executed when not in combat</li>
<li>USAGE ALL: can always be executed</li>
</ul>
A reaction can have its own local variables. These variables have to start with an underscore and can only be accessed within the reaction itself. 
As soon as a reaction is interrupted, the INTERRUPT event will be called immediately and you can execute some code to for example Reset the reaction. You can catch all INTERRUPTS or only specific interrupts (like the movement failed interrupt) and execute actions on the interrupt. If you catch a specific interrupt event you have the possibility to fill in variables for the event:
<ul>
<li>An underscore ('_'): this variable is not relevant for the event, it will not prevent the event from firing</li>
<li>A constant (e.g. "TestString") or a global variable: the variable has to be equal to this constant, otherwise the event will not be executed</li>
<li>A local variable: this variable will get filled with the variable from the event</li>
</ul>
Some examples:
<pre>
OnEnteredCombat(__Me, _) // Only catch the event when __Me entered combat, the second variable one is irrelevant
OnEnteredCombat(_, %GlobalItemVariable) // Only catch the event when %GlobalItemVariable entered combat, the first variable is irrelevant
OnEnteredCombat(_LocalCharacterVariable, _) // Always catches the event, and _LocalCharacterVariable contains the character that entered combat. BEWARE: _LocalCharacterVariable can be null if an item entered combat
</pre>
The actions during an interrupt are limited to immediate/simple actions, which can be executed immediately (e.g. CharacterMoveTo() is not allowed). Keep in mind though that a reaction can be interrupted for many reasons:
<ul>
<li>Higher priority reaction takes over.</li>
<li>Other system takes over: statuses/dialog/story</li>
<li>An exception was thrown in the script: e.g. pathfinding failed, ...</li>
<li>The object got culled (more details on culling can be found later on this page)</li>
</ul>
Important note: if a reaction gets interrupted and later gets resumed, it will continue executing where it got interrupted! (unless "Reset" was called in the INTERRUPT handler, in which case it will begin from the start again) 
An example BEHAVIOUR section:
<pre>
BEHAVIOUR
REACTION TestReaction, 5 // Priority 5
USAGE PEACE
VARS
CHARACTER:_TestCharacter
CHECK "(c1|c2)&!c3" // Reaction can be executed when one of the first 2 conditions passes, and the third condition doesn't pass
IsInSurface(__Me, SurfaceOil)
IsInDangerousSurface(__Me)
CharacterIsFloating(__Me)
ACTIONS
CharacterFleeFromSurface()
INTERRUPT
ON
OnMovementFailed(_) // Only when interrupted by a failed movement
ACTIONS
Reset()
</pre>
 
===STORY===
There are specific story "reactions" called scriptframes. These are almost exactly the same as reactions, but they don't have a priority or CHECK block. They are managed by Story (Osiris) and can be SET or INJECTED. We keep a stack of all currently set scriptframes. If something is on the stack, the current REACTION always gets interrupted! The stack is the highest priority and comes before BEHAVIOUR reactions! Example of stack behaviour:
<ul>
<li>When you push something, it is put on the top of the stack.</li>
<li>When you pop, the top scriptframe is removed (happens when it finished executing)</li>
</ul>
In our case: 
If you SET a scriptframe the stack gets cleared (Abort!) and the new scriptframe gets pushed on the stack. 
If you INJECT a scriptframe, it will just push a copy of it on the stack. You can keep injecting the same scriptframe on the stack and it will be executed multiple times. 
As soon as the TOP scriptframe is finished, it pops from the stack and the one below it starts/resumes executing. 
Just like with reactions, if you INJECT a new scriptframe and there was already a scriptframe on the stack active, it will get interrupted and later resume where it was before. The syntax for writing a SCRIPTFRAME is exactly the same as a REACTION (except for the lack of priority and CHECK, and the fact that they need to be in the STORY section).
 
===EVENTS===
This section contains all the events that we want to catch. Events are always immediately and completely executed! It cannot take multiple frames: it's a blocking call and will execute and return immediately when it's done. Even when the object is culled or offstage will it execute its events. Events are always thrown to all objects in the current level. An event can be thrown from code, osiris, or from script itself. 
In a reaction or scriptframe, each frame only 1 action gets executed at most. Let's take a piece of script from a REACTION:
<pre>
Set(%TargetPos,%Enemy)
CharacterEvent(%Enemy,"Attack!")
CharacterMoveTo(%TargetPos)
</pre>
In the example above, the first 2 lines will take 2 frames (1 frame per line). The third one will take as long as it takes for the character to move to the target position. However, in an event the actions get executed immediately. Even if it was 100 actions with IFs and WHILEs, it would be executed as it was 1 action. For that reason, you cannot use actions in events that need time (Sleep, CharacterMoveTo, ...). Additionally, the number of actions an event can execute is limited. If you exceed the limit, Osiris will log an error and exit the event. In fact, let me amaze you even more. If you throw a CharacterEvent in an event, that spawns a new event and is thrown on every character and item... even all those events are executed immediately before it gets to the next line. 
Just like INTERRUPTs in REACTIONs, EVENTs have to react on something (INTERRUPTs can and EVENTs must). The syntax is equal as well (more information on the event variables can be found in the REACTION INTERRUPT section). 
An example EVENTS section:
<pre>
EVENT TestInitEvent
ON
OnInit()
ACTIONS
IF "!c1"
IsEqual(%StartTrigger, null)
THEN
TeleportTo(__Me, %StartTrigger)
ENDIF
</pre>
 
=Variables=
===Types===
<ul>
<li>INTEGER and INTEGER64: 'whole' numbers. The difference between INTEGER and INTEGER64 is not relevant for the scripter (unless you care about really, really big numbers), as long as you make sure to pass the right type in actions. For example: -10, 0, 8, 102324, ...</li>
<li>FLOAT: all other numbers. For example: 0.1, -0.323, 8.3, ...</li>
<li>STRING and FIXEDSTRING: the difference between STRING and FIXEDSTRING is not important when scripting, just make sure to pass the correct type in actions. For example: "", "testString", "testing123", ... . Important note: do not start a string with the characters '%' or '_', as they will get recognized as a variable instead (it's not intended, it's a bug).</li>
<li>CHARACTER, ITEM, TRIGGER, and SPLINE: objects that are currently loaded in the game. This includes globals and locals of the curently loaded level. The script will assert if the script uses an object that isn't currently loaded. It will also warn you if the character's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_GLO_Dallis, S_MyFirstItem, ...</li>
<li>RELATION_TYPE: only used in a handful actions. A list of possible relation types can be found [[scripting_relation_types|here]].</li>
<li>SKILL_ID: the name/id of a skill as it can be found in [[skill_creation|SkillData]]. For example: Target_Bless, Projectile_Fireball, ...</li>
<li>SURFACE_TYPE: surface types can be found [[scripting_surface_types|here]].</li>
<li>STATUS_TYPE: status types can be found [[Scripting_status_types|here]].</li>
<li>CHARACTERSTAT_TYPE: characterstat types can be found [[Scripting_characterstat_types|here]].</li>
<li>ITEMSTAT_TYPE: itemstat types can be found [[Scripting_itemstat_types|here]].</li>
<li>WEAPON_TYPE: weapon types can be found [[Scripting_weapon_types|here]].</li>
<li>DAMAGE_TYPE: damage types can be found [[Scripting_damage_types|here]].</li>
<li>TALENT_TYPE: talent types can be found [[Scripting_talent_types|here]].</li>
<li>COMPARE_TYPE: compare types can be found [[Scripting_compare_types|here]].</li>
<li>COMPARE_FUNCTION: compare functions can be found [[Scripting_compare_functions|here]].</li>
<li>FLOAT3: floats are written as {number;number;number}, and can contain integers as well</li>
<li>CHARACTERTEMPLATE, ITEMTEMPLATE, and PROJECTILETEMPLATE: the script will warn you if the template's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_Chair_A, S_Human_Male_B, ...</li>
<li>POTION_ID: all loaded potions from stats</li>
<li>ABILITY_TYPE: ability types can be found [[Scripting_ability_types|here]].</li>
<li>DEATH_TYPE: death types can be found [[Scripting_death_types|here]].</li>
<li>STATUS_ID: all loaded statuses from stats</li>
<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[CombatAi_Archetypes_And_Modifiers|here]].</li>
<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types|here]].</li>
</ul>
 
===Lists===
Lists are a special parameter type and contain multiple parameters of a single type. 
Important note: Lists are more convenient, but they are slower than normal parameters. They also have a limited size, so don't try to fill them with thousands of entries. 
Declaring a list:
<pre>
LIST<INT>:%TestListInt // Fine
LIST<CHARACTER>:%TestListCharacter // Fine
LIST<LIST<INT>>:%TestListNested // Error, can't nest lists
</pre>
Adding entries:
<pre>
ListAdd(%TestListInt, 0) // Fine
ListAdd(%TestListInt, {0;1;2}) // Error, trying to add a FLOAT3 to an INT LIST
</pre>
Removing entries: indices start at 1, and end at the list size. All entries after the removed entry will be shifted to the left:
<pre>
ListRemove(%TestListInt, 1) // Fine, assuming that the list has 1 or more entries
ListRemove(%TestListInt, 0) // Error, invalid index
</pre>
Setting or getting entries:
<pre>
ListSet(%TestListInt, 1, %AnInt) // Fine
ListGet(%TestListInt, 1, %AnInt)

ListSet(%TestListInt, 1, %ACharacter) // Error, trying to set a CHARACTER in an INT LIST
ListGet(%TestListInt, 1, %ACharacter)

ListSet(%TestListInt, 0, %AnInt) // Error, invalid index
ListGet(%TestListInt, 0, %AnInt)
</pre>
Getting the list size:
<pre>
ListGetSize(%TestList, %ListSize)
</pre>
Clearing a list:
<pre>
ListClear(%TestList)
</pre>
Important note: Lists currently do not support EXTERN, constants, and STRING , meaning that the following lines will not work in scripts and result in an error during script build:
<pre>
LIST<INT>:%TestList = {1, 2, 3, 4, 5} // Using a constant to initialize
ListGetSize({1, 2, 3, 4}, %ListSize) // Using a constant in an action call
EXTERN LIST<INT>:%TestList = {1, 2} // Using EXTERN and using a constant to initialize
LIST<STRING>:%TestString // Using STRING as the type
</pre>
Now, how would you use these lists?
 

=Important Events=
===OnInit and OnShutDown===
OnInit is called each time on all objects in the level when the level is loaded, and OnShutdown is called when the level is unloaded. This would be the place where you can create/destroy your looping effects that should always be on the object.
 
===OnLoaded===
OnLoaded is called when the savegame is loaded or when the levelcache is loaded (levelswap). The version of the savegame is passed so you can do your patching "hacks" if necessary.
 
===Interrupts===
Interrupts are only called on reactions and can only be caught on that reaction:
<ul>
<li>OnBetterReactionFound: a higher priority reaction succeeded its check</li>
<li>OnNoReactionFound: no reaction has succeeded its check</li>
<li>OnScriptDisabled: another system has taken control (dialogs, statuses, story)</li>
<li>OnManualInterrupt: the Interrupt action itself has caused the interrupt</li>
<li>OnMovementFailed: pathfinding has failed to find a path to the target</li>
<li>OnException: a character task has failed</li></ul>
 
===OnFunction===
You can create your own "functions' with CallFunction("functionName") and catching the event OnFunction("functionName"). This way you can share functionality between multiple events and reactions. You can not pass parameters directly, but you could set some function-specific global variables which the function uses and can even 'return' results in.
 
=Culling=
For performance reasons we only update a small set of all the characters & items in the level. 
The updating characters are:
<ul>
<li>Force updating (can be set in script/story, but should only be used in an emergency!)</li>
<li>In Combat</li>
<li>Executing Osiris Tasks</li>
<li>In range of the party (within 40m)</li>
</ul>
The updating items are:
<ul>
<li>Force updating (can be set in script/story using ItemSetForceSynch(), but should only be used in an emergency!)</li>
<li>In Combat</li>
<li>Moving</li>
<li>In range of the party (within 40m)</li>
</ul>
This means that in most cases objects far away from the party get culled and stop updating. When an object doesn't update anymore this means the behaviour is interrupted and won't be executed anymore. However, events always get executed, so culling has no impact on this. Another consequence of culling is that timers of that script are not ticking anymore and are basically paused.
 
=Debugging=
There are 4 ways to help you debug:
<ul>
<li>The script debugger in the script editor</li>
<li>CTRL+SHIFT+ClICK on the object you wish to debug to show the Script Screen, and CTRL+SHIFT+SCROLL to the Script and/or Variables screen to see what the current state is.</li>
<li>Add a whole bunch of DebugText output in your code to see which code is called in what order.</li>
<li>Start the script log for an object, which logs as much stuff as possible about the script (reactions, interrupts, events, ...)</li>
</ul>
 
===Script Debugger===
See the [[script_debugger|Script Debugger]] page for more information.
 
===Script Screen===
On the left side of the Script Screen it shows the script variables, the script reactions (ordered from high priority to low), and the current Event it catches. It colors the reactions gray (not checked), green (check passed), and red (check failed). At the right you can see the current reaction's conditions and actions. You can see which action is currently executing and you can see the return results of the conditions from the check: gray (not evaluated), green (TRUE), and red (FALSE). 
You can filter in the script variables through the [[console|console]] by using: "filtervar <filter>".
Tip: type "filtervar asdf" or something to remove all variables so you can see all the reactions! 
You can also change which reaction you want to see at the right, by entering the number of that reaction in the console. This way you can easily check why certain reactions are never succeeding their CHECK by checking the return values of the conditions. To do this first you must activate this mode, by entering "show server" in the console. Then you can type the number of the wanted reaction or type "0" to show the current reaction again.
 
===DebugText===
You can put DebugText in events/scriptframes/reactions to print text in the world on any object you want. This way you can easily see if you get in the code you wrote and you can also print any variable's value at that time. To print the variables we use the same syntax as translated strings: [1] [2] [3] ... 
For example:
<pre>
DebugText(__Me,"Target: [1], Speed is [2]",_Target,%Speed)
</pre>
For characters, items, triggers, splines, and templates the name will be shown in the debug text. Numbers will be shown in full, and all other variables will be directly converted to strings.
 
===ScriptLog===
You can also start/stop the scriptlog in console with:
<ul>
<li>"ai log all": Start the scriptlog for all character/items.</li>
<li>"ai log none": Stop the scriptlog for all character/items.</li>
<li>"ai log selected": Toggle the separate scriptlog for the selected (CTRL+SHIFT+CLICK) object</li>
</ul>
It will generate scriptlog file(s) right next to the executable.
 
=Common Mistakes=
===Reset()===
<pre>
REACTION CastSkill, 1000
USAGE COMBAT
VARS
FLOAT:_minRange
FLOAT:_maxRange
CHECK "!c1&c2&c3"
IsEqual(%SkillTarget,null)
CharacterCanCast(__Me,Projectile_Fireball,0)
CharacterGetSkillRange(_minRange,_maxRange,__MeProjectile_Fireball)
ACTIONS
CharacterMoveInRange(%SkillTarget,_minRange,_maxRange,1)
PlayEffectAt(__Me, "FX_GP_HugeFireball_A")
CharacterUseSkill(Projectile_Fireball,%SkillTarget)
</pre>
In this case we have a reaction that will move in range of the target and as soon as we are in range we will play an effect and cast a fireball. However, if this reaction gets interrupted during the playeffect, next time this reaction becomes active again we will just cast a fireball on the target even when we would not be in range and didn't play the effect. This is why in these cases you should add an INTERRUPT to Reset() the reaction.

===CHECK or IF===
<pre>
REACTION CastSkill,1000
USAGE COMBAT
VARS
FLOAT:_minRange
FLOAT:_maxRange
CHECK "!c1&c2"
IsEqual(%SkillTarget,null)
CharacterGetSkillRange(_minRange,_maxRange,__MeProjectile_Fireball)
ACTIONS
IF "c1"
CharacterCanCast(__Me,Projectile_Fireball,0)
THEN
CharacterMoveInRange(%SkillTarget,_minRange,_maxRange,1)
PlayEffectAt(__Me, "FX_GP_HugeFireball_A")
CharacterUseSkill(Projectile_Fireball,%SkillTarget)
ENDIF
INTERRUPT
Reset()
</pre>
In this case we're checking something in the reaction when it's executing, but we don't do anything if the IF fails. There is no ELSE behaviour. This means that in combat this reaction could keep failing and not do anything, which will cause a ForceEndTurn for that character. Here we should have checked CharacterCanCast in the CHECK and not write a separate IF check. In general when the IF check in a REACTION is blocking the whole REACTION from executing it's probably better to place it in the CHECK instead.
 
===Check order===
<pre>
IF "c1&c2&!c3&c4"
CharacterGetStat(_Vitality, __Me, Vitality) // Fetch before checking
IsGreaterThen(_Vitality, 0.5)
IsEqual(_Character, null) // Null check before checking
CharacterIsPlayer(_Character)
THEN
// Do something
ENDIF
</pre>
Make sure to perform your checks in the right order. Before checking a stat make sure to fetch it. Before checking if the character is a player consider checking if it is a valid player. Could it be the player is off stage? Could it be dead? Is it even set?
 
===AD interrupts===

Scripting surface transform types

2017-09-13T18:28:20Z

Rimevan: Created page with "The following surface transform types can be used in script: <ul> <li>None</li> <li>Ignite</li> <li>Bless</li> <li>Purify</li> <li>Curse</li> <li>Electrify</li> <li>Melt</li>..."

The following surface transform types can be used in script:
<ul>
<li>None</li>
<li>Ignite</li>
<li>Bless</li>
<li>Purify</li>
<li>Curse</li>
<li>Electrify</li>
<li>Melt</li>
<li>Freeze</li>
<li>Condense</li>
<li>Vaporize</li>
<li>Bloodify</li>
<li>Contaminate</li>
<li>Oilify</li>
<li>Shatter</li>
</ul>

Scripting

2017-09-13T18:26:50Z

Rimevan: /* Variables */

Scripting

2017-09-13T18:25:54Z

Rimevan: /* Variables */

=Introduction=
The scripting system is currently used for the behaviour of characters and items. For characters this is only part of the behaviour, as many more systems are influencing this in the following priority:
<ul>
<li>Story: executing Osiris Tasks</li>
<li>Dialogs: dialog behaviour and animations</li>
<li>Statuses: dying, frozen, petrified, ...</li>
<li>Scripts: executing the current reaction or scriptframe</li></ul>
Scripts are the lowest priority and will only execute if none of the other systems want to do something. For items it's a lot simpler, as the scripting system is the only thing that influences the items behaviour.
 
=Sections=
Before any section in a script, we can INCLUDE files. When you INCLUDE a file, you're telling the system to parse that file first.
 
===INIT===
In the INIT section you can declare global variables and inherit from other scripts. Global variables always start with % and can be accessed and modified everywhere (including other scripts, osiris, and in code). There are also EXTERN variables, which are exposed when you assign a script to an object so you can change the value for local instances of the script. The INIT section also contains the special variable '__Me', which contains the owner of the script. This is a character or item depending on the script type. Code will automatically fill this variable. 
Inheritance is done with the USING keyword and copies everything from the other script into the current script. This includes all global variables, reactions, scriptframes, and events. You can use USING SHARED if you intend to overwrite reactions, events, or scriptframes. 
An example INIT section:
<pre>
INIT
USING SHARED Base
CHARACTER:__Me
CHARACTER:%AnotherCharacter=null
FLOAT3:%CurrentPosition=null
EXTERN INT:%CanRun=1
</pre>

If you want to override a specific reaction, event, or scriptframe you have to specify this with the OVERRIDE keyword:
<pre>
REACTION TestReaction, 5 OVERRIDE
EVENT TestEvent OVERRIDE
SCRIPTFRAME TestFrame OVERRIDE
</pre>
If needed, you can also only inherit specific reactions, events, or scriptframes:
<pre>
USING ScriptName REACTION ReactionName,NewPriority
USING ScriptName EVENT EventName
USING ScriptName SCRIPTFRAME ScriptFrameName
</pre>
 
===BEHAVIOUR===
This section contains the actual behaviour of the object. It solely consists of a whole bunch of reactions, of which only 1 reaction can be active at the same time. The current reaction gets selected based on its priority and its CHECK. The priority defines how much it wants to be executed and the CHECK decided whether its possible to be executed. The reaction with the highest priority whose CHECK succeeds will be selected for execution:
<ul>
<li>The whole list of reactions is always sorted from HIGH to LOW priorities.</li>
<li>We then check in that order all the reactions with a higher priority of the current reaction and see if their CHECK succeeds.</li>
<li>As soon as a higher priority reaction's CHECK succeeds, it interrupts the current reaction and will start executing.</li>
</ul>
Important note: only the CHECKs of higher priority reactions are evaluated every frame. This means that the current reaction's CHECK is NOT reevaluated while it's executing! It could become invalid during the execution. This is also true when calling Reset(): execution simply restarts at the beginning of the current reaction without evaluating the CHECK conditions again.
On top of the priority and CHECKs there's also the USAGE keyword. A reaction needs to specify a USAGE context. You can pick the following USAGE contexts:
<ul>
<li>USAGE COMBAT: can only be executed during combat when its the turn of the object</li>
<li>USAGE WAITING: can only be executed during combat when waiting for its turn</li>
<li>USAGE PEACE: can only be executed when not in combat</li>
<li>USAGE ALL: can always be executed</li>
</ul>
A reaction can have its own local variables. These variables have to start with an underscore and can only be accessed within the reaction itself. 
As soon as a reaction is interrupted, the INTERRUPT event will be called immediately and you can execute some code to for example Reset the reaction. You can catch all INTERRUPTS or only specific interrupts (like the movement failed interrupt) and execute actions on the interrupt. If you catch a specific interrupt event you have the possibility to fill in variables for the event:
<ul>
<li>An underscore ('_'): this variable is not relevant for the event, it will not prevent the event from firing</li>
<li>A constant (e.g. "TestString") or a global variable: the variable has to be equal to this constant, otherwise the event will not be executed</li>
<li>A local variable: this variable will get filled with the variable from the event</li>
</ul>
Some examples:
<pre>
OnEnteredCombat(__Me, _) // Only catch the event when __Me entered combat, the second variable one is irrelevant
OnEnteredCombat(_, %GlobalItemVariable) // Only catch the event when %GlobalItemVariable entered combat, the first variable is irrelevant
OnEnteredCombat(_LocalCharacterVariable, _) // Always catches the event, and _LocalCharacterVariable contains the character that entered combat. BEWARE: _LocalCharacterVariable can be null if an item entered combat
</pre>
The actions during an interrupt are limited to immediate/simple actions, which can be executed immediately (e.g. CharacterMoveTo() is not allowed). Keep in mind though that a reaction can be interrupted for many reasons:
<ul>
<li>Higher priority reaction takes over.</li>
<li>Other system takes over: statuses/dialog/story</li>
<li>An exception was thrown in the script: e.g. pathfinding failed, ...</li>
<li>The object got culled (more details on culling can be found later on this page)</li>
</ul>
Important note: if a reaction gets interrupted and later gets resumed, it will continue executing where it got interrupted! (unless "Reset" was called in the INTERRUPT handler, in which case it will begin from the start again) 
An example BEHAVIOUR section:
<pre>
BEHAVIOUR
REACTION TestReaction, 5 // Priority 5
USAGE PEACE
VARS
CHARACTER:_TestCharacter
CHECK "(c1|c2)&!c3" // Reaction can be executed when one of the first 2 conditions passes, and the third condition doesn't pass
IsInSurface(__Me, SurfaceOil)
IsInDangerousSurface(__Me)
CharacterIsFloating(__Me)
ACTIONS
CharacterFleeFromSurface()
INTERRUPT
ON
OnMovementFailed(_) // Only when interrupted by a failed movement
ACTIONS
Reset()
</pre>
 
===STORY===
There are specific story "reactions" called scriptframes. These are almost exactly the same as reactions, but they don't have a priority or CHECK block. They are managed by Story (Osiris) and can be SET or INJECTED. We keep a stack of all currently set scriptframes. If something is on the stack, the current REACTION always gets interrupted! The stack is the highest priority and comes before BEHAVIOUR reactions! Example of stack behaviour:
<ul>
<li>When you push something, it is put on the top of the stack.</li>
<li>When you pop, the top scriptframe is removed (happens when it finished executing)</li>
</ul>
In our case: 
If you SET a scriptframe the stack gets cleared (Abort!) and the new scriptframe gets pushed on the stack. 
If you INJECT a scriptframe, it will just push a copy of it on the stack. You can keep injecting the same scriptframe on the stack and it will be executed multiple times. 
As soon as the TOP scriptframe is finished, it pops from the stack and the one below it starts/resumes executing. 
Just like with reactions, if you INJECT a new scriptframe and there was already a scriptframe on the stack active, it will get interrupted and later resume where it was before. The syntax for writing a SCRIPTFRAME is exactly the same as a REACTION (except for the lack of priority and CHECK, and the fact that they need to be in the STORY section).
 
===EVENTS===
This section contains all the events that we want to catch. Events are always immediately and completely executed! It cannot take multiple frames: it's a blocking call and will execute and return immediately when it's done. Even when the object is culled or offstage will it execute its events. Events are always thrown to all objects in the current level. An event can be thrown from code, osiris, or from script itself. 
In a reaction or scriptframe, each frame only 1 action gets executed at most. Let's take a piece of script from a REACTION:
<pre>
Set(%TargetPos,%Enemy)
CharacterEvent(%Enemy,"Attack!")
CharacterMoveTo(%TargetPos)
</pre>
In the example above, the first 2 lines will take 2 frames (1 frame per line). The third one will take as long as it takes for the character to move to the target position. However, in an event the actions get executed immediately. Even if it was 100 actions with IFs and WHILEs, it would be executed as it was 1 action. For that reason, you cannot use actions in events that need time (Sleep, CharacterMoveTo, ...). Additionally, the number of actions an event can execute is limited. If you exceed the limit, Osiris will log an error and exit the event. In fact, let me amaze you even more. If you throw a CharacterEvent in an event, that spawns a new event and is thrown on every character and item... even all those events are executed immediately before it gets to the next line. 
Just like INTERRUPTs in REACTIONs, EVENTs have to react on something (INTERRUPTs can and EVENTs must). The syntax is equal as well (more information on the event variables can be found in the REACTION INTERRUPT section). 
An example EVENTS section:
<pre>
EVENT TestInitEvent
ON
OnInit()
ACTIONS
IF "!c1"
IsEqual(%StartTrigger, null)
THEN
TeleportTo(__Me, %StartTrigger)
ENDIF
</pre>
 
=Variables=
===Types===
<ul>
<li>INTEGER and INTEGER64: 'whole' numbers. The difference between INTEGER and INTEGER64 is not relevant for the scripter (unless you care about really, really big numbers), as long as you make sure to pass the right type in actions. For example: -10, 0, 8, 102324, ...</li>
<li>FLOAT: all other numbers. For example: 0.1, -0.323, 8.3, ...</li>
<li>STRING and FIXEDSTRING: the difference between STRING and FIXEDSTRING is not important when scripting, just make sure to pass the correct type in actions. For example: "", "testString", "testing123", ... . Important note: do not start a string with the characters '%' or '_', as they will get recognized as a variable instead (it's not intended, it's a bug).</li>
<li>CHARACTER, ITEM, TRIGGER, and SPLINE: objects that are currently loaded in the game. This includes globals and locals of the curently loaded level. The script will assert if the script uses an object that isn't currently loaded. It will also warn you if the character's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_GLO_Dallis, S_MyFirstItem, ...</li>
<li>RELATION_TYPE: only used in a handful actions. A list of possible relation types can be found [[scripting_relation_types|here]].</li>
<li>SKILL_ID: the name/id of a skill as it can be found in [[skill_creation|SkillData]]. For example: Target_Bless, Projectile_Fireball, ...</li>
<li>SURFACE_TYPE: surface types can be found [[scripting_surface_types|here]].</li>
<li>STATUS_TYPE: status types can be found [[Scripting_status_types|here]].</li>
<li>CHARACTERSTAT_TYPE: characterstat types can be found [[Scripting_characterstat_types|here]].</li>
<li>ITEMSTAT_TYPE: itemstat types can be found [[Scripting_itemstat_types|here]].</li>
<li>WEAPON_TYPE: weapon types can be found [[Scripting_weapon_types|here]].</li>
<li>DAMAGE_TYPE: damage types can be found [[Scripting_damage_types|here]].</li>
<li>TALENT_TYPE: talent types can be found [[Scripting_talent_types|here]].</li>
<li>COMPARE_TYPE: compare types can be found [[Scripting_compare_types|here]].</li>
<li>COMPARE_FUNCTION: compare functions can be found [[Scripting_compare_functions|here]].</li>
<li>FLOAT3: floats are written as {number;number;number}, and can contain integers as well</li>
<li>CHARACTERTEMPLATE, ITEMTEMPLATE, and PROJECTILETEMPLATE: the script will warn you if the template's name does not start with the prefix 'S_'. This prefix helps to prevent objects being deleted because they aren't used (they could be used in script). For example: S_Chair_A, S_Human_Male_B, ...</li>
<li>POTION_ID: all loaded potions from stats</li>
<li>ABILITY_TYPE: ability types can be found [[Scripting_ability_types|here]].</li>
<li>DEATH_TYPE: death types can be found [[Scripting_death_types|here]].</li>
<li>STATUS_ID: all loaded statuses from stats</li>
<li>ARCHETYPE: all available archetypes that are loaded. More information on archetypes can be found [[CombatAi_Archetypes_and_Modifiers|here]].</li>
<li>SURFACE_TRANSFORM_TYPE: surface transform types can be found [[Scripting_surface_transform_types|here]].</li>
</ul>
 
===Lists===
Lists are a special parameter type and contain multiple parameters of a single type. 
Important note: Lists are more convenient, but they are slower than normal parameters. They also have a limited size, so don't try to fill them with thousands of entries. 
Declaring a list:
<pre>
LIST<INT>:%TestListInt // Fine
LIST<CHARACTER>:%TestListCharacter // Fine
LIST<LIST<INT>>:%TestListNested // Error, can't nest lists
</pre>
Adding entries:
<pre>
ListAdd(%TestListInt, 0) // Fine
ListAdd(%TestListInt, {0;1;2}) // Error, trying to add a FLOAT3 to an INT LIST
</pre>
Removing entries: indices start at 1, and end at the list size. All entries after the removed entry will be shifted to the left:
<pre>
ListRemove(%TestListInt, 1) // Fine, assuming that the list has 1 or more entries
ListRemove(%TestListInt, 0) // Error, invalid index
</pre>
Setting or getting entries:
<pre>
ListSet(%TestListInt, 1, %AnInt) // Fine
ListGet(%TestListInt, 1, %AnInt)

ListSet(%TestListInt, 1, %ACharacter) // Error, trying to set a CHARACTER in an INT LIST
ListGet(%TestListInt, 1, %ACharacter)

ListSet(%TestListInt, 0, %AnInt) // Error, invalid index
ListGet(%TestListInt, 0, %AnInt)
</pre>
Getting the list size:
<pre>
ListGetSize(%TestList, %ListSize)
</pre>
Clearing a list:
<pre>
ListClear(%TestList)
</pre>
Important note: Lists currently do not support EXTERN, constants, and STRING , meaning that the following lines will not work in scripts and result in an error during script build:
<pre>
LIST<INT>:%TestList = {1, 2, 3, 4, 5} // Using a constant to initialize
ListGetSize({1, 2, 3, 4}, %ListSize) // Using a constant in an action call
EXTERN LIST<INT>:%TestList = {1, 2} // Using EXTERN and using a constant to initialize
LIST<STRING>:%TestString // Using STRING as the type
</pre>
Now, how would you use these lists?
 

=Important Events=
===OnInit and OnShutDown===
OnInit is called each time on all objects in the level when the level is loaded, and OnShutdown is called when the level is unloaded. This would be the place where you can create/destroy your looping effects that should always be on the object.
 
===OnLoaded===
OnLoaded is called when the savegame is loaded or when the levelcache is loaded (levelswap). The version of the savegame is passed so you can do your patching "hacks" if necessary.
 
===Interrupts===
Interrupts are only called on reactions and can only be caught on that reaction:
<ul>
<li>OnBetterReactionFound: a higher priority reaction succeeded its check</li>
<li>OnNoReactionFound: no reaction has succeeded its check</li>
<li>OnScriptDisabled: another system has taken control (dialogs, statuses, story)</li>
<li>OnManualInterrupt: the Interrupt action itself has caused the interrupt</li>
<li>OnMovementFailed: pathfinding has failed to find a path to the target</li>
<li>OnException: a character task has failed</li></ul>
 
===OnFunction===
You can create your own "functions' with CallFunction("functionName") and catching the event OnFunction("functionName"). This way you can share functionality between multiple events and reactions. You can not pass parameters directly, but you could set some function-specific global variables which the function uses and can even 'return' results in.
 
=Culling=
For performance reasons we only update a small set of all the characters & items in the level. 
The updating characters are:
<ul>
<li>Force updating (can be set in script/story, but should only be used in an emergency!)</li>
<li>In Combat</li>
<li>Executing Osiris Tasks</li>
<li>In range of the party (within 40m)</li>
</ul>
The updating items are:
<ul>
<li>Force updating (can be set in script/story using ItemSetForceSynch(), but should only be used in an emergency!)</li>
<li>In Combat</li>
<li>Moving</li>
<li>In range of the party (within 40m)</li>
</ul>
This means that in most cases objects far away from the party get culled and stop updating. When an object doesn't update anymore this means the behaviour is interrupted and won't be executed anymore. However, events always get executed, so culling has no impact on this. Another consequence of culling is that timers of that script are not ticking anymore and are basically paused.
 
=Debugging=
There are 4 ways to help you debug:
<ul>
<li>The script debugger in the script editor</li>
<li>CTRL+SHIFT+ClICK on the object you wish to debug to show the Script Screen, and CTRL+SHIFT+SCROLL to the Script and/or Variables screen to see what the current state is.</li>
<li>Add a whole bunch of DebugText output in your code to see which code is called in what order.</li>
<li>Start the script log for an object, which logs as much stuff as possible about the script (reactions, interrupts, events, ...)</li>
</ul>
 
===Script Debugger===
See the [[script_debugger|Script Debugger]] page for more information.
 
===Script Screen===
On the left side of the Script Screen it shows the script variables, the script reactions (ordered from high priority to low), and the current Event it catches. It colors the reactions gray (not checked), green (check passed), and red (check failed). At the right you can see the current reaction's conditions and actions. You can see which action is currently executing and you can see the return results of the conditions from the check: gray (not evaluated), green (TRUE), and red (FALSE). 
You can filter in the script variables through the [[console|console]] by using: "filtervar <filter>".
Tip: type "filtervar asdf" or something to remove all variables so you can see all the reactions! 
You can also change which reaction you want to see at the right, by entering the number of that reaction in the console. This way you can easily check why certain reactions are never succeeding their CHECK by checking the return values of the conditions. To do this first you must activate this mode, by entering "show server" in the console. Then you can type the number of the wanted reaction or type "0" to show the current reaction again.
 
===DebugText===
You can put DebugText in events/scriptframes/reactions to print text in the world on any object you want. This way you can easily see if you get in the code you wrote and you can also print any variable's value at that time. To print the variables we use the same syntax as translated strings: [1] [2] [3] ... 
For example:
<pre>
DebugText(__Me,"Target: [1], Speed is [2]",_Target,%Speed)
</pre>
For characters, items, triggers, splines, and templates the name will be shown in the debug text. Numbers will be shown in full, and all other variables will be directly converted to strings.
 
===ScriptLog===
You can also start/stop the scriptlog in console with:
<ul>
<li>"ai log all": Start the scriptlog for all character/items.</li>
<li>"ai log none": Stop the scriptlog for all character/items.</li>
<li>"ai log selected": Toggle the separate scriptlog for the selected (CTRL+SHIFT+CLICK) object</li>
</ul>
It will generate scriptlog file(s) right next to the executable.
 
=Common Mistakes=
===Reset()===
<pre>
REACTION CastSkill, 1000
USAGE COMBAT
VARS
FLOAT:_minRange
FLOAT:_maxRange
CHECK "!c1&c2&c3"
IsEqual(%SkillTarget,null)
CharacterCanCast(__Me,Projectile_Fireball,0)
CharacterGetSkillRange(_minRange,_maxRange,__MeProjectile_Fireball)
ACTIONS
CharacterMoveInRange(%SkillTarget,_minRange,_maxRange,1)
PlayEffectAt(__Me, "FX_GP_HugeFireball_A")
CharacterUseSkill(Projectile_Fireball,%SkillTarget)
</pre>
In this case we have a reaction that will move in range of the target and as soon as we are in range we will play an effect and cast a fireball. However, if this reaction gets interrupted during the playeffect, next time this reaction becomes active again we will just cast a fireball on the target even when we would not be in range and didn't play the effect. This is why in these cases you should add an INTERRUPT to Reset() the reaction.

===CHECK or IF===
<pre>
REACTION CastSkill,1000
USAGE COMBAT
VARS
FLOAT:_minRange
FLOAT:_maxRange
CHECK "!c1&c2"
IsEqual(%SkillTarget,null)
CharacterGetSkillRange(_minRange,_maxRange,__MeProjectile_Fireball)
ACTIONS
IF "c1"
CharacterCanCast(__Me,Projectile_Fireball,0)
THEN
CharacterMoveInRange(%SkillTarget,_minRange,_maxRange,1)
PlayEffectAt(__Me, "FX_GP_HugeFireball_A")
CharacterUseSkill(Projectile_Fireball,%SkillTarget)
ENDIF
INTERRUPT
Reset()
</pre>
In this case we're checking something in the reaction when it's executing, but we don't do anything if the IF fails. There is no ELSE behaviour. This means that in combat this reaction could keep failing and not do anything, which will cause a ForceEndTurn for that character. Here we should have checked CharacterCanCast in the CHECK and not write a separate IF check. In general when the IF check in a REACTION is blocking the whole REACTION from executing it's probably better to place it in the CHECK instead.
 
===Check order===
<pre>
IF "c1&c2&!c3&c4"
CharacterGetStat(_Vitality, __Me, Vitality) // Fetch before checking
IsGreaterThen(_Vitality, 0.5)
IsEqual(_Character, null) // Null check before checking
CharacterIsPlayer(_Character)
THEN
// Do something
ENDIF
</pre>
Make sure to perform your checks in the right order. Before checking a stat make sure to fetch it. Before checking if the character is a player consider checking if it is a valid player. Could it be the player is off stage? Could it be dead? Is it even set?

Scripting death types

2017-09-13T18:25:12Z

Rimevan: Created page with "The following death types can be used in script: <ul> <li>None</li> <li>Physical</li> <li>Piercing</li> <li>Arrow</li> <li>DoT</li> <li>Incinerate</li> <li>Acid</li> <li>Elect..."

The following death types can be used in script:
<ul>
<li>None</li>
<li>Physical</li>
<li>Piercing</li>
<li>Arrow</li>
<li>DoT</li>
<li>Incinerate</li>
<li>Acid</li>
<li>Electrocution</li>
<li>FrozenShatter</li>
<li>PetrifiedShatter</li>
<li>Explode</li>
<li>Surrender</li>
<li>Hang</li>
<li>KnockedDown</li>
<li>Lifetime</li>
</ul>