Divinity Engine Wiki - User contributions [en]

Script debugger

2017-08-07T13:03:54Z

Larian octaaf:

<h1>The interface</h1>
The script debugger is part of the script editor and it has 3 main areas:
[[File:Interface script editor.png]]
<ol><li>Debug toolbar, with buttons and comboboxes for basic debug functions.</li>
<li>An object panel, containing all the scripts of an object. The object panel is used to place breakpoints and to show the actual stepping.</li>
<li>The debug panels: errors, watch, and output. Watch and output are only actuve when debugging is enabled. The watch panel provides info on script parameters during debugging, while the output panel shows the debug flow output and user output.</li>
</ol>
<h2>Debug toolbar</h2>
<div>
[[File:Interface debug toolbar.png]]
 
</div>
<ol><li>Checkbox to enable/disable debugging features. Without this enabled no debug features will work, neither will the watch and output panel.</li>
<li>[Alt+Pause] Pause button to pause the game as soon as possible. In practice it will break in the very first script of the frame.</li>
<li>[F5] Continue button to continue the game when debugging.</li>
<li>[F10] Step button to execute a 'step' when debugging. What this step is and in which script it will do this step is dependent on the following comboboxes (5, 6, and 7).</li>
<li>A combobox to select the stepping type. 'Step in scripts' will step 1 action/condition forward in the script being debugged. 'Step in objects' will step 1 action/condition forward in the object being debugged. An object can have more than 1 script, meaning that a step might break in another script attached to the object.</li>
<li>A combobox to select the debug object. All objects (whether item or character) with a script attached are available for selection. Whenever a step is made the object in this combobox is the object being stepped through. Selecting an object will open and show an object panel for the selected object.</li>
<li>A combobox to select the debug script. The options are the scripts attached to the selected debug object. This combobox will be empty if no debug object is selected. Whenever a step is made the script in this combobox is the script being stepped through. Selecting a script will open and show an object panel for the selected object and show the selected script.</li>
<li>Checkbox to enable/disable the following of the debug helper. When enabled the debugger will always open the object file for the currently selected object in the debug helper (activated with CTRL+SHIFT+LMB).</li>
</ol>
<h2>Object panel</h2>
<div>
[[File:Interface object panel.png]]
</div>
<ol><li>An object panel tab name is always preceded by 'Object - ', while a script panel is preceded by 'Script - '.</li>
<li>A green bar if the object is active (= executing scripts) or a red bar if the object is inactive.</li>
<li>All scripts that are attached to the object have their own tab. All these panels are read-only and are only used for debugging.</li>
<li>When clicking this button it will select the object and script of this panel in the comboboxes in the debug toolbar.</li>
<li>A breakpoint that will 'break' (pause) the script whenever it is about to execute the line it has been placed on. Place a breakpoint by clicking in the margin next to the linenumbers and remove it by clicking the breakpoint again. If a breakpoint is disabled it will be white instead of red. If a breakpoint has conditions it will have a cross as well.</li>
<li>The yellow arrow and grey background indicate the line that's about to be executed in the next step. These markers are only visible when debugging.</li>
</ol>
When a script is included in another script it's still attached to the object. This is not always as obvious due to recursive includes, so a blue bar will notify you in that case:
[[File:Interface included file.png]]

<h3>Breakpoint context menu</h3>
The breakpoint context menu can be accessed by CTRL+Click on a breakpoint:
[[File:Interface breakpoint.png]]
It allows you to enable or disable the breakpoint (a disabled breakpoint will never break), access the breakpoint conditions menu, or to reset or view the hit count. The hit count of a breakpoint is the amount of times that line has been 'hit'/executed.
<h3>Breakpoint conditions menu</h3>
The breakpoint conditions menu can be accessed via the previously mentioned breakpoint context menu:
[[File:Interface breakpoint conditions.png]]
 
The menu is used to create conditional breakpoints: breakpoints that only break when all conditions pass. As can be seen there are two types:
<ol><li>Hit count: set a condition for the hit count by checking whether the hit count is equal to, not equal to, larger than or equal to, smaller than, or a multiple of your entered hit count.</li>
<li>Expression: set a condition by comparing the value of a parameter and check if it's equal to, not equal to, larger than or equal to, or smaller than your entered value. Checking whether a STRING is smaller than another STRING might not be best idea here. It would work for INT and FLOAT though.</li>
</ol>
<h3>Hover menu</h3>
The hover menu shows up when you're debugging and the mouse pointer hovers over a parameter for 0.5 or more seconds:
[[File:Interface hover.png]]
 
It's a quick way to see the value of a parameter, and it's not necessary to actually break to see the value.
<h2>Debug panels</h2>
All debug panels can be opened via the 'View'-dropdown in the menubar.
<h3>Watch panel</h3>
<div>
[[File:Interface watch panel.png]]
 
</div>
<ol><li>Filters for the script paramaters based on the file, scope, and name. Multiple filters can be added if seperated by a space (e.g. "filter1 filter2").</li>
<li>All script parameters of the object that is currently being debugged. The scope column contains 'Global' if the script parameter is not part of a reaction, interrupt, event, or scriptframe. The value column contains 'NULL' if the script parameter containts no data.</li>
</ol>
<h3>Output panel</h3>
<div>
[[File:Interface_output_panel.png]]
 
</div>
<ol><li>Clear the output panel of all output. This will not clear the saved output file.</li>
<li>This part contains all output messages. It will automatically scroll to the last output message if the mouse pointer is located after the last message and no selection has been made.</li>
</ol>
It is possible to output text in the output panel with the Output() action:
<pre>EVENTS
EVENT ExampleEvent
ON
OnTimer("ExampleTimer")
VARS
FIXEDSTRING:_ExampleFixedString="ExampleFixedString"
ACTIONS
Output("Example output with a fixed string '[1]' and an int [2]", _ExampleFixedString, INT:10)
</pre>
The script event above would output the following text:
<pre>01:23:45.678: [CurrentDebugObject | CurrentDebugScript.charScript | 10]: Example output with a fixed string 'ExampleFixedString' and an int 10
</pre>
As you can see, most output is preceded by some extra info on the location of the output (if relevant).
<h1>Debugging</h1>
Before you start debugging there are a few more things you need to know.
<h2>Starting and stopping a debug session</h2>
Starting and stopping a debug session can be done in both editor and game mode. To start or stop a debug session all you need to do is to enable 'Debug' in the debug toolbar. Starting a debug session will not change the behavior of the game, but you will start seeing output in the output panel if there is any. The watch panel will not contain any data until you break in a script by pausing or due to a breakpoint. The pause button and breakpoints will start working when you start a debug session as well.
<h2>Stepping through an object or script</h2>
Once you've got a debug session running you can start to actually debug a script. You can do this by putting a breakpoint on the line where you would like to pause the script. When that line is about to be executed the script will pause. When the script is paused you can step with the 'step' button. This will execute the current line and then break on the next line. The next line could be in a different script in the same object. The next script break location depends on your step setting (in the combobox). When the script is paused it is possible to change the current debug object and/or script in the comboboxes in the debug toolbar. This will cause the next step to break the script in the newly selected object and script.
<h2>Breakpoints</h2>
Breakpoints do not only have a line location, but an object and script location as well. Multiple objects can have the same script, but when you place a breakpoint it will count for only one of those. The actual breakpoint location is dependent on the object panel you used when placing the breakpoint. Also, not all locations are valid breakpoint locations. The only valid locations are lines that can be executed (i.e. actions, conditions, 'IF', and 'ELSE'). In the following code snippit the only valid line would be the last one:
<pre>EVENTS
EVENT Init
ON
OnInit()
ACTIONS
Output("OutputText")
</pre>
<h2>Script break</h2>
A script break will pause both the game and script. Right before the script is about to execute the line it will break (due to a breakpoint or a requested pause). After this script break nothing besides the script editor will update. This also means that there is no way to use other debug tools, like the console, during a script break. This is purely due to the nature of a debugger. If anything would be allowed to update during a script break it would invalidate the debug data and it would become unreliable.

File:Interface breakpoint.png

2017-08-07T13:01:49Z

Larian octaaf:

Script debugger

2017-08-07T13:00:57Z

Larian octaaf:

<h1>The interface</h1>
The script debugger is part of the script editor and it has 3 main areas:
[[File:Interface script editor.png]]
<ol><li>Debug toolbar, with buttons and comboboxes for basic debug functions.</li>
<li>An object panel, containing all the scripts of an object. The object panel is used to place breakpoints and to show the actual stepping.</li>
<li>The debug panels: errors, watch, and output. Watch and output are only actuve when debugging is enabled. The watch panel provides info on script parameters during debugging, while the output panel shows the debug flow output and user output.</li>
</ol>
<h2>Debug toolbar</h2>
<div>
[[File:Interface debug toolbar.png]]
 
</div>
<ol><li>Checkbox to enable/disable debugging features. Without this enabled no debug features will work, neither will the watch and output panel.</li>
<li>[Alt+Pause] Pause button to pause the game as soon as possible. In practice it will break in the very first script of the frame.</li>
<li>[F5] Continue button to continue the game when debugging.</li>
<li>[F10] Step button to execute a 'step' when debugging. What this step is and in which script it will do this step is dependent on the following comboboxes (5, 6, and 7).</li>
<li>A combobox to select the stepping type. 'Step in scripts' will step 1 action/condition forward in the script being debugged. 'Step in objects' will step 1 action/condition forward in the object being debugged. An object can have more than 1 script, meaning that a step might break in another script attached to the object.</li>
<li>A combobox to select the debug object. All objects (whether item or character) with a script attached are available for selection. Whenever a step is made the object in this combobox is the object being stepped through. Selecting an object will open and show an object panel for the selected object.</li>
<li>A combobox to select the debug script. The options are the scripts attached to the selected debug object. This combobox will be empty if no debug object is selected. Whenever a step is made the script in this combobox is the script being stepped through. Selecting a script will open and show an object panel for the selected object and show the selected script.</li>
<li>Checkbox to enable/disable the following of the debug helper. When enabled the debugger will always open the object file for the currently selected object in the debug helper (activated with CTRL+SHIFT+LMB).</li>
</ol>
<h2>Object panel</h2>
<div>
[[File:Interface object panel.png]]
</div>
<ol><li>An object panel tab name is always preceded by 'Object - ', while a script panel is preceded by 'Script - '.</li>
<li>A green bar if the object is active (= executing scripts) or a red bar if the object is inactive.</li>
<li>All scripts that are attached to the object have their own tab. All these panels are read-only and are only used for debugging.</li>
<li>When clicking this button it will select the object and script of this panel in the comboboxes in the debug toolbar.</li>
<li>A breakpoint that will 'break' (pause) the script whenever it is about to execute the line it has been placed on. Place a breakpoint by clicking in the margin next to the linenumbers and remove it by clicking the breakpoint again. If a breakpoint is disabled it will be white instead of red. If a breakpoint has conditions it will have a cross as well.</li>
<li>The yellow arrow and grey background indicate the line that's about to be executed in the next step. These markers are only visible when debugging.</li>
</ol>
When a script is included in another script it's still attached to the object. This is not always as obvious due to recursive includes, so a blue bar will notify you in that case:
[[File:Interface included file.png]]

<h3>Breakpoint context menu</h3>
The breakpoint context menu can be accessed by CTRL+Click on a breakpoint:
[[File:Interface breakpoint.png]]
It allows you to enable or disable the breakpoint (a disabled breakpoint will never break), access the breakpoint conditions menu, or to reset or view the hit count. The hit count of a breakpoint is the amount of times that line has been 'hit'/executed.
<h3>Breakpoint conditions menu</h3>
The breakpoint conditions menu can be accessed via the previously mentioned breakpoint context menu:
[[File:Interface breakpoint conditions.png]]
 
The menu is used to create conditional breakpoints: breakpoints that only break when all conditions pass. As can be seen there are two types:
<ol><li>Hit count: set a condition for the hit count by checking whether the hit count is equal to, not equal to, larger than or equal to, smaller than, or a multiple of your entered hit count.</li>
<li>Expression: set a condition by comparing the value of a parameter and check if it's equal to, not equal to, larger than or equal to, or smaller than your entered value. Checking whether a STRING is smaller than another STRING might not be best idea here. It would work for INT and FLOAT though.</li>
</ol>
<h3>Hover menu</h3>
The hover menu shows up when you're debugging and the mouse pointer hovers over a parameter for 0.5 or more seconds:
[[File:Interface hover.png]]
 
It's a quick way to see the value of a parameter, and it's not necessary to actually break to see the value.
<h2>Debug panels</h2>
All debug panels can be opened via the 'View'-dropdown in the menubar.
<h3>Watch panel</h3>
<div>
[[File:Interface watch panel.png]]
 
</div>
<ol><li>Filters for the script paramaters based on the file, scope, and name. Multiple filters can be added if seperated by a space (e.g. "filter1 filter2").</li>
<li>All script parameters of the object that is currently being debugged. The scope column contains 'Global' if the script parameter is not part of a reaction, interrupt, event, or scriptframe. The value column contains 'NULL' if the script parameter containts no data.</li>
</ol>
<h3>Output panel</h3>
<div>
[[File:Interface output panel]]
 
</div>
<ol><li>Clear the output panel of all output. This will not clear the saved output file.</li>
<li>This part contains all output messages. It will automatically scroll to the last output message if the mouse pointer is located after the last message and no selection has been made.</li>
</ol>
It is possible to output text in the output panel with the Output() action:
<pre>EVENTS
EVENT ExampleEvent
ON
OnTimer("ExampleTimer")
VARS
FIXEDSTRING:_ExampleFixedString="ExampleFixedString"
ACTIONS
Output("Example output with a fixed string '[1]' and an int [2]", _ExampleFixedString, INT:10)
</pre>
The script event above would output the following text:
<pre>01:23:45.678: [CurrentDebugObject | CurrentDebugScript.charScript | 10]: Example output with a fixed string 'ExampleFixedString' and an int 10
</pre>
As you can see, most output is preceded by some extra info on the location of the output (if relevant).
<h1>Debugging</h1>
Before you start debugging there are a few more things you need to know.
<h2>Starting and stopping a debug session</h2>
Starting and stopping a debug session can be done in both editor and game mode. To start or stop a debug session all you need to do is to enable 'Debug' in the debug toolbar. Starting a debug session will not change the behavior of the game, but you will start seeing output in the output panel if there is any. The watch panel will not contain any data until you break in a script by pausing or due to a breakpoint. The pause button and breakpoints will start working when you start a debug session as well.
<h2>Stepping through an object or script</h2>
Once you've got a debug session running you can start to actually debug a script. You can do this by putting a breakpoint on the line where you would like to pause the script. When that line is about to be executed the script will pause. When the script is paused you can step with the 'step' button. This will execute the current line and then break on the next line. The next line could be in a different script in the same object. The next script break location depends on your step setting (in the combobox). When the script is paused it is possible to change the current debug object and/or script in the comboboxes in the debug toolbar. This will cause the next step to break the script in the newly selected object and script.
<h2>Breakpoints</h2>
Breakpoints do not only have a line location, but an object and script location as well. Multiple objects can have the same script, but when you place a breakpoint it will count for only one of those. The actual breakpoint location is dependent on the object panel you used when placing the breakpoint. Also, not all locations are valid breakpoint locations. The only valid locations are lines that can be executed (i.e. actions, conditions, 'IF', and 'ELSE'). In the following code snippit the only valid line would be the last one:
<pre>EVENTS
EVENT Init
ON
OnInit()
ACTIONS
Output("OutputText")
</pre>
<h2>Script break</h2>
A script break will pause both the game and script. Right before the script is about to execute the line it will break (due to a breakpoint or a requested pause). After this script break nothing besides the script editor will update. This also means that there is no way to use other debug tools, like the console, during a script break. This is purely due to the nature of a debugger. If anything would be allowed to update during a script break it would invalidate the debug data and it would become unreliable.

Script debugger

2017-08-07T12:56:21Z

Larian octaaf:

<h1>The interface</h1>
The script debugger is part of the script editor and it has 3 main areas:
[[File:Interface script editor.png]]
<ol><li>Debug toolbar, with buttons and comboboxes for basic debug functions.</li>
<li>An object panel, containing all the scripts of an object. The object panel is used to place breakpoints and to show the actual stepping.</li>
<li>The debug panels: errors, watch, and output. Watch and output are only actuve when debugging is enabled. The watch panel provides info on script parameters during debugging, while the output panel shows the debug flow output and user output.</li>
</ol>
<h2>Debug toolbar</h2>
<div>
[[File:Interface debug toolbar.png]]
 
</div>
<ol><li>Checkbox to enable/disable debugging features. Without this enabled no debug features will work, neither will the watch and output panel.</li>
<li>[Alt+Pause] Pause button to pause the game as soon as possible. In practice it will break in the very first script of the frame.</li>
<li>[F5] Continue button to continue the game when debugging.</li>
<li>[F10] Step button to execute a 'step' when debugging. What this step is and in which script it will do this step is dependent on the following comboboxes (5, 6, and 7).</li>
<li>A combobox to select the stepping type. 'Step in scripts' will step 1 action/condition forward in the script being debugged. 'Step in objects' will step 1 action/condition forward in the object being debugged. An object can have more than 1 script, meaning that a step might break in another script attached to the object.</li>
<li>A combobox to select the debug object. All objects (whether item or character) with a script attached are available for selection. Whenever a step is made the object in this combobox is the object being stepped through. Selecting an object will open and show an object panel for the selected object.</li>
<li>A combobox to select the debug script. The options are the scripts attached to the selected debug object. This combobox will be empty if no debug object is selected. Whenever a step is made the script in this combobox is the script being stepped through. Selecting a script will open and show an object panel for the selected object and show the selected script.</li>
<li>Checkbox to enable/disable the following of the debug helper. When enabled the debugger will always open the object file for the currently selected object in the debug helper (activated with CTRL+SHIFT+LMB).</li>
</ol>
<h2>Object panel</h2>
<div>
[[File:Interface object panel.png]]
</div>
<ol><li>An object panel tab name is always preceded by 'Object - ', while a script panel is preceded by 'Script - '.</li>
<li>A green bar if the object is active (= executing scripts) or a red bar if the object is inactive.</li>
<li>All scripts that are attached to the object have their own tab. All these panels are read-only and are only used for debugging.</li>
<li>When clicking this button it will select the object and script of this panel in the comboboxes in the debug toolbar.</li>
<li>A breakpoint that will 'break' (pause) the script whenever it is about to execute the line it has been placed on. Place a breakpoint by clicking in the margin next to the linenumbers and remove it by clicking the breakpoint again. If a breakpoint is disabled it will be white instead of red. If a breakpoint has conditions it will have a cross as well.</li>
<li>The yellow arrow and grey background indicate the line that's about to be executed in the next step. These markers are only visible when debugging.</li>
</ol>
When a script is included in another script it's still attached to the object. This is not always as obvious due to recursive includes, so a blue bar will notify you in that case:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_included_file.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_included_file.png"></a></div>

<h3>Breakpoint context menu</h3>
The breakpoint context menu can be accessed by CTRL+Click on a breakpoint:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint.png"></a></div>
 
It allows you to enable or disable the breakpoint (a disabled breakpoint will never break), access the breakpoint conditions menu, or to reset or view the hit count. The hit count of a breakpoint is the amount of times that line has been 'hit'/executed.
<h3>Breakpoint conditions menu</h3>
The breakpoint conditions menu can be accessed via the previously mentioned breakpoint context menu:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint_conditions.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint_conditions.png"></a></div>
 
The menu is used to create conditional breakpoints: breakpoints that only break when all conditions pass. As can be seen there are two types:
<ol><li>Hit count: set a condition for the hit count by checking whether the hit count is equal to, not equal to, larger than or equal to, smaller than, or a multiple of your entered hit count.</li>
<li>Expression: set a condition by comparing the value of a parameter and check if it's equal to, not equal to, larger than or equal to, or smaller than your entered value. Checking whether a STRING is smaller than another STRING might not be best idea here. It would work for INT and FLOAT though.</li>
</ol>
<h3>Hover menu</h3>
The hover menu shows up when you're debugging and the mouse pointer hovers over a parameter for 0.5 or more seconds:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_hover.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_hover.png"></a></div>
 
It's a quick way to see the value of a parameter, and it's not necessary to actually break to see the value.
<h2>Debug panels</h2>
All debug panels can be opened via the 'View'-dropdown in the menubar.
<h3>Watch panel</h3>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_watch_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_watch_panel.png"></a></div>
 
</div>
<ol><li>Filters for the script paramaters based on the file, scope, and name. Multiple filters can be added if seperated by a space (e.g. "filter1 filter2").</li>
<li>All script parameters of the object that is currently being debugged. The scope column contains 'Global' if the script parameter is not part of a reaction, interrupt, event, or scriptframe. The value column contains 'NULL' if the script parameter containts no data.</li>
</ol>
<h3>Output panel</h3>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_output_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_output_panel.png"></a></div>
 
</div>
<ol><li>Clear the output panel of all output. This will not clear the saved output file.</li>
<li>This part contains all output messages. It will automatically scroll to the last output message if the mouse pointer is located after the last message and no selection has been made.</li>
</ol>
It is possible to output text in the output panel with the Output() action:
<pre>EVENTS
EVENT ExampleEvent
ON
OnTimer("ExampleTimer")
VARS
FIXEDSTRING:_ExampleFixedString="ExampleFixedString"
ACTIONS
Output("Example output with a fixed string '[1]' and an int [2]", _ExampleFixedString, INT:10)
</pre>
The script event above would output the following text:
<pre>01:23:45.678: [CurrentDebugObject | CurrentDebugScript.charScript | 10]: Example output with a fixed string 'ExampleFixedString' and an int 10
</pre>
As you can see, most output is preceded by some extra info on the location of the output (if relevant).
<h1>Debugging</h1>
Before you start debugging there are a few more things you need to know.
<h2>Starting and stopping a debug session</h2>
Starting and stopping a debug session can be done in both editor and game mode. To start or stop a debug session all you need to do is to enable 'Debug' in the debug toolbar. Starting a debug session will not change the behavior of the game, but you will start seeing output in the output panel if there is any. The watch panel will not contain any data until you break in a script by pausing or due to a breakpoint. The pause button and breakpoints will start working when you start a debug session as well.
<h2>Stepping through an object or script</h2>
Once you've got a debug session running you can start to actually debug a script. You can do this by putting a breakpoint on the line where you would like to pause the script. When that line is about to be executed the script will pause. When the script is paused you can step with the 'step' button. This will execute the current line and then break on the next line. The next line could be in a different script in the same object. The next script break location depends on your step setting (in the combobox). When the script is paused it is possible to change the current debug object and/or script in the comboboxes in the debug toolbar. This will cause the next step to break the script in the newly selected object and script.
<h2>Breakpoints</h2>
Breakpoints do not only have a line location, but an object and script location as well. Multiple objects can have the same script, but when you place a breakpoint it will count for only one of those. The actual breakpoint location is dependent on the object panel you used when placing the breakpoint. Also, not all locations are valid breakpoint locations. The only valid locations are lines that can be executed (i.e. actions, conditions, 'IF', and 'ELSE'). In the following code snippit the only valid line would be the last one:
<pre>EVENTS
EVENT Init
ON
OnInit()
ACTIONS
Output("OutputText")
</pre>
<h2>Script break</h2>
A script break will pause both the game and script. Right before the script is about to execute the line it will break (due to a breakpoint or a requested pause). After this script break nothing besides the script editor will update. This also means that there is no way to use other debug tools, like the console, during a script break. This is purely due to the nature of a debugger. If anything would be allowed to update during a script break it would invalidate the debug data and it would become unreliable.

Script debugger

2017-08-07T12:55:29Z

Larian octaaf:

<h1>The interface</h1>
The script debugger is part of the script editor and it has 3 main areas:
[[File:Interface script editor.png]]
<ol><li>Debug toolbar, with buttons and comboboxes for basic debug functions.</li>
<li>An object panel, containing all the scripts of an object. The object panel is used to place breakpoints and to show the actual stepping.</li>
<li>The debug panels: errors, watch, and output. Watch and output are only actuve when debugging is enabled. The watch panel provides info on script parameters during debugging, while the output panel shows the debug flow output and user output.</li>
</ol>
<h2>Debug toolbar</h2>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_debug_toolbar.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_debug_toolbar.png"></a></div>
 
</div>
<ol><li>Checkbox to enable/disable debugging features. Without this enabled no debug features will work, neither will the watch and output panel.</li>
<li>[Alt+Pause] Pause button to pause the game as soon as possible. In practice it will break in the very first script of the frame.</li>
<li>[F5] Continue button to continue the game when debugging.</li>
<li>[F10] Step button to execute a 'step' when debugging. What this step is and in which script it will do this step is dependent on the following comboboxes (5, 6, and 7).</li>
<li>A combobox to select the stepping type. 'Step in scripts' will step 1 action/condition forward in the script being debugged. 'Step in objects' will step 1 action/condition forward in the object being debugged. An object can have more than 1 script, meaning that a step might break in another script attached to the object.</li>
<li>A combobox to select the debug object. All objects (whether item or character) with a script attached are available for selection. Whenever a step is made the object in this combobox is the object being stepped through. Selecting an object will open and show an object panel for the selected object.</li>
<li>A combobox to select the debug script. The options are the scripts attached to the selected debug object. This combobox will be empty if no debug object is selected. Whenever a step is made the script in this combobox is the script being stepped through. Selecting a script will open and show an object panel for the selected object and show the selected script.</li>
<li>Checkbox to enable/disable the following of the debug helper. When enabled the debugger will always open the object file for the currently selected object in the debug helper (activated with CTRL+SHIFT+LMB).</li>
</ol>
<h2>Object panel</h2>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_object_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_object_panel.png"></a></div>
 
</div>
<ol><li>An object panel tab name is always preceded by 'Object - ', while a script panel is preceded by 'Script - '.</li>
<li>A green bar if the object is active (= executing scripts) or a red bar if the object is inactive.</li>
<li>All scripts that are attached to the object have their own tab. All these panels are read-only and are only used for debugging.</li>
<li>When clicking this button it will select the object and script of this panel in the comboboxes in the debug toolbar.</li>
<li>A breakpoint that will 'break' (pause) the script whenever it is about to execute the line it has been placed on. Place a breakpoint by clicking in the margin next to the linenumbers and remove it by clicking the breakpoint again. If a breakpoint is disabled it will be white instead of red. If a breakpoint has conditions it will have a cross as well.</li>
<li>The yellow arrow and grey background indicate the line that's about to be executed in the next step. These markers are only visible when debugging.</li>
</ol>
When a script is included in another script it's still attached to the object. This is not always as obvious due to recursive includes, so a blue bar will notify you in that case:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_included_file.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_included_file.png"></a></div>

<h3>Breakpoint context menu</h3>
The breakpoint context menu can be accessed by CTRL+Click on a breakpoint:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint.png"></a></div>
 
It allows you to enable or disable the breakpoint (a disabled breakpoint will never break), access the breakpoint conditions menu, or to reset or view the hit count. The hit count of a breakpoint is the amount of times that line has been 'hit'/executed.
<h3>Breakpoint conditions menu</h3>
The breakpoint conditions menu can be accessed via the previously mentioned breakpoint context menu:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint_conditions.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint_conditions.png"></a></div>
 
The menu is used to create conditional breakpoints: breakpoints that only break when all conditions pass. As can be seen there are two types:
<ol><li>Hit count: set a condition for the hit count by checking whether the hit count is equal to, not equal to, larger than or equal to, smaller than, or a multiple of your entered hit count.</li>
<li>Expression: set a condition by comparing the value of a parameter and check if it's equal to, not equal to, larger than or equal to, or smaller than your entered value. Checking whether a STRING is smaller than another STRING might not be best idea here. It would work for INT and FLOAT though.</li>
</ol>
<h3>Hover menu</h3>
The hover menu shows up when you're debugging and the mouse pointer hovers over a parameter for 0.5 or more seconds:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_hover.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_hover.png"></a></div>
 
It's a quick way to see the value of a parameter, and it's not necessary to actually break to see the value.
<h2>Debug panels</h2>
All debug panels can be opened via the 'View'-dropdown in the menubar.
<h3>Watch panel</h3>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_watch_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_watch_panel.png"></a></div>
 
</div>
<ol><li>Filters for the script paramaters based on the file, scope, and name. Multiple filters can be added if seperated by a space (e.g. "filter1 filter2").</li>
<li>All script parameters of the object that is currently being debugged. The scope column contains 'Global' if the script parameter is not part of a reaction, interrupt, event, or scriptframe. The value column contains 'NULL' if the script parameter containts no data.</li>
</ol>
<h3>Output panel</h3>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_output_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_output_panel.png"></a></div>
 
</div>
<ol><li>Clear the output panel of all output. This will not clear the saved output file.</li>
<li>This part contains all output messages. It will automatically scroll to the last output message if the mouse pointer is located after the last message and no selection has been made.</li>
</ol>
It is possible to output text in the output panel with the Output() action:
<pre>EVENTS
EVENT ExampleEvent
ON
OnTimer("ExampleTimer")
VARS
FIXEDSTRING:_ExampleFixedString="ExampleFixedString"
ACTIONS
Output("Example output with a fixed string '[1]' and an int [2]", _ExampleFixedString, INT:10)
</pre>
The script event above would output the following text:
<pre>01:23:45.678: [CurrentDebugObject | CurrentDebugScript.charScript | 10]: Example output with a fixed string 'ExampleFixedString' and an int 10
</pre>
As you can see, most output is preceded by some extra info on the location of the output (if relevant).
<h1>Debugging</h1>
Before you start debugging there are a few more things you need to know.
<h2>Starting and stopping a debug session</h2>
Starting and stopping a debug session can be done in both editor and game mode. To start or stop a debug session all you need to do is to enable 'Debug' in the debug toolbar. Starting a debug session will not change the behavior of the game, but you will start seeing output in the output panel if there is any. The watch panel will not contain any data until you break in a script by pausing or due to a breakpoint. The pause button and breakpoints will start working when you start a debug session as well.
<h2>Stepping through an object or script</h2>
Once you've got a debug session running you can start to actually debug a script. You can do this by putting a breakpoint on the line where you would like to pause the script. When that line is about to be executed the script will pause. When the script is paused you can step with the 'step' button. This will execute the current line and then break on the next line. The next line could be in a different script in the same object. The next script break location depends on your step setting (in the combobox). When the script is paused it is possible to change the current debug object and/or script in the comboboxes in the debug toolbar. This will cause the next step to break the script in the newly selected object and script.
<h2>Breakpoints</h2>
Breakpoints do not only have a line location, but an object and script location as well. Multiple objects can have the same script, but when you place a breakpoint it will count for only one of those. The actual breakpoint location is dependent on the object panel you used when placing the breakpoint. Also, not all locations are valid breakpoint locations. The only valid locations are lines that can be executed (i.e. actions, conditions, 'IF', and 'ELSE'). In the following code snippit the only valid line would be the last one:
<pre>EVENTS
EVENT Init
ON
OnInit()
ACTIONS
Output("OutputText")
</pre>
<h2>Script break</h2>
A script break will pause both the game and script. Right before the script is about to execute the line it will break (due to a breakpoint or a requested pause). After this script break nothing besides the script editor will update. This also means that there is no way to use other debug tools, like the console, during a script break. This is purely due to the nature of a debugger. If anything would be allowed to update during a script break it would invalidate the debug data and it would become unreliable.

File:Interface breakpoint conditions.png

2017-08-07T12:54:23Z

Larian octaaf:

File:Interface hover.png

2017-08-07T12:54:18Z

Larian octaaf:

File:Interface watch panel.png

2017-08-07T12:54:11Z

Larian octaaf:

File:Interface output panel.png

2017-08-07T12:54:05Z

Larian octaaf:

File:Interface included file.png

2017-08-07T12:52:51Z

Larian octaaf:

File:Interface object panel.png

2017-08-07T12:52:43Z

Larian octaaf:

File:Interface debug toolbar.png

2017-08-07T12:52:36Z

Larian octaaf:

File:Interface script editor.png

2017-08-07T12:52:28Z

Larian octaaf:

Script debugger

2017-08-07T12:29:29Z

Larian octaaf: Created page with "<h1>The interface</h1> The script debugger is part of the script editor and it has 3 main areas: <div style="display:block;text-align:left"><a href="https://site..."

<h1>The interface</h1>
The script debugger is part of the script editor and it has 3 main areas:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_script_editor.PNG?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_script_editor.PNG"></a></div>
<ol><li>Debug toolbar, with buttons and comboboxes for basic debug functions.</li>
<li>An object panel, containing all the scripts of an object. The object panel is used to place breakpoints and to show the actual stepping.</li>
<li>The debug panels: errors, watch, and output. Watch and output are only actuve when debugging is enabled. The watch panel provides info on script parameters during debugging, while the output panel shows the debug flow output and user output.</li>
</ol>
<h2>Debug toolbar</h2>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_debug_toolbar.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_debug_toolbar.png"></a></div>
 
</div>
<ol><li>Checkbox to enable/disable debugging features. Without this enabled no debug features will work, neither will the watch and output panel.</li>
<li>[Alt+Pause] Pause button to pause the game as soon as possible. In practice it will break in the very first script of the frame.</li>
<li>[F5] Continue button to continue the game when debugging.</li>
<li>[F10] Step button to execute a 'step' when debugging. What this step is and in which script it will do this step is dependent on the following comboboxes (5, 6, and 7).</li>
<li>A combobox to select the stepping type. 'Step in scripts' will step 1 action/condition forward in the script being debugged. 'Step in objects' will step 1 action/condition forward in the object being debugged. An object can have more than 1 script, meaning that a step might break in another script attached to the object.</li>
<li>A combobox to select the debug object. All objects (whether item or character) with a script attached are available for selection. Whenever a step is made the object in this combobox is the object being stepped through. Selecting an object will open and show an object panel for the selected object.</li>
<li>A combobox to select the debug script. The options are the scripts attached to the selected debug object. This combobox will be empty if no debug object is selected. Whenever a step is made the script in this combobox is the script being stepped through. Selecting a script will open and show an object panel for the selected object and show the selected script.</li>
<li>Checkbox to enable/disable the following of the debug helper. When enabled the debugger will always open the object file for the currently selected object in the debug helper (activated with CTRL+SHIFT+LMB).</li>
</ol>
<h2>Object panel</h2>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_object_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_object_panel.png"></a></div>
 
</div>
<ol><li>An object panel tab name is always preceded by 'Object - ', while a script panel is preceded by 'Script - '.</li>
<li>A green bar if the object is active (= executing scripts) or a red bar if the object is inactive.</li>
<li>All scripts that are attached to the object have their own tab. All these panels are read-only and are only used for debugging.</li>
<li>When clicking this button it will select the object and script of this panel in the comboboxes in the debug toolbar.</li>
<li>A breakpoint that will 'break' (pause) the script whenever it is about to execute the line it has been placed on. Place a breakpoint by clicking in the margin next to the linenumbers and remove it by clicking the breakpoint again. If a breakpoint is disabled it will be white instead of red. If a breakpoint has conditions it will have a cross as well.</li>
<li>The yellow arrow and grey background indicate the line that's about to be executed in the next step. These markers are only visible when debugging.</li>
</ol>
When a script is included in another script it's still attached to the object. This is not always as obvious due to recursive includes, so a blue bar will notify you in that case:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_included_file.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_included_file.png"></a></div>

<h3>Breakpoint context menu</h3>
The breakpoint context menu can be accessed by CTRL+Click on a breakpoint:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint.png"></a></div>
 
It allows you to enable or disable the breakpoint (a disabled breakpoint will never break), access the breakpoint conditions menu, or to reset or view the hit count. The hit count of a breakpoint is the amount of times that line has been 'hit'/executed.
<h3>Breakpoint conditions menu</h3>
The breakpoint conditions menu can be accessed via the previously mentioned breakpoint context menu:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint_conditions.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_breakpoint_conditions.png"></a></div>
 
The menu is used to create conditional breakpoints: breakpoints that only break when all conditions pass. As can be seen there are two types:
<ol><li>Hit count: set a condition for the hit count by checking whether the hit count is equal to, not equal to, larger than or equal to, smaller than, or a multiple of your entered hit count.</li>
<li>Expression: set a condition by comparing the value of a parameter and check if it's equal to, not equal to, larger than or equal to, or smaller than your entered value. Checking whether a STRING is smaller than another STRING might not be best idea here. It would work for INT and FLOAT though.</li>
</ol>
<h3>Hover menu</h3>
The hover menu shows up when you're debugging and the mouse pointer hovers over a parameter for 0.5 or more seconds:
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_hover.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_hover.png"></a></div>
 
It's a quick way to see the value of a parameter, and it's not necessary to actually break to see the value.
<h2>Debug panels</h2>
All debug panels can be opened via the 'View'-dropdown in the menubar.
<h3>Watch panel</h3>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_watch_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_watch_panel.png"></a></div>
 
</div>
<ol><li>Filters for the script paramaters based on the file, scope, and name. Multiple filters can be added if seperated by a space (e.g. "filter1 filter2").</li>
<li>All script parameters of the object that is currently being debugged. The scope column contains 'Global' if the script parameter is not part of a reaction, interrupt, event, or scriptframe. The value column contains 'NULL' if the script parameter containts no data.</li>
</ol>
<h3>Output panel</h3>
<div>
<div style="display:block;text-align:left"><a href="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_output_panel.png?attredirects=0" imageanchor="1"><img border="0" src="https://sites.google.com/a/larian.com/larian-wikisite/home/script-debugger/Interface_output_panel.png"></a></div>
 
</div>
<ol><li>Clear the output panel of all output. This will not clear the saved output file.</li>
<li>This part contains all output messages. It will automatically scroll to the last output message if the mouse pointer is located after the last message and no selection has been made.</li>
</ol>
It is possible to output text in the output panel with the Output() action:
<pre>EVENTS
EVENT ExampleEvent
ON
OnTimer("ExampleTimer")
VARS
FIXEDSTRING:_ExampleFixedString="ExampleFixedString"
ACTIONS
Output("Example output with a fixed string '[1]' and an int [2]", _ExampleFixedString, INT:10)
</pre>
The script event above would output the following text:
<pre>01:23:45.678: [CurrentDebugObject | CurrentDebugScript.charScript | 10]: Example output with a fixed string 'ExampleFixedString' and an int 10
</pre>
As you can see, most output is preceded by some extra info on the location of the output (if relevant).
<h1>Debugging</h1>
Before you start debugging there are a few more things you need to know.
<h2>Starting and stopping a debug session</h2>
Starting and stopping a debug session can be done in both editor and game mode. To start or stop a debug session all you need to do is to enable 'Debug' in the debug toolbar. Starting a debug session will not change the behavior of the game, but you will start seeing output in the output panel if there is any. The watch panel will not contain any data until you break in a script by pausing or due to a breakpoint. The pause button and breakpoints will start working when you start a debug session as well.
<h2>Stepping through an object or script</h2>
Once you've got a debug session running you can start to actually debug a script. You can do this by putting a breakpoint on the line where you would like to pause the script. When that line is about to be executed the script will pause. When the script is paused you can step with the 'step' button. This will execute the current line and then break on the next line. The next line could be in a different script in the same object. The next script break location depends on your step setting (in the combobox). When the script is paused it is possible to change the current debug object and/or script in the comboboxes in the debug toolbar. This will cause the next step to break the script in the newly selected object and script.
<h2>Breakpoints</h2>
Breakpoints do not only have a line location, but an object and script location as well. Multiple objects can have the same script, but when you place a breakpoint it will count for only one of those. The actual breakpoint location is dependent on the object panel you used when placing the breakpoint. Also, not all locations are valid breakpoint locations. The only valid locations are lines that can be executed (i.e. actions, conditions, 'IF', and 'ELSE'). In the following code snippit the only valid line would be the last one:
<pre>EVENTS
EVENT Init
ON
OnInit()
ACTIONS
Output("OutputText")
</pre>
<h2>Script break</h2>
A script break will pause both the game and script. Right before the script is about to execute the line it will break (due to a breakpoint or a requested pause). After this script break nothing besides the script editor will update. This also means that there is no way to use other debug tools, like the console, during a script break. This is purely due to the nature of a debugger. If anything would be allowed to update during a script break it would invalidate the debug data and it would become unreliable.

Osiris API Tips Events

2017-08-02T13:24:52Z

Larian octaaf:

= Events =

Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics.

== CharacterBlockedBy ==

'''Full definitions'''
* event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

'''Description'''
* Thrown when a character blocks an attack from another character.

'''Parameters'''
* _Defender: The character that received/defended the attack.
* _Attacker: The character that attacked the _Defender.
* _AttackerOwner: The character that owns the _Attacker character.

'''Notes'''
* _AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also: ''CharacterMissedBy''

== CharacterMissedBy ==

'''Full definitions'''
* event CharacterMissedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

'''Description'''
* Thrown when a character misses an attack from another character.

'''Parameters'''
* _Defender: The character that received/defended the attack.
* _Attacker: The character that attacked the _Defender.
* _AttackerOwner: The character that owns the _Attacker character.

'''Notes'''
* _AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also: ''CharacterBlockedBy'', ''CharacterCriticalHitBy''

== Full definitions ==
event CharacterCriticalHitBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character receives a critical hit from an attack of another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterKilledBy

Full definitions
event CharacterKilledBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character is killed by another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterEnteredRegion

Full definitions

event CharacterEnteredRegion((CHARACTERGUID)_Character, (STRING)_Region)
Description
Thrown when a character enters a level because it was placed there in the editor, it was teleported there via script, or it was created/spawned there via script.

Parameters

_Character: the character that entered the level/region
_Region: the name of the level/region (as entered in the Levelname property of the Level -> Edit Level Data... menu entry in the editor.
Notes

For characters statically placed in a level using the editor, this event is thrown only once when the level is first entered. It is not thrown again when loading save games from within that level. TODO: check what happens if the players are teleported out of a level and then back into it (never done in DivinityOrigins mod).
See also

/
CharacterSawCharacter

Full definitions

event CharacterSawCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_OtherCharacter)
Description
Thrown when one _Character sees _OtherCharacter. Note that this event is only thrown if _Character has been registered as an event generator.

Parameters

_Character: the character that does the seeing.
_OtherCharacter: the character that is seen
Notes

By default, only player-controlled characters are event generators. Once you call CharacterCanSee with an NPC as first parameter, an event generator is also registered for this NPC and it will also start throwing CharacterSawCharacter events. This event generator may only work temporarily though, so in general only rely on these events be thrown for player characters.
See also

CharacterCanSee
CharacterLostSightOfCharacter
CharacterStoppedUsingItem

Full definitions

event CharacterStoppedUsingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)
Description
Thrown when a character stopped using an item, or if a character tried to use an item and failed.

Parameters

_Character: the character that used or tried to use _Item.
_Item: the item that was used or attempted to be used
Notes

/
See also

/
CombatStarted

Full definitions

event CombatStarted((INTEGER)_CombatID)
Description
Thrown once a new combat has started and has been completely initialised. I.e., all initial participants have been added, and combat is ready to start.

Parameters

_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new ObjectEnteredCombat event will be thrown for every participant still in the combat, followed by a new CombatStartedEvent with the same _CombatID as before. During these new ObjectEventeredCombat events and CombatStarted event, the combat must again be considered to be not completely initialised yet.
This event will also be thrown when two combats are merged.
See also

ObjectEnteredCombat
ObjectLeftCombat
DialogStartRequested

Full definitions

event DialogStartRequested((GUIDSTRING)_Target,(GUIDSTRING)_Player)
Description
Thrown whenever a player tries to start a conversation with another object.

Parameters

_Target: The object to which the conversation request is directed.
_Player: The player that initiated the conversation
Notes

Do not use this event directly. Overload PROC_GLOBAL_DialogStartRequested or PROC_GLOBAL_DialogStartRequested_AfterGenerics instead, so that certain common behaviours are guaranteed to hold in all cases.
This event can only be thrown if the target can accept dialog requests, i.e. if SetHasDialog(_Target,1) is currently active.
See also

SetHasDialog
helper PROC_GLOBAL_DialogStartRequested
helper PROC_GLOBAL_DialogStartRequested_AfterGenerics
GameStarted

Full definitions

event GameStarted((String)_LevelName, (INTEGER)_IsEditorMode)
Description
Thrown when a level has been loaded and is ready at both the server and client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
_IsEditorMode: Indicates whether the game is run in the editor or not
Notes

The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.
An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)
See RegionStarted for an event that is thrown when the level is ready on the server side.
This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).
See also

RegionStarted
ObjectEnteredCombat

Full definitions

event ObjectEnteredCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) enters a combat.

Parameters

_Object: The object that has entered the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as JumpToTurn yet. If you wish to perform some action when a combat has completely started, use CombatStarted instead.
See also

CombatStarted
ObjectLeftCombat
ObjectFlagSet

Full definitions

event ObjectFlagSet((STRING)_FlagName, (GUIDSTRING)_Speaker, (INTEGER)_DialogInstance)
Description
Thrown when the flag _FlagName is set on object _Speaker in the context indicated by _DialogInstance.

Parameters

_FlagName: The flag that is set.
_Speaker: The object on which the (character) flag is set.
_DialogInstance: If the flag was set using a dialog node, _DialogInstance contains the dialog's instance ID. If the flag was set from story, _DialogInstance will contain whatever was passed as last parameter to ObjectSetFlag. If the flag was set from behaviour script, DialogInstance will be zero.
Notes

/
See also

ObjectSetFlag
ObjectClearFlag
ObjectLeftCombat

Full definitions

event ObjectLeftCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) leaves a combat.

Parameters

_Object: The object that has left the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

Reasons why characters may leave combat is because they died, because they got too far from the other participants, or because story forced them to leave.
See also

CombatStarted
ObjectEnteredCombat
ObjectSourcePointAddRequest

Full definitions

event ObjectSourcePointAddRequest((GUIDSTRING)_Target, (INTEGER)_Amount)
Description
Thrown for every attempt to add source to an object, even if the object cannot hold more source. It is thrown before the source has been added.

Parameters

_Target: The object to which source gets added. In case of a character, this means there is an attempt to add source points. In case of an item, this means there is an attempt to add charges.
_Amount: The number of source points/charges that is being added.
Notes

As mentioned in the description, this is triggered even when _Target currently already holds its maximum of source.
See also

/
RegionStarted

Full definitions

event RegionStarted((String)_LevelName)
Description
Thrown when the level has been loaded and is ready at the server side, but not yet at the client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
Notes

See GameStarted for usage information that also applies to this call.
See also

GameStarted

Osiris API Tips Events

2017-08-02T13:23:36Z

Larian octaaf:

= Events =

Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics.

== CharacterBlockedBy ==

'''Full definitions'''
* event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

'''Description'''
* Thrown when a character blocks an attack from another character.

'''Parameters'''
* _Defender: The character that received/defended the attack.
* _Attacker: The character that attacked the _Defender.
* _AttackerOwner: The character that owns the _Attacker character.

'''Notes'''
* _AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also: ''CharacterMissedBy''

== CharacterMissedBy ==

Full definitions
event CharacterMissedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character misses an attack from another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterCriticalHitBy

Full definitions
event CharacterCriticalHitBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character receives a critical hit from an attack of another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterKilledBy

Full definitions
event CharacterKilledBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character is killed by another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterEnteredRegion

Full definitions

event CharacterEnteredRegion((CHARACTERGUID)_Character, (STRING)_Region)
Description
Thrown when a character enters a level because it was placed there in the editor, it was teleported there via script, or it was created/spawned there via script.

Parameters

_Character: the character that entered the level/region
_Region: the name of the level/region (as entered in the Levelname property of the Level -> Edit Level Data... menu entry in the editor.
Notes

For characters statically placed in a level using the editor, this event is thrown only once when the level is first entered. It is not thrown again when loading save games from within that level. TODO: check what happens if the players are teleported out of a level and then back into it (never done in DivinityOrigins mod).
See also

/
CharacterSawCharacter

Full definitions

event CharacterSawCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_OtherCharacter)
Description
Thrown when one _Character sees _OtherCharacter. Note that this event is only thrown if _Character has been registered as an event generator.

Parameters

_Character: the character that does the seeing.
_OtherCharacter: the character that is seen
Notes

By default, only player-controlled characters are event generators. Once you call CharacterCanSee with an NPC as first parameter, an event generator is also registered for this NPC and it will also start throwing CharacterSawCharacter events. This event generator may only work temporarily though, so in general only rely on these events be thrown for player characters.
See also

CharacterCanSee
CharacterLostSightOfCharacter
CharacterStoppedUsingItem

Full definitions

event CharacterStoppedUsingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)
Description
Thrown when a character stopped using an item, or if a character tried to use an item and failed.

Parameters

_Character: the character that used or tried to use _Item.
_Item: the item that was used or attempted to be used
Notes

/
See also

/
CombatStarted

Full definitions

event CombatStarted((INTEGER)_CombatID)
Description
Thrown once a new combat has started and has been completely initialised. I.e., all initial participants have been added, and combat is ready to start.

Parameters

_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new ObjectEnteredCombat event will be thrown for every participant still in the combat, followed by a new CombatStartedEvent with the same _CombatID as before. During these new ObjectEventeredCombat events and CombatStarted event, the combat must again be considered to be not completely initialised yet.
This event will also be thrown when two combats are merged.
See also

ObjectEnteredCombat
ObjectLeftCombat
DialogStartRequested

Full definitions

event DialogStartRequested((GUIDSTRING)_Target,(GUIDSTRING)_Player)
Description
Thrown whenever a player tries to start a conversation with another object.

Parameters

_Target: The object to which the conversation request is directed.
_Player: The player that initiated the conversation
Notes

Do not use this event directly. Overload PROC_GLOBAL_DialogStartRequested or PROC_GLOBAL_DialogStartRequested_AfterGenerics instead, so that certain common behaviours are guaranteed to hold in all cases.
This event can only be thrown if the target can accept dialog requests, i.e. if SetHasDialog(_Target,1) is currently active.
See also

SetHasDialog
helper PROC_GLOBAL_DialogStartRequested
helper PROC_GLOBAL_DialogStartRequested_AfterGenerics
GameStarted

Full definitions

event GameStarted((String)_LevelName, (INTEGER)_IsEditorMode)
Description
Thrown when a level has been loaded and is ready at both the server and client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
_IsEditorMode: Indicates whether the game is run in the editor or not
Notes

The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.
An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)
See RegionStarted for an event that is thrown when the level is ready on the server side.
This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).
See also

RegionStarted
ObjectEnteredCombat

Full definitions

event ObjectEnteredCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) enters a combat.

Parameters

_Object: The object that has entered the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as JumpToTurn yet. If you wish to perform some action when a combat has completely started, use CombatStarted instead.
See also

CombatStarted
ObjectLeftCombat
ObjectFlagSet

Full definitions

event ObjectFlagSet((STRING)_FlagName, (GUIDSTRING)_Speaker, (INTEGER)_DialogInstance)
Description
Thrown when the flag _FlagName is set on object _Speaker in the context indicated by _DialogInstance.

Parameters

_FlagName: The flag that is set.
_Speaker: The object on which the (character) flag is set.
_DialogInstance: If the flag was set using a dialog node, _DialogInstance contains the dialog's instance ID. If the flag was set from story, _DialogInstance will contain whatever was passed as last parameter to ObjectSetFlag. If the flag was set from behaviour script, DialogInstance will be zero.
Notes

/
See also

ObjectSetFlag
ObjectClearFlag
ObjectLeftCombat

Full definitions

event ObjectLeftCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) leaves a combat.

Parameters

_Object: The object that has left the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

Reasons why characters may leave combat is because they died, because they got too far from the other participants, or because story forced them to leave.
See also

CombatStarted
ObjectEnteredCombat
ObjectSourcePointAddRequest

Full definitions

event ObjectSourcePointAddRequest((GUIDSTRING)_Target, (INTEGER)_Amount)
Description
Thrown for every attempt to add source to an object, even if the object cannot hold more source. It is thrown before the source has been added.

Parameters

_Target: The object to which source gets added. In case of a character, this means there is an attempt to add source points. In case of an item, this means there is an attempt to add charges.
_Amount: The number of source points/charges that is being added.
Notes

As mentioned in the description, this is triggered even when _Target currently already holds its maximum of source.
See also

/
RegionStarted

Full definitions

event RegionStarted((String)_LevelName)
Description
Thrown when the level has been loaded and is ready at the server side, but not yet at the client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
Notes

See GameStarted for usage information that also applies to this call.
See also

GameStarted

Osiris API Tips Events

2017-08-02T13:14:28Z

Larian octaaf:

= Events =

Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics.

== CharacterBlockedBy ==

Full definitions
event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character blocks an attack from another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterMissedBy
CharacterMissedBy

Full definitions
event CharacterMissedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character misses an attack from another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterCriticalHitBy

Full definitions
event CharacterCriticalHitBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character receives a critical hit from an attack of another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterKilledBy

Full definitions
event CharacterKilledBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character is killed by another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterEnteredRegion

Full definitions

event CharacterEnteredRegion((CHARACTERGUID)_Character, (STRING)_Region)
Description
Thrown when a character enters a level because it was placed there in the editor, it was teleported there via script, or it was created/spawned there via script.

Parameters

_Character: the character that entered the level/region
_Region: the name of the level/region (as entered in the Levelname property of the Level -> Edit Level Data... menu entry in the editor.
Notes

For characters statically placed in a level using the editor, this event is thrown only once when the level is first entered. It is not thrown again when loading save games from within that level. TODO: check what happens if the players are teleported out of a level and then back into it (never done in DivinityOrigins mod).
See also

/
CharacterSawCharacter

Full definitions

event CharacterSawCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_OtherCharacter)
Description
Thrown when one _Character sees _OtherCharacter. Note that this event is only thrown if _Character has been registered as an event generator.

Parameters

_Character: the character that does the seeing.
_OtherCharacter: the character that is seen
Notes

By default, only player-controlled characters are event generators. Once you call CharacterCanSee with an NPC as first parameter, an event generator is also registered for this NPC and it will also start throwing CharacterSawCharacter events. This event generator may only work temporarily though, so in general only rely on these events be thrown for player characters.
See also

CharacterCanSee
CharacterLostSightOfCharacter
CharacterStoppedUsingItem

Full definitions

event CharacterStoppedUsingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)
Description
Thrown when a character stopped using an item, or if a character tried to use an item and failed.

Parameters

_Character: the character that used or tried to use _Item.
_Item: the item that was used or attempted to be used
Notes

/
See also

/
CombatStarted

Full definitions

event CombatStarted((INTEGER)_CombatID)
Description
Thrown once a new combat has started and has been completely initialised. I.e., all initial participants have been added, and combat is ready to start.

Parameters

_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new ObjectEnteredCombat event will be thrown for every participant still in the combat, followed by a new CombatStartedEvent with the same _CombatID as before. During these new ObjectEventeredCombat events and CombatStarted event, the combat must again be considered to be not completely initialised yet.
This event will also be thrown when two combats are merged.
See also

ObjectEnteredCombat
ObjectLeftCombat
DialogStartRequested

Full definitions

event DialogStartRequested((GUIDSTRING)_Target,(GUIDSTRING)_Player)
Description
Thrown whenever a player tries to start a conversation with another object.

Parameters

_Target: The object to which the conversation request is directed.
_Player: The player that initiated the conversation
Notes

Do not use this event directly. Overload PROC_GLOBAL_DialogStartRequested or PROC_GLOBAL_DialogStartRequested_AfterGenerics instead, so that certain common behaviours are guaranteed to hold in all cases.
This event can only be thrown if the target can accept dialog requests, i.e. if SetHasDialog(_Target,1) is currently active.
See also

SetHasDialog
helper PROC_GLOBAL_DialogStartRequested
helper PROC_GLOBAL_DialogStartRequested_AfterGenerics
GameStarted

Full definitions

event GameStarted((String)_LevelName, (INTEGER)_IsEditorMode)
Description
Thrown when a level has been loaded and is ready at both the server and client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
_IsEditorMode: Indicates whether the game is run in the editor or not
Notes

The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.
An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)
See RegionStarted for an event that is thrown when the level is ready on the server side.
This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).
See also

RegionStarted
ObjectEnteredCombat

Full definitions

event ObjectEnteredCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) enters a combat.

Parameters

_Object: The object that has entered the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as JumpToTurn yet. If you wish to perform some action when a combat has completely started, use CombatStarted instead.
See also

CombatStarted
ObjectLeftCombat
ObjectFlagSet

Full definitions

event ObjectFlagSet((STRING)_FlagName, (GUIDSTRING)_Speaker, (INTEGER)_DialogInstance)
Description
Thrown when the flag _FlagName is set on object _Speaker in the context indicated by _DialogInstance.

Parameters

_FlagName: The flag that is set.
_Speaker: The object on which the (character) flag is set.
_DialogInstance: If the flag was set using a dialog node, _DialogInstance contains the dialog's instance ID. If the flag was set from story, _DialogInstance will contain whatever was passed as last parameter to ObjectSetFlag. If the flag was set from behaviour script, DialogInstance will be zero.
Notes

/
See also

ObjectSetFlag
ObjectClearFlag
ObjectLeftCombat

Full definitions

event ObjectLeftCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) leaves a combat.

Parameters

_Object: The object that has left the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

Reasons why characters may leave combat is because they died, because they got too far from the other participants, or because story forced them to leave.
See also

CombatStarted
ObjectEnteredCombat
ObjectSourcePointAddRequest

Full definitions

event ObjectSourcePointAddRequest((GUIDSTRING)_Target, (INTEGER)_Amount)
Description
Thrown for every attempt to add source to an object, even if the object cannot hold more source. It is thrown before the source has been added.

Parameters

_Target: The object to which source gets added. In case of a character, this means there is an attempt to add source points. In case of an item, this means there is an attempt to add charges.
_Amount: The number of source points/charges that is being added.
Notes

As mentioned in the description, this is triggered even when _Target currently already holds its maximum of source.
See also

/
RegionStarted

Full definitions

event RegionStarted((String)_LevelName)
Description
Thrown when the level has been loaded and is ready at the server side, but not yet at the client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
Notes

See GameStarted for usage information that also applies to this call.
See also

GameStarted

Osiris API Tips Events

2017-08-02T13:13:53Z

Larian octaaf:

== Events ==

Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics.

= CharacterBlockedBy =

Full definitions
event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character blocks an attack from another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterMissedBy
CharacterMissedBy

Full definitions
event CharacterMissedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character misses an attack from another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterCriticalHitBy

Full definitions
event CharacterCriticalHitBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character receives a critical hit from an attack of another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterKilledBy

Full definitions
event CharacterKilledBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)

Description
Thrown when a character is killed by another character.

Parameters
_Defender: The character that received/defended the attack.
_Attacker: The character that attacked the _Defender.
_AttackerOwner: The character that owns the _Attacker character.

Notes
_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.

See also
CharacterBlockedBy
CharacterEnteredRegion

Full definitions

event CharacterEnteredRegion((CHARACTERGUID)_Character, (STRING)_Region)
Description
Thrown when a character enters a level because it was placed there in the editor, it was teleported there via script, or it was created/spawned there via script.

Parameters

_Character: the character that entered the level/region
_Region: the name of the level/region (as entered in the Levelname property of the Level -> Edit Level Data... menu entry in the editor.
Notes

For characters statically placed in a level using the editor, this event is thrown only once when the level is first entered. It is not thrown again when loading save games from within that level. TODO: check what happens if the players are teleported out of a level and then back into it (never done in DivinityOrigins mod).
See also

/
CharacterSawCharacter

Full definitions

event CharacterSawCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_OtherCharacter)
Description
Thrown when one _Character sees _OtherCharacter. Note that this event is only thrown if _Character has been registered as an event generator.

Parameters

_Character: the character that does the seeing.
_OtherCharacter: the character that is seen
Notes

By default, only player-controlled characters are event generators. Once you call CharacterCanSee with an NPC as first parameter, an event generator is also registered for this NPC and it will also start throwing CharacterSawCharacter events. This event generator may only work temporarily though, so in general only rely on these events be thrown for player characters.
See also

CharacterCanSee
CharacterLostSightOfCharacter
CharacterStoppedUsingItem

Full definitions

event CharacterStoppedUsingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)
Description
Thrown when a character stopped using an item, or if a character tried to use an item and failed.

Parameters

_Character: the character that used or tried to use _Item.
_Item: the item that was used or attempted to be used
Notes

/
See also

/
CombatStarted

Full definitions

event CombatStarted((INTEGER)_CombatID)
Description
Thrown once a new combat has started and has been completely initialised. I.e., all initial participants have been added, and combat is ready to start.

Parameters

_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new ObjectEnteredCombat event will be thrown for every participant still in the combat, followed by a new CombatStartedEvent with the same _CombatID as before. During these new ObjectEventeredCombat events and CombatStarted event, the combat must again be considered to be not completely initialised yet.
This event will also be thrown when two combats are merged.
See also

ObjectEnteredCombat
ObjectLeftCombat
DialogStartRequested

Full definitions

event DialogStartRequested((GUIDSTRING)_Target,(GUIDSTRING)_Player)
Description
Thrown whenever a player tries to start a conversation with another object.

Parameters

_Target: The object to which the conversation request is directed.
_Player: The player that initiated the conversation
Notes

Do not use this event directly. Overload PROC_GLOBAL_DialogStartRequested or PROC_GLOBAL_DialogStartRequested_AfterGenerics instead, so that certain common behaviours are guaranteed to hold in all cases.
This event can only be thrown if the target can accept dialog requests, i.e. if SetHasDialog(_Target,1) is currently active.
See also

SetHasDialog
helper PROC_GLOBAL_DialogStartRequested
helper PROC_GLOBAL_DialogStartRequested_AfterGenerics
GameStarted

Full definitions

event GameStarted((String)_LevelName, (INTEGER)_IsEditorMode)
Description
Thrown when a level has been loaded and is ready at both the server and client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
_IsEditorMode: Indicates whether the game is run in the editor or not
Notes

The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.
An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)
See RegionStarted for an event that is thrown when the level is ready on the server side.
This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).
See also

RegionStarted
ObjectEnteredCombat

Full definitions

event ObjectEnteredCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) enters a combat.

Parameters

_Object: The object that has entered the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as JumpToTurn yet. If you wish to perform some action when a combat has completely started, use CombatStarted instead.
See also

CombatStarted
ObjectLeftCombat
ObjectFlagSet

Full definitions

event ObjectFlagSet((STRING)_FlagName, (GUIDSTRING)_Speaker, (INTEGER)_DialogInstance)
Description
Thrown when the flag _FlagName is set on object _Speaker in the context indicated by _DialogInstance.

Parameters

_FlagName: The flag that is set.
_Speaker: The object on which the (character) flag is set.
_DialogInstance: If the flag was set using a dialog node, _DialogInstance contains the dialog's instance ID. If the flag was set from story, _DialogInstance will contain whatever was passed as last parameter to ObjectSetFlag. If the flag was set from behaviour script, DialogInstance will be zero.
Notes

/
See also

ObjectSetFlag
ObjectClearFlag
ObjectLeftCombat

Full definitions

event ObjectLeftCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)
Description
Thrown when an object (character or item) leaves a combat.

Parameters

_Object: The object that has left the combat
_CombatID: A handle that identifies the combat. Should always be > 0.
Notes

Reasons why characters may leave combat is because they died, because they got too far from the other participants, or because story forced them to leave.
See also

CombatStarted
ObjectEnteredCombat
ObjectSourcePointAddRequest

Full definitions

event ObjectSourcePointAddRequest((GUIDSTRING)_Target, (INTEGER)_Amount)
Description
Thrown for every attempt to add source to an object, even if the object cannot hold more source. It is thrown before the source has been added.

Parameters

_Target: The object to which source gets added. In case of a character, this means there is an attempt to add source points. In case of an item, this means there is an attempt to add charges.
_Amount: The number of source points/charges that is being added.
Notes

As mentioned in the description, this is triggered even when _Target currently already holds its maximum of source.
See also

/
RegionStarted

Full definitions

event RegionStarted((String)_LevelName)
Description
Thrown when the level has been loaded and is ready at the server side, but not yet at the client side.

Parameters

_LevelName: The identifier name of the level that has been loaded
Notes

See GameStarted for usage information that also applies to this call.
See also

GameStarted

Osiris API Tips Queries

2017-08-02T10:11:49Z

Larian octaaf:

<h3>Queries</h3>
Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an [out] parameter and it does not match the value the query would returns. Below, this will be called the Default Return Value. If a query can also fail under other circumstances, this will be mentioned. 

 

<div>
<div>
<h4 style="font-size:1.1em;color:rgb(36,53,93)">CharacterGetEquippedItem</h4>
Full definitions
<ul><li>query CharacterGetEquippedItem([in](CHARACTERGUID)_Character, [in](STRING)_Slotname, [out](GUIDSTRING)_ItemGUID)</li></ul>
Description 
</div>
Returns in _ItemGUID the item equipped by _Character in slot _Slotname, if any. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist, or if no item is equipped in _Slotname. 
</li>
<li>_ItemGuid: The item equipped by _Character in _Slotname. 
</li></ul>
Notes
<ul><li>The valid values for _Slotname are: Helmet, Amulet, Breast, Belt, Gloves, Leggings, Boots, Weapon, Shield, Ring, Ring2. 
</li></ul>
See also
<ul><li>CharacterUnequipItem 
</li></ul>
<div>
<h4>CharacterGetHenchmanPresetPrice</h4>
<div style="font-size:13.3333px">
Full definitions
<ul style="font-size:13.3333px"><li>query CharacterGetHenchmanPresetPrice([in](STRING)_Preset, [in](CHARACTERGUID)_Character, [out](INTEGER)_Price)</li></ul>
Description 
Returns the price of the preset scaled to the level of _Character. 

Return values
<ul style="font-size:13.3333px"><li>_Price: The price of the preset scaled to the level of _Character. 
</li></ul>
Notes
<ul style="font-size:13.3333px"><li>Presets come from the folder ".../DOS2/Data/Mods/Shared/CharacterCreation/HenchmanPresets/"</li>
<li>Presets can be customized using the following documentation: link</li></ul>
<div>
See also
<ul style="font-size:13.3333px"><li>CharacterApplyHenchmanPreset 
</li></ul>
</div>
</div>
</div>
<div>
<div>
<h4>CharacterIsAlly</h4>
Full definitions
<ul><li>query CharacterIsAlly([in](CHARACTERGUID)_Character, [in](CHARACTERGUID)_OtherCharacter, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is an ally of _OtherCharacter. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 1 if _Character and _OtherCharacter are allies, 0 if not. 
</li></ul>
Notes
<ul><li>Also works outside combat.</li>
<li>If _Character or _OtherCharacter is dead or dying, the result solely depends on the characters' alignments (factions). If they are alive, it is also influenced by temporary hostile relations, e.g. induced by attacking a neutral character. 
</li></ul>
See also
<ul><li>CharacterIsNeutral</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsEnemy</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are enemies. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsNeutral</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are neutral. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsPartyFollower</h4>
Full definitions
<ul><li>query CharacterIsPartyFollower([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is a character that follows a player character around. An NPC can be instructed to do so through CharacterFollowCharacter. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a party follower, 0 if not. 
</li></ul>
Notes
<ul><li>CharacterIsPlayer will also return true for party followers. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsPlayer</h4>
Full definitions
<ul><li>query CharacterIsPlayer([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is player-controlled. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is player-controlled, 0 if not. 
</li></ul>
Notes
<ul><li>Apart from avatars and recruited companions, player-controlled characters also include summons and followers.</li></ul>
See also
<ul><li>CharacterIsPartyFollower</li>
<li>CharacterIsSummon</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsSummon</h4>
Full definitions
<ul><li>query CharacterIsSummon([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is a summon. Summon can be player-controlled or not. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a summon, 0 if not. 
</li></ul>
Notes
<ul><li> 
</li>
<li>Summons can also be distinguished by the fact that hey have the SUMMON tag.</li>
<li>If you wish to know whether a summon is player-controlled, also check CharacterIsPlayer. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li></ul>
<h4>GetClosestAlivePlayer</h4>
Full definitions
<ul><li>query GetClosestAlivePlayer([in](GUIDSTRING)_Target, [out](CHARACTERGUID)_Player)</li></ul>
Description 
</div>
<div>
Gets the closest player to _Target that is alive and stores it in _Player.
Return values
<ul><li>Success/Failure: Fails if no living player is found. 
</li>
<li>_Player: The found player character. 
</li></ul>
Notes
<ul><li>Be careful if you check for extra conditions on the returned player: if any of those conditions fail, no other players will be considered.</li>
<li>If you want to start a dialog, use ProcGetClosestAvailableCharacterTo</li></ul>
See also
<ul><li>Helper ProcGetClosestAvailableCharacterTo</li></ul>
<div>
<div>
<h4>GetDistanceTo</h4>
Full definitions
<ul><li>query GetDistanceTo([in](GUIDSTRING)_Object1, [in](GUIDSTRING)_Object2, [out](REAL)_Dist)</li></ul>
Description 
</div>
Calculates the distance between _Object1 and _Object2.
Return values
<ul><li>Success/Failure: Fails if if either _Object1 or _Object2 is in a container or in an inventory. Use ItemIsInInventory to check for this.</li>
<li>_Dist: The distance in metres.</li></ul>
Notes
<ul><li>/ 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetInventoryOwner</h4>
Full definitions
<ul><li>query GetInventoryOwner([in](ITEMGUID)_Item, [out](GUIDSTRING)_Owner)</li></ul>
Description 
Returns the inventory/container that holds _Item in _Owner. 

Return values
<ul><li>Success/Failure: Fails if _Item is not in anyone's inventory nor in a container. 
</li>
<li>_Owner: The character or item in whose inventory the item currently resides. 
</li></ul>
Notes 

<ul><li>This call returns the outermost container. I.e., if a character has crate in their inventory, and the crate contains a pouch with the item, this call will return the character. 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetRandomPositionInTrigger</h4>
Full definitions
<ul><li>query GetRandomPositionInTrigger([in](TRIGGERGUID)_Trigger, [out](REAL)_X, [out](REAL)_Y, [out](REAL)_Z)</li></ul>
Description 
Returns a random position that is valid on the AI-grid inside _Trigger. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Trigger: A box trigger inside which the random position should be gotten. 
</li>
<li>_X, _Y, _Z: the coordinates of the random position 
</li></ul>
Notes 

<ul><li>This routine will first get a random position in the trigger, and if this random position is not valid on the AI-grid, the coordinates will be snapped to a nearby valid position on the AI-grid.</li>
<li>This call does not work for polytriggers</li></ul>
See also 

<ul><li>/ 
</li></ul>
<h4>HasActiveStatus</h4>
Full definitions
<ul><li>query HasActiveStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Target is currently under the influence of _Status. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 0 if _Target is currently not under the influence of _Status, 1 if it is. 
</li></ul>
Notes 

<ul><li>/</li></ul>
See also 

<ul><li>HasAppliedStatus 
</li></ul>
<h4>HasAppliedStatus</h4>
Full definitions
<ul><li>query HasAppliedStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Status has been applied to _Target. _Target may or may not yet actually be under its influence. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Status has not been applied to _Target, 1 if it has been. 
</li></ul>
Notes
<ul><li>In virtually all cases, use HasActiveStatus instead. The main purpose of this query is for crime reactions, and is only needed due to frame delays between code and Osiris. 
</li></ul>
See also 

<ul><li>HasActiveStatus 
</li></ul>
<h4>IsSpeakerReserved 
</h4>
Full definitions
<ul><li>query IsSpeakerReserved([in](GUIDSTRING)_Speaker, [out](INTEGER)_success)</li></ul>
Description 
Returns whether _Speaker is already in a dialog. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_success: 0 if _Speaker is currently not in a dialog, 1 otherwise. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>DialogStartRequested</li>
<li>Proc_StartDialog 
</li></ul>
<h4>ItemIsInInventory</h4>
Full definitions
<ul><li>query ItemIsInInventory([in](ITEMGUID)_Item, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Item is in an inventory. This includes both character and container inventories. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Item is not in an inventory (as defined above), 1 if it is. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>GetInventoryOwner</li></ul>
<div>
<hr>
</div>
</div>

Osiris API Tips Queries

2017-08-02T10:08:31Z

Larian octaaf:

<div>
<h3>Queries</h3>
Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an [out] parameter and it does not match the value the query would returns. Below, this will be called the Default Return Value. If a query can also fail under other circumstances, this will be mentioned. 

 

<div>
<div>
<h4 style="font-size:1.1em;color:rgb(36,53,93)">CharacterGetEquippedItem</h4>
Full definitions
<ul><li>query CharacterGetEquippedItem([in](CHARACTERGUID)_Character, [in](STRING)_Slotname, [out](GUIDSTRING)_ItemGUID)</li></ul>
Description 
</div>
Returns in _ItemGUID the item equipped by _Character in slot _Slotname, if any. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist, or if no item is equipped in _Slotname. 
</li>
<li>_ItemGuid: The item equipped by _Character in _Slotname. 
</li></ul>
Notes
<ul><li>The valid values for _Slotname are: Helmet, Amulet, Breast, Belt, Gloves, Leggings, Boots, Weapon, Shield, Ring, Ring2. 
</li></ul>
See also
<ul><li>CharacterUnequipItem 
</li></ul>
<div>
<h4>CharacterGetHenchmanPresetPrice</h4>
<div style="font-size:13.3333px">
Full definitions
<ul style="font-size:13.3333px"><li>query CharacterGetHenchmanPresetPrice([in](STRING)_Preset, [in](CHARACTERGUID)_Character, [out](INTEGER)_Price)</li></ul>
Description 
Returns the price of the preset scaled to the level of _Character. 

Return values
<ul style="font-size:13.3333px"><li>_Price: The price of the preset scaled to the level of _Character. 
</li></ul>
Notes
<ul style="font-size:13.3333px"><li>Presets come from the folder ".../DOS2/Data/Mods/Shared/CharacterCreation/HenchmanPresets/"</li>
<li>Presets can be customized using the following documentation: link</li></ul>
<div>
See also
<ul style="font-size:13.3333px"><li>CharacterApplyHenchmanPreset 
</li></ul>
</div>
</div>
</div>
<div>
<div>
<h4>CharacterIsAlly</h4>
Full definitions
<ul><li>query CharacterIsAlly([in](CHARACTERGUID)_Character, [in](CHARACTERGUID)_OtherCharacter, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is an ally of _OtherCharacter. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 1 if _Character and _OtherCharacter are allies, 0 if not. 
</li></ul>
Notes
<ul><li>Also works outside combat.</li>
<li>If _Character or _OtherCharacter is dead or dying, the result solely depends on the characters' alignments (factions). If they are alive, it is also influenced by temporary hostile relations, e.g. induced by attacking a neutral character. 
</li></ul>
See also
<ul><li>CharacterIsNeutral</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsEnemy</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are enemies. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsNeutral</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are neutral. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsPartyFollower</h4>
Full definitions
<ul><li>query CharacterIsPartyFollower([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is a character that follows a player character around. An NPC can be instructed to do so through CharacterFollowCharacter. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a party follower, 0 if not. 
</li></ul>
Notes
<ul><li>CharacterIsPlayer will also return true for party followers. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsPlayer</h4>
Full definitions
<ul><li>query CharacterIsPlayer([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is player-controlled. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is player-controlled, 0 if not. 
</li></ul>
Notes
<ul><li>Apart from avatars and recruited companions, player-controlled characters also include summons and followers.</li></ul>
See also
<ul><li>CharacterIsPartyFollower</li>
<li>CharacterIsSummon</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsSummon</h4>
Full definitions
<ul><li>query CharacterIsSummon([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is a summon. Summon can be player-controlled or not. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a summon, 0 if not. 
</li></ul>
Notes
<ul><li> 
</li>
<li>Summons can also be distinguished by the fact that hey have the SUMMON tag.</li>
<li>If you wish to know whether a summon is player-controlled, also check CharacterIsPlayer. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li></ul>
<h4>GetClosestAlivePlayer</h4>
Full definitions
<ul><li>query GetClosestAlivePlayer([in](GUIDSTRING)_Target, [out](CHARACTERGUID)_Player)</li></ul>
Description 
</div>
<div>
Gets the closest player to _Target that is alive and stores it in _Player.
Return values
<ul><li>Success/Failure: Fails if no living player is found. 
</li>
<li>_Player: The found player character. 
</li></ul>
Notes
<ul><li>Be careful if you check for extra conditions on the returned player: if any of those conditions fail, no other players will be considered.</li>
<li>If you want to start a dialog, use ProcGetClosestAvailableCharacterTo</li></ul>
See also
<ul><li>Helper ProcGetClosestAvailableCharacterTo</li></ul>
<div>
<div>
<h4>GetDistanceTo</h4>
Full definitions
<ul><li>query GetDistanceTo([in](GUIDSTRING)_Object1, [in](GUIDSTRING)_Object2, [out](REAL)_Dist)</li></ul>
Description 
</div>
Calculates the distance between _Object1 and _Object2.
Return values
<ul><li>Success/Failure: Fails if if either _Object1 or _Object2 is in a container or in an inventory. Use ItemIsInInventory to check for this.</li>
<li>_Dist: The distance in metres.</li></ul>
Notes
<ul><li>/ 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetInventoryOwner</h4>
Full definitions
<ul><li>query GetInventoryOwner([in](ITEMGUID)_Item, [out](GUIDSTRING)_Owner)</li></ul>
Description 
Returns the inventory/container that holds _Item in _Owner. 

Return values
<ul><li>Success/Failure: Fails if _Item is not in anyone's inventory nor in a container. 
</li>
<li>_Owner: The character or item in whose inventory the item currently resides. 
</li></ul>
Notes 

<ul><li>This call returns the outermost container. I.e., if a character has crate in their inventory, and the crate contains a pouch with the item, this call will return the character. 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetRandomPositionInTrigger</h4>
Full definitions
<ul><li>query GetRandomPositionInTrigger([in](TRIGGERGUID)_Trigger, [out](REAL)_X, [out](REAL)_Y, [out](REAL)_Z)</li></ul>
Description 
Returns a random position that is valid on the AI-grid inside _Trigger. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Trigger: A box trigger inside which the random position should be gotten. 
</li>
<li>_X, _Y, _Z: the coordinates of the random position 
</li></ul>
Notes 

<ul><li>This routine will first get a random position in the trigger, and if this random position is not valid on the AI-grid, the coordinates will be snapped to a nearby valid position on the AI-grid.</li>
<li>This call does not work for polytriggers</li></ul>
See also 

<ul><li>/ 
</li></ul>
<h4>HasActiveStatus</h4>
Full definitions
<ul><li>query HasActiveStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Target is currently under the influence of _Status. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 0 if _Target is currently not under the influence of _Status, 1 if it is. 
</li></ul>
Notes 

<ul><li>/</li></ul>
See also 

<ul><li>HasAppliedStatus 
</li></ul>
<h4>HasAppliedStatus</h4>
Full definitions
<ul><li>query HasAppliedStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Status has been applied to _Target. _Target may or may not yet actually be under its influence. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Status has not been applied to _Target, 1 if it has been. 
</li></ul>
Notes
<ul><li>In virtually all cases, use HasActiveStatus instead. The main purpose of this query is for crime reactions, and is only needed due to frame delays between code and Osiris. 
</li></ul>
See also 

<ul><li>HasActiveStatus 
</li></ul>
<h4>IsSpeakerReserved 
</h4>
Full definitions
<ul><li>query IsSpeakerReserved([in](GUIDSTRING)_Speaker, [out](INTEGER)_success)</li></ul>
Description 
Returns whether _Speaker is already in a dialog. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_success: 0 if _Speaker is currently not in a dialog, 1 otherwise. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>DialogStartRequested</li>
<li>Proc_StartDialog 
</li></ul>
<h4>ItemIsInInventory</h4>
Full definitions
<ul><li>query ItemIsInInventory([in](ITEMGUID)_Item, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Item is in an inventory. This includes both character and container inventories. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Item is not in an inventory (as defined above), 1 if it is. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>GetInventoryOwner</li></ul>
<div>
<hr>
</div>

Osiris API Tips Queries

2017-08-02T10:08:08Z

Larian octaaf: Blanked the page

Osiris API Tips Queries

2017-08-02T10:04:22Z

Larian octaaf:

Osiris API Tips Queries

2017-08-02T10:02:34Z

Larian octaaf:

<h2>Queries</h2>
Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an [out] parameter and it does not match the value the query would returns. Below, this will be called the Default Return Value. If a query can also fail under other circumstances, this will be mentioned. 

 

<div>
<div>
<h4 style="font-size:1.1em;color:rgb(36,53,93)">CharacterGetEquippedItem</h4>
Full definitions
<ul><li>query CharacterGetEquippedItem([in](CHARACTERGUID)_Character, [in](STRING)_Slotname, [out](GUIDSTRING)_ItemGUID)</li></ul>
Description 
</div>
Returns in _ItemGUID the item equipped by _Character in slot _Slotname, if any. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist, or if no item is equipped in _Slotname. 
</li>
<li>_ItemGuid: The item equipped by _Character in _Slotname. 
</li></ul>
Notes
<ul><li>The valid values for _Slotname are: Helmet, Amulet, Breast, Belt, Gloves, Leggings, Boots, Weapon, Shield, Ring, Ring2. 
</li></ul>
See also
<ul><li>CharacterUnequipItem 
</li></ul>
<div>
<h4>CharacterGetHenchmanPresetPrice</h4>
<div style="font-size:13.3333px">
Full definitions
<ul style="font-size:13.3333px"><li>query CharacterGetHenchmanPresetPrice([in](STRING)_Preset, [in](CHARACTERGUID)_Character, [out](INTEGER)_Price)</li></ul>
Description 
Returns the price of the preset scaled to the level of _Character. 

Return values
<ul style="font-size:13.3333px"><li>_Price: The price of the preset scaled to the level of _Character. 
</li></ul>
Notes
<ul style="font-size:13.3333px"><li>Presets come from the folder ".../DOS2/Data/Mods/Shared/CharacterCreation/HenchmanPresets/"</li>
<li>Presets can be customized using the following documentation: link</li></ul>
<div>
See also
<ul style="font-size:13.3333px"><li>CharacterApplyHenchmanPreset 
</li></ul>
</div>
</div>
</div>
<div>
<div>
<h4>CharacterIsAlly</h4>
Full definitions
<ul><li>query CharacterIsAlly([in](CHARACTERGUID)_Character, [in](CHARACTERGUID)_OtherCharacter, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is an ally of _OtherCharacter. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 1 if _Character and _OtherCharacter are allies, 0 if not. 
</li></ul>
Notes
<ul><li>Also works outside combat.</li>
<li>If _Character or _OtherCharacter is dead or dying, the result solely depends on the characters' alignments (factions). If they are alive, it is also influenced by temporary hostile relations, e.g. induced by attacking a neutral character. 
</li></ul>
See also
<ul><li>CharacterIsNeutral</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsEnemy</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are enemies. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsNeutral</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are neutral. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsPartyFollower</h4>
Full definitions
<ul><li>query CharacterIsPartyFollower([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is a character that follows a player character around. An NPC can be instructed to do so through CharacterFollowCharacter. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a party follower, 0 if not. 
</li></ul>
Notes
<ul><li>CharacterIsPlayer will also return true for party followers. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsPlayer</h4>
Full definitions
<ul><li>query CharacterIsPlayer([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is player-controlled. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is player-controlled, 0 if not. 
</li></ul>
Notes
<ul><li>Apart from avatars and recruited companions, player-controlled characters also include summons and followers.</li></ul>
See also
<ul><li>CharacterIsPartyFollower</li>
<li>CharacterIsSummon</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsSummon</h4>
Full definitions
<ul><li>query CharacterIsSummon([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is a summon. Summon can be player-controlled or not. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a summon, 0 if not. 
</li></ul>
Notes
<ul><li> 
</li>
<li>Summons can also be distinguished by the fact that hey have the SUMMON tag.</li>
<li>If you wish to know whether a summon is player-controlled, also check CharacterIsPlayer. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li></ul>
<h4>GetClosestAlivePlayer</h4>
Full definitions
<ul><li>query GetClosestAlivePlayer([in](GUIDSTRING)_Target, [out](CHARACTERGUID)_Player)</li></ul>
Description 
</div>
<div>
Gets the closest player to _Target that is alive and stores it in _Player.
Return values
<ul><li>Success/Failure: Fails if no living player is found. 
</li>
<li>_Player: The found player character. 
</li></ul>
Notes
<ul><li>Be careful if you check for extra conditions on the returned player: if any of those conditions fail, no other players will be considered.</li>
<li>If you want to start a dialog, use ProcGetClosestAvailableCharacterTo</li></ul>
See also
<ul><li>Helper ProcGetClosestAvailableCharacterTo</li></ul>
<div>
<div>
<h4>GetDistanceTo</h4>
Full definitions
<ul><li>query GetDistanceTo([in](GUIDSTRING)_Object1, [in](GUIDSTRING)_Object2, [out](REAL)_Dist)</li></ul>
Description 
</div>
Calculates the distance between _Object1 and _Object2.
Return values
<ul><li>Success/Failure: Fails if if either _Object1 or _Object2 is in a container or in an inventory. Use ItemIsInInventory to check for this.</li>
<li>_Dist: The distance in metres.</li></ul>
Notes
<ul><li>/ 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetInventoryOwner</h4>
Full definitions
<ul><li>query GetInventoryOwner([in](ITEMGUID)_Item, [out](GUIDSTRING)_Owner)</li></ul>
Description 
Returns the inventory/container that holds _Item in _Owner. 

Return values
<ul><li>Success/Failure: Fails if _Item is not in anyone's inventory nor in a container. 
</li>
<li>_Owner: The character or item in whose inventory the item currently resides. 
</li></ul>
Notes 

<ul><li>This call returns the outermost container. I.e., if a character has crate in their inventory, and the crate contains a pouch with the item, this call will return the character. 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetRandomPositionInTrigger</h4>
Full definitions
<ul><li>query GetRandomPositionInTrigger([in](TRIGGERGUID)_Trigger, [out](REAL)_X, [out](REAL)_Y, [out](REAL)_Z)</li></ul>
Description 
Returns a random position that is valid on the AI-grid inside _Trigger. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Trigger: A box trigger inside which the random position should be gotten. 
</li>
<li>_X, _Y, _Z: the coordinates of the random position 
</li></ul>
Notes 

<ul><li>This routine will first get a random position in the trigger, and if this random position is not valid on the AI-grid, the coordinates will be snapped to a nearby valid position on the AI-grid.</li>
<li>This call does not work for polytriggers</li></ul>
See also 

<ul><li>/ 
</li></ul>
<h4>HasActiveStatus</h4>
Full definitions
<ul><li>query HasActiveStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Target is currently under the influence of _Status. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 0 if _Target is currently not under the influence of _Status, 1 if it is. 
</li></ul>
Notes 

<ul><li>/</li></ul>
See also 

<ul><li>HasAppliedStatus 
</li></ul>
<h4>HasAppliedStatus</h4>
Full definitions
<ul><li>query HasAppliedStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Status has been applied to _Target. _Target may or may not yet actually be under its influence. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Status has not been applied to _Target, 1 if it has been. 
</li></ul>
Notes
<ul><li>In virtually all cases, use HasActiveStatus instead. The main purpose of this query is for crime reactions, and is only needed due to frame delays between code and Osiris. 
</li></ul>
See also 

<ul><li>HasActiveStatus 
</li></ul>
<h4>IsSpeakerReserved 
</h4>
Full definitions
<ul><li>query IsSpeakerReserved([in](GUIDSTRING)_Speaker, [out](INTEGER)_success)</li></ul>
Description 
Returns whether _Speaker is already in a dialog. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_success: 0 if _Speaker is currently not in a dialog, 1 otherwise. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>DialogStartRequested</li>
<li>Proc_StartDialog 
</li></ul>
<h4>ItemIsInInventory</h4>
Full definitions
<ul><li>query ItemIsInInventory([in](ITEMGUID)_Item, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Item is in an inventory. This includes both character and container inventories. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Item is not in an inventory (as defined above), 1 if it is. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>GetInventoryOwner</li></ul>
<div>
<hr>
</div>

Osiris API Tips Queries

2017-08-02T10:02:15Z

Larian octaaf: Created page with "<h3>Queries</h3> Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always..."

Osiris API Tips Events

2017-08-02T10:01:52Z

Larian octaaf: Created page with "test"

test

Osiris API Tips

2017-08-02T09:31:28Z

Larian octaaf:

<h2>Main Osiris API</h2>
<h3>Events</h3>
Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics. 

<div>
<div>
<div>
<div>
<h4>CharacterBlockedBy</h4>
Full definitions</div>
<div>
<ul><li>event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
Description</div>
<div>Thrown when a character blocks an attack from another character. 
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterMissedBy</li></ul>
<h4>CharacterMissedBy</h4>
Full definitions 
<ul><li>event CharacterMissedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
</div>
<div>Description 
Thrown when a character misses an attack from another character. 
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterBlockedBy</li></ul>
<h4>CharacterCriticalHitBy</h4>
Full definitions 
<ul><li>event CharacterCriticalHitBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
</div>
<div>Description 
<ul><li>Thrown when a character receives a critical hit from an attack of another character.</li></ul>
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterBlockedBy</li></ul>
<h4>CharacterKilledBy</h4>
<h4>
<div></div>
</h4>
<h4>
<div></div>
</h4>
Full definitions 
<ul><li>event CharacterKilledBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
</div>
<div>Description 
<ul><li>Thrown when a character is killed by another character.</li></ul>
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterBlockedBy</li></ul>
<h4>CharacterEnteredRegion</h4>
Full definitions
<ul><li>event CharacterEnteredRegion((CHARACTERGUID)_Character, (STRING)_Region)</li></ul>
Description 
</div>
Thrown when a character enters a level because it was placed there in the editor, it was teleported there via script, or it was created/spawned there via script. 

Parameters
<ul><li>_Character: the character that entered the level/region 
</li>
<li>_Region: the name of the level/region (as entered in the Levelname property of the Level -> Edit Level Data... menu entry in the editor. 
</li></ul>
Notes
<ul><li>For characters statically placed in a level using the editor, this event is thrown only once when the level is first entered. It is not thrown again when loading save games from within that level. TODO: check what happens if the players are teleported out of a level and then back into it (never done in DivinityOrigins mod). 
</li></ul>
See also
<ul><li>/</li></ul>
<h4>CharacterSawCharacter</h4>
Full definitions
<ul><li>event CharacterSawCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_OtherCharacter)</li></ul>
Description 
Thrown when one _Character sees _OtherCharacter. Note that this event is only thrown if _Character has been registered as an event generator. 

Parameters
<ul><li>_Character: the character that does the seeing.</li>
<li>_OtherCharacter: the character that is seen 
</li></ul>
Notes
<ul><li>By default, only player-controlled characters are event generators. Once you call CharacterCanSee with an NPC as first parameter, an event generator is also registered for this NPC and it will also start throwing CharacterSawCharacter events. This event generator may only work temporarily though, so in general only rely on these events be thrown for player characters. 
</li></ul>
See also
<ul><li>CharacterCanSee</li>
<li>CharacterLostSightOfCharacter 
</li></ul>
<h4>CharacterStoppedUsingItem</h4>
Full definitions
<ul><li>event CharacterStoppedUsingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)</li></ul>
Description 
</div>
Thrown when a character stopped using an item, or if a character tried to use an item and failed. 

Parameters
<ul><li>_Character: the character that used or tried to use _Item.</li>
<li>_Item: the item that was used or attempted to be used 
</li></ul>
Notes
<ul><li>/</li></ul>
See also
<ul><li>/</li></ul>
<h4>CombatStarted</h4>
Full definitions
<ul><li>event CombatStarted((INTEGER)_CombatID)</li></ul>
Description 
</div>
Thrown once a new combat has started and has been completely initialised. I.e., all initial participants have been added, and combat is ready to start. 

Parameters
<ul><li>_CombatID: A handle that identifies the combat. Should always be > 0.</li></ul>
Notes
<ul><li>This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new ObjectEnteredCombat event will be thrown for every participant still in the combat, followed by a new CombatStartedEvent with the same _CombatID as before. During these new ObjectEventeredCombat events and CombatStarted event, the combat must again be considered to be not completely initialised yet.</li>
<li>This event will also be thrown when two combats are merged. 
</li></ul>
See also
<ul><li>ObjectEnteredCombat</li>
<li>ObjectLeftCombat 
</li></ul>
<h4>DialogStartRequested</h4>
Full definitions
<ul><li>event DialogStartRequested((GUIDSTRING)_Target,(GUIDSTRING)_Player)</li></ul>
Description 
Thrown whenever a player tries to start a conversation with another object. 

Parameters
<ul><li>_Target: The object to which the conversation request is directed.</li>
<li>_Player: The player that initiated the conversation 
</li></ul>
Notes
<ul><li>Do not use this event directly. Overload PROC_GLOBAL_DialogStartRequested or PROC_GLOBAL_DialogStartRequested_AfterGenerics instead, so that certain common behaviours are guaranteed to hold in all cases.</li>
<li>This event can only be thrown if the target can accept dialog requests, i.e. if SetHasDialog(_Target,1) is currently active.</li></ul>
See also
<ul><li>SetHasDialog 
</li>
<li>helper PROC_GLOBAL_DialogStartRequested 
</li>
<li>helper PROC_GLOBAL_DialogStartRequested_AfterGenerics</li></ul>
<h4>GameStarted</h4>
Full definitions
<ul><li>event GameStarted((String)_LevelName, (INTEGER)_IsEditorMode)</li></ul>
Description 
</div>
Thrown when a level has been loaded and is ready at both the server and client side. 

Parameters
<ul><li>_LevelName: The identifier name of the level that has been loaded 
</li>
<li>_IsEditorMode: Indicates whether the game is run in the editor or not 
</li></ul>
Notes
<ul><li>The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics. 
</li>
<li>An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready) 
</li>
<li>See RegionStarted for an event that is thrown when the level is ready on the server side.</li>
<li>This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead). 
</li></ul>
<div>
<div>
See also
<ul><li>RegionStarted</li></ul>
<h4>ObjectEnteredCombat</h4>
Full definitions
<ul><li>event ObjectEnteredCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)</li></ul>
Description 
</div>
Thrown when an object (character or item) enters a combat. 

Parameters
<ul><li>_Object: The object that has entered the combat 
</li>
<li>_CombatID: A handle that identifies the combat. Should always be > 0. 
</li></ul>
Notes
<ul><li>This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.</li>
<li>If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as JumpToTurn yet. If you wish to perform some action when a combat has completely started, use CombatStarted instead.</li></ul>
See also
<ul><li>CombatStarted</li>
<li>ObjectLeftCombat 
</li></ul>
<h4>ObjectFlagSet</h4>
Full definitions
<ul><li>event ObjectFlagSet((STRING)_FlagName, (GUIDSTRING)_Speaker, (INTEGER)_DialogInstance)</li></ul>
Description 
Thrown when the flag _FlagName is set on object _Speaker in the context indicated by _DialogInstance. 

Parameters
<ul><li>_FlagName: The flag that is set. 
</li>
<li>_Speaker: The object on which the (character) flag is set.</li>
<li>_DialogInstance: If the flag was set using a dialog node, _DialogInstance contains the dialog's instance ID. If the flag was set from story, _DialogInstance will contain whatever was passed as last parameter to ObjectSetFlag. If the flag was set from behaviour script, DialogInstance will be zero.</li></ul>
Notes
<ul><li>/ 
</li></ul>
See also
<ul><li>ObjectSetFlag</li>
<li>ObjectClearFlag 
</li></ul>
<h4>ObjectLeftCombat</h4>
Full definitions
<ul><li>event ObjectLeftCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)</li></ul>
Description 
Thrown when an object (character or item) leaves a combat. 

Parameters
<ul><li>_Object: The object that has left the combat 
</li>
<li>_CombatID: A handle that identifies the combat. Should always be > 0. 
</li></ul>
Notes
<ul><li>Reasons why characters may leave combat is because they died, because they got too far from the other participants, or because story forced them to leave.</li></ul>
See also 

<ul><li>CombatStarted</li>
<li>ObjectEnteredCombat</li></ul>
<h4>ObjectSourcePointAddRequest</h4>
Full definitions
<ul><li>event ObjectSourcePointAddRequest((GUIDSTRING)_Target, (INTEGER)_Amount)</li></ul>
Description 
Thrown for every attempt to add source to an object, even if the object cannot hold more source. It is thrown before the source has been added. 

Parameters
<ul><li>_Target: The object to which source gets added. In case of a character, this means there is an attempt to add source points. In case of an item, this means there is an attempt to add charges. 
</li>
<li>_Amount: The number of source points/charges that is being added. 
</li></ul>
Notes
<ul><li>As mentioned in the description, this is triggered even when _Target currently already holds its maximum of source. 
</li></ul>
See also
<ul><li>/</li></ul>
<h4>RegionStarted</h4>
Full definitions
<ul><li>event RegionStarted((String)_LevelName)</li></ul>
Description 
</div>
Thrown when the level has been loaded and is ready at the server side, but not yet at the client side. 

Parameters
<ul><li>_LevelName: The identifier name of the level that has been loaded 
</li></ul>
Notes
<ul><li>See GameStarted for usage information that also applies to this call.</li></ul>
See also
<ul><li>GameStarted</li></ul>
<div>
<hr>
</div>

Osiris API Tips

2017-08-02T09:30:07Z

Larian octaaf:

<div><img src="https://www.google.com/chart?chc=sites&cht=d&chdp=sites&chl=%5B%5BTable+of+contents'%3D20'f%5Cv'a%5C%3D0'10'%3D749'0'dim'%5Cbox1'b%5CF6F6F6'fC%5CF6F6F6'eC%5C0'sk'%5C%5B'%5D'a%5CV%5C%3D12'f%5C%5DV%5Cta%5C%3D10'%3D0'%3D750'%3D297'dim'%5C%3D10'%3D10'%3D750'%3D297'vdim'%5Cbox1'b%5Cva%5CF6F6F6'fC%5CC8C8C8'eC%5C'a%5C%5Do%5CLauto'f%5C&sig=6OQlG6gOnnBFfFkmejXWTLbCWDE" data-type="toc" data-props="align:left;maxDepth:6;width:750;" width="750" height="300" style="display:block;text-align:left;margin-right:auto;"></div>
<h2>Subpages 
</h2>
<ul><li>
<h3><a href="https://sites.google.com/a/larian.com/larian-wikisite/osiris-api-tips-crimes">Osiris API for crimes</a> 
</h3>
</li></ul>
<h2>Main Osiris API</h2>
<h3>Events</h3>
Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics. 

<div>
<div>
<div>
<div>
<h4>CharacterBlockedBy</h4>
Full definitions</div>
<div>
<ul><li>event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
Description</div>
<div>Thrown when a character blocks an attack from another character. 
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterMissedBy</li></ul>
<h4>CharacterMissedBy</h4>
Full definitions 
<ul><li>event CharacterMissedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
</div>
<div>Description 
Thrown when a character misses an attack from another character. 
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterBlockedBy</li></ul>
<h4>CharacterCriticalHitBy</h4>
Full definitions 
<ul><li>event CharacterCriticalHitBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
</div>
<div>Description 
<ul><li>Thrown when a character receives a critical hit from an attack of another character.</li></ul>
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterBlockedBy</li></ul>
<h4>CharacterKilledBy</h4>
<h4>
<div></div>
</h4>
<h4>
<div></div>
</h4>
Full definitions 
<ul><li>event CharacterKilledBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
</div>
<div>Description 
<ul><li>Thrown when a character is killed by another character.</li></ul>
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>
 
See also 
<ul><li>CharacterBlockedBy</li></ul>
<h4>CharacterEnteredRegion</h4>
Full definitions
<ul><li>event CharacterEnteredRegion((CHARACTERGUID)_Character, (STRING)_Region)</li></ul>
Description 
</div>
Thrown when a character enters a level because it was placed there in the editor, it was teleported there via script, or it was created/spawned there via script. 

Parameters
<ul><li>_Character: the character that entered the level/region 
</li>
<li>_Region: the name of the level/region (as entered in the Levelname property of the Level -> Edit Level Data... menu entry in the editor. 
</li></ul>
Notes
<ul><li>For characters statically placed in a level using the editor, this event is thrown only once when the level is first entered. It is not thrown again when loading save games from within that level. TODO: check what happens if the players are teleported out of a level and then back into it (never done in DivinityOrigins mod). 
</li></ul>
See also
<ul><li>/</li></ul>
<h4>CharacterSawCharacter</h4>
Full definitions
<ul><li>event CharacterSawCharacter((CHARACTERGUID)_Character, (CHARACTERGUID)_OtherCharacter)</li></ul>
Description 
Thrown when one _Character sees _OtherCharacter. Note that this event is only thrown if _Character has been registered as an event generator. 

Parameters
<ul><li>_Character: the character that does the seeing.</li>
<li>_OtherCharacter: the character that is seen 
</li></ul>
Notes
<ul><li>By default, only player-controlled characters are event generators. Once you call CharacterCanSee with an NPC as first parameter, an event generator is also registered for this NPC and it will also start throwing CharacterSawCharacter events. This event generator may only work temporarily though, so in general only rely on these events be thrown for player characters. 
</li></ul>
See also
<ul><li>CharacterCanSee</li>
<li>CharacterLostSightOfCharacter 
</li></ul>
<h4>CharacterStoppedUsingItem</h4>
Full definitions
<ul><li>event CharacterStoppedUsingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)</li></ul>
Description 
</div>
Thrown when a character stopped using an item, or if a character tried to use an item and failed. 

Parameters
<ul><li>_Character: the character that used or tried to use _Item.</li>
<li>_Item: the item that was used or attempted to be used 
</li></ul>
Notes
<ul><li>/</li></ul>
See also
<ul><li>/</li></ul>
<h4>CombatStarted</h4>
Full definitions
<ul><li>event CombatStarted((INTEGER)_CombatID)</li></ul>
Description 
</div>
Thrown once a new combat has started and has been completely initialised. I.e., all initial participants have been added, and combat is ready to start. 

Parameters
<ul><li>_CombatID: A handle that identifies the combat. Should always be > 0.</li></ul>
Notes
<ul><li>This event can also be thrown for an ongoing combat after one or more participants left. In this case, first a new ObjectEnteredCombat event will be thrown for every participant still in the combat, followed by a new CombatStartedEvent with the same _CombatID as before. During these new ObjectEventeredCombat events and CombatStarted event, the combat must again be considered to be not completely initialised yet.</li>
<li>This event will also be thrown when two combats are merged. 
</li></ul>
See also
<ul><li>ObjectEnteredCombat</li>
<li>ObjectLeftCombat 
</li></ul>
<h4>DialogStartRequested</h4>
Full definitions
<ul><li>event DialogStartRequested((GUIDSTRING)_Target,(GUIDSTRING)_Player)</li></ul>
Description 
Thrown whenever a player tries to start a conversation with another object. 

Parameters
<ul><li>_Target: The object to which the conversation request is directed.</li>
<li>_Player: The player that initiated the conversation 
</li></ul>
Notes
<ul><li>Do not use this event directly. Overload PROC_GLOBAL_DialogStartRequested or PROC_GLOBAL_DialogStartRequested_AfterGenerics instead, so that certain common behaviours are guaranteed to hold in all cases.</li>
<li>This event can only be thrown if the target can accept dialog requests, i.e. if SetHasDialog(_Target,1) is currently active.</li></ul>
See also
<ul><li>SetHasDialog 
</li>
<li>helper PROC_GLOBAL_DialogStartRequested 
</li>
<li>helper PROC_GLOBAL_DialogStartRequested_AfterGenerics</li></ul>
<h4>GameStarted</h4>
Full definitions
<ul><li>event GameStarted((String)_LevelName, (INTEGER)_IsEditorMode)</li></ul>
Description 
</div>
Thrown when a level has been loaded and is ready at both the server and client side. 

Parameters
<ul><li>_LevelName: The identifier name of the level that has been loaded 
</li>
<li>_IsEditorMode: Indicates whether the game is run in the editor or not 
</li></ul>
Notes
<ul><li>The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics. 
</li>
<li>An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready) 
</li>
<li>See RegionStarted for an event that is thrown when the level is ready on the server side.</li>
<li>This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead). 
</li></ul>
<div>
<div>
See also
<ul><li>RegionStarted</li></ul>
<h4>ObjectEnteredCombat</h4>
Full definitions
<ul><li>event ObjectEnteredCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)</li></ul>
Description 
</div>
Thrown when an object (character or item) enters a combat. 

Parameters
<ul><li>_Object: The object that has entered the combat 
</li>
<li>_CombatID: A handle that identifies the combat. Should always be > 0. 
</li></ul>
Notes
<ul><li>This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.</li>
<li>If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as JumpToTurn yet. If you wish to perform some action when a combat has completely started, use CombatStarted instead.</li></ul>
See also
<ul><li>CombatStarted</li>
<li>ObjectLeftCombat 
</li></ul>
<h4>ObjectFlagSet</h4>
Full definitions
<ul><li>event ObjectFlagSet((STRING)_FlagName, (GUIDSTRING)_Speaker, (INTEGER)_DialogInstance)</li></ul>
Description 
Thrown when the flag _FlagName is set on object _Speaker in the context indicated by _DialogInstance. 

Parameters
<ul><li>_FlagName: The flag that is set. 
</li>
<li>_Speaker: The object on which the (character) flag is set.</li>
<li>_DialogInstance: If the flag was set using a dialog node, _DialogInstance contains the dialog's instance ID. If the flag was set from story, _DialogInstance will contain whatever was passed as last parameter to ObjectSetFlag. If the flag was set from behaviour script, DialogInstance will be zero.</li></ul>
Notes
<ul><li>/ 
</li></ul>
See also
<ul><li>ObjectSetFlag</li>
<li>ObjectClearFlag 
</li></ul>
<h4>ObjectLeftCombat</h4>
Full definitions
<ul><li>event ObjectLeftCombat((GUIDSTRING)_Object, (INTEGER)_CombatID)</li></ul>
Description 
Thrown when an object (character or item) leaves a combat. 

Parameters
<ul><li>_Object: The object that has left the combat 
</li>
<li>_CombatID: A handle that identifies the combat. Should always be > 0. 
</li></ul>
Notes
<ul><li>Reasons why characters may leave combat is because they died, because they got too far from the other participants, or because story forced them to leave.</li></ul>
See also 

<ul><li>CombatStarted</li>
<li>ObjectEnteredCombat</li></ul>
<h4>ObjectSourcePointAddRequest</h4>
Full definitions
<ul><li>event ObjectSourcePointAddRequest((GUIDSTRING)_Target, (INTEGER)_Amount)</li></ul>
Description 
Thrown for every attempt to add source to an object, even if the object cannot hold more source. It is thrown before the source has been added. 

Parameters
<ul><li>_Target: The object to which source gets added. In case of a character, this means there is an attempt to add source points. In case of an item, this means there is an attempt to add charges. 
</li>
<li>_Amount: The number of source points/charges that is being added. 
</li></ul>
Notes
<ul><li>As mentioned in the description, this is triggered even when _Target currently already holds its maximum of source. 
</li></ul>
See also
<ul><li>/</li></ul>
<h4>RegionStarted</h4>
Full definitions
<ul><li>event RegionStarted((String)_LevelName)</li></ul>
Description 
</div>
Thrown when the level has been loaded and is ready at the server side, but not yet at the client side. 

Parameters
<ul><li>_LevelName: The identifier name of the level that has been loaded 
</li></ul>
Notes
<ul><li>See GameStarted for usage information that also applies to this call.</li></ul>
See also
<ul><li>GameStarted</li></ul>
<div>
<hr>
</div>

Osiris API Tips

2017-07-31T13:11:53Z

Larian octaaf:

<h2>Main Osiris API</h2>
<h3>Events</h3>
Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics. 

<div>
<div>
<div>
<div>
<h4>CharacterBlockedBy</h4>
Full definitions</div>
<div>
<ul><li>event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
Description</div>
<div>Thrown when a character blocks an attack from another character. 
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>

Osiris API Tips

2017-07-31T13:11:45Z

Larian octaaf:

</li></ul>
<h2>Main Osiris API</h2>
<h3>Events</h3>
Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics. 

<div>
<div>
<div>
<div>
<h4>CharacterBlockedBy</h4>
Full definitions</div>
<div>
<ul><li>event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
Description</div>
<div>Thrown when a character blocks an attack from another character. 
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>

Osiris API Tips

2017-07-31T13:11:26Z

Larian octaaf: Created page with " <ul><li> <h3><a href="https://sites.google.com/a/larian.com/larian-wikisite/osiris-api-tips-crimes">Osiris API for crimes</a> </h3> </li></ul> <h2>Main Osiris API</h2..."

<ul><li>
<h3><a href="https://sites.google.com/a/larian.com/larian-wikisite/osiris-api-tips-crimes">Osiris API for crimes</a> 
</h3>
</li></ul>
<h2>Main Osiris API</h2>
<h3>Events</h3>
Events are a way for Osiris to inform script that something happened. All event parameters have [in] semantics. 

<div>
<div>
<div>
<div>
<h4>CharacterBlockedBy</h4>
Full definitions</div>
<div>
<ul><li>event CharacterBlokedBy((CHARACTERGUID)_Defender, (CHARACTERGUID)_Attacker, (CHARACTERGUID)_AttackerOwner)</li></ul>
</div>
<div> 
Description</div>
<div>Thrown when a character blocks an attack from another character. 
 
Parameters 
<ul><li>_Defender: The character that received/defended the attack.</li>
<li>_Attacker: The character that attacked the _Defender.</li>
<li>_AttackerOwner: The character that owns the _Attacker character.</li></ul>
 
Notes 
<ul><li>_AttackerOwner can be the same character as _Attacker, _AttackOwner will be different in the case of summoned characters.</li></ul>

Technical documentation

2017-07-31T13:10:01Z

Larian octaaf: /* Misc */

== Systems ==
* [[Templates explanation|Root and local templates, how do they work?]]
* [[AI grid|AI grid: surfaces, walkables, ...]]
* [[Scripting|Scripting]]
* [[Osiris|Osiris: story scripting]]

== Panels ==
* [[Root template panel]]
* [[World outliner]]
* [[Sidebar]]
* [[AI grid panel]]

== Editors ==
* [[Material editor]]
* [[Stats editor]]
* [[Story editor]]
* [[Script editor]]

== Misc ==
* [[Project browser]]
* [[Main toolbar]]
* [[Osiris API Tips]]

== Console ==
* [[Command list]]
* [[ReCon|ReCon: remote console]]

Main Page

2017-07-28T14:01:09Z

Larian octaaf:

[[File:dos2banner.jpg|center]]

== Technical Documentation ==
* [[Choice1]]

== Step 1: New Project - What type of project do I need? ==
* [[Campaign]]
* [[You want to create an entire story, with levels and fights and dialogues, and a lot of scripting.]]
* [[Add-on]]
* [[You want to modify non-story parts of the existing campaign or another mod.]]
* [[Story mod]]
* [[You want to change or add to the Divinity Original Sin 2 story code.]]
== Step 2: Load or Create Level ==
* [[Choose Level]]
* [[Load an existing level in your project or in the campaign]]
* [[Create New Level]]
* [[A fresh start.]]
* [[But I don't want to create or change a level: choose Sandbox]]
* [[Choose sandbox if you want to work on treasure, stats, textures, models...]]
== Step 3: Now how do I... ==
* [[MOD THE MAIN CAMPAIGN]]
* [[Modding visuals]]
* [[Change icons of statuses, skills, NPCs...]]
* [[Add player icons to select from]]
* [[Change 3D models]]
* [[Change a texture]]
* [[Change the atmosphere (lighting etc)]]
* [[Change animations]]
* [[Change existing materials, or create and assign new materials]]
* [[Change visual fx]]
* [[Change Balancing]]
* [[Change enemy and NPC stats and gear]]
* [[Change enemy behaviour and known skills]]
* [[Change base stats of player characters]]
* [[Change presets and create new presets ("classes")]]
* [[Change player weapon and armour stats]]
* [[Change some exposed combat and gameplay variables]]
* [[Change the gold value of things]]
* [[Change what food and potions do]]
* [[Change crafting ingredients and results]]
* [[Change treasure settings of containers and characters]]
* [[Change trade inventories of characters]]
* [[Change magical properties of magic modifiers on generated items]]
* [[Change settings of magic generation of items]]
* [[Change some talent settings]]
* [[Change skill properties (e.g. damage, action points...)]]
* [[Change skill, crafting and item requirements; and talent requirements]]
* [[Change how statuses act and react]]
* [[Change some exposed surface settings]]
* [[Translate the game]]
* [[By using a loca kit, not the modding tool.]]
* [[Make one of those fancy camera-flies-through-the-level movies?]]
* [[Use splines!]]
* [[Change interactivity]]
* [[Change what items you can pick up and move]]
* [[Change what item tooltips are shown in the world]]
* [[Change how items behave when you destroy them]]
* [[Change, add, remove use actions on items]]
* [[Change text]]
* [[Add hints to the loading screen]]
* [[Change character names, item names and item descriptions]]
* [[Change contents of books]]
* [[Change dialogs]]
* [[Change journal entries]]
* [[Redecorate existing levels]]
* [[Move items and characters around]]
* [[Change the terrain]]
* [[Add books to the game]]
* [[Add keys to existing chests]]
* [[Add chests and containers to the game]]
* [[Add decorational items to the game]]
* [[Add weapons and armour to the game]]
* [[Change terrain]]
* [[Modify scripting]]
* [[Change story code]]
* [[Change behaviour script code]]
* [[ADD STUFF TO THE MAIN CAMPAIGN]]
== FAQ: Why can I not... ==
* [[Add talents to the game?]]
* [[Talents are coded in C++. They usually override or change the gameplay rules in such a unique way, that it's not viable to create reusable templates and make them data driven.]]
* [[Change all sounds in the game?]]
* [[We use Wwise and sounds have to be added and processed in Wwise.]]
* [[Mod the UI?]]

{| class="wikitable" style="width: 50%;"
| tables
| are
|-
| style="width: 30%;"|
hard
| yes
|-
| FAQ
|}

{{category header|background-color=#E0E0E0|border-color=lightgray}}
{{category newcolumn|rowspan=1|width=50%|background-color=#F7F7F7|border-color=lightgray}}

== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]

File:Dos2banner.jpg

2017-07-28T14:00:43Z

Larian octaaf:

Main Page

2017-07-28T09:43:30Z

Larian octaaf:

[[File:editor.jpg|center]]

== Technical Documentation ==
* [[Choice1]]

== Step 1: New Project - What type of project do I need? ==
* [[Campaign]]
* [[You want to create an entire story, with levels and fights and dialogues, and a lot of scripting.]]
* [[Add-on]]
* [[You want to modify non-story parts of the existing campaign or another mod.]]
* [[Story mod]]
* [[You want to change or add to the Divinity Original Sin 2 story code.]]
== Step 2: Load or Create Level ==
* [[Choose Level]]
* [[Load an existing level in your project or in the campaign]]
* [[Create New Level]]
* [[A fresh start.]]
* [[But I don't want to create or change a level: choose Sandbox]]
* [[Choose sandbox if you want to work on treasure, stats, textures, models...]]
== Step 3: Now how do I... ==
* [[MOD THE MAIN CAMPAIGN]]
* [[Modding visuals]]
* [[Change icons of statuses, skills, NPCs...]]
* [[Add player icons to select from]]
* [[Change 3D models]]
* [[Change a texture]]
* [[Change the atmosphere (lighting etc)]]
* [[Change animations]]
* [[Change existing materials, or create and assign new materials]]
* [[Change visual fx]]
* [[Change Balancing]]
* [[Change enemy and NPC stats and gear]]
* [[Change enemy behaviour and known skills]]
* [[Change base stats of player characters]]
* [[Change presets and create new presets ("classes")]]
* [[Change player weapon and armour stats]]
* [[Change some exposed combat and gameplay variables]]
* [[Change the gold value of things]]
* [[Change what food and potions do]]
* [[Change crafting ingredients and results]]
* [[Change treasure settings of containers and characters]]
* [[Change trade inventories of characters]]
* [[Change magical properties of magic modifiers on generated items]]
* [[Change settings of magic generation of items]]
* [[Change some talent settings]]
* [[Change skill properties (e.g. damage, action points...)]]
* [[Change skill, crafting and item requirements; and talent requirements]]
* [[Change how statuses act and react]]
* [[Change some exposed surface settings]]
* [[Translate the game]]
* [[By using a loca kit, not the modding tool.]]
* [[Make one of those fancy camera-flies-through-the-level movies?]]
* [[Use splines!]]
* [[Change interactivity]]
* [[Change what items you can pick up and move]]
* [[Change what item tooltips are shown in the world]]
* [[Change how items behave when you destroy them]]
* [[Change, add, remove use actions on items]]
* [[Change text]]
* [[Add hints to the loading screen]]
* [[Change character names, item names and item descriptions]]
* [[Change contents of books]]
* [[Change dialogs]]
* [[Change journal entries]]
* [[Redecorate existing levels]]
* [[Move items and characters around]]
* [[Change the terrain]]
* [[Add books to the game]]
* [[Add keys to existing chests]]
* [[Add chests and containers to the game]]
* [[Add decorational items to the game]]
* [[Add weapons and armour to the game]]
* [[Change terrain]]
* [[Modify scripting]]
* [[Change story code]]
* [[Change behaviour script code]]
* [[ADD STUFF TO THE MAIN CAMPAIGN]]
== FAQ: Why can I not... ==
* [[Add talents to the game?]]
* [[Talents are coded in C++. They usually override or change the gameplay rules in such a unique way, that it's not viable to create reusable templates and make them data driven.]]
* [[Change all sounds in the game?]]
* [[We use Wwise and sounds have to be added and processed in Wwise.]]
* [[Mod the UI?]]

{| class="wikitable" style="width: 50%;"
| tables
| are
|-
| style="width: 30%;"|
hard
| yes
|-
| FAQ
|}

{{category header|background-color=#E0E0E0|border-color=lightgray}}
{{category newcolumn|rowspan=1|width=50%|background-color=#F7F7F7|border-color=lightgray}}

== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]

Main Page

2017-07-27T20:44:35Z

Larian octaaf:

[[File:editor.jpg|center]]

== Step 1: New Project - What type of project do I need? ==
* [[Campaign]]
* [[You want to create an entire story, with levels and fights and dialogues, and a lot of scripting.]]
* [[Add-on]]
* [[You want to modify non-story parts of the existing campaign or another mod.]]
* [[Story mod]]
* [[You want to change or add to the Divinity Original Sin 2 story code.]]
== Step 2: Load or Create Level ==
* [[Choose Level]]
* [[Load an existing level in your project or in the campaign]]
* [[Create New Level]]
* [[A fresh start.]]
* [[But I don't want to create or change a level: choose Sandbox]]
* [[Choose sandbox if you want to work on treasure, stats, textures, models...]]
== Step 3: Now how do I... ==
* [[MOD THE MAIN CAMPAIGN]]
* [[Modding visuals]]
* [[Change icons of statuses, skills, NPCs...]]
* [[Add player icons to select from]]
* [[Change 3D models]]
* [[Change a texture]]
* [[Change the atmosphere (lighting etc)]]
* [[Change animations]]
* [[Change existing materials, or create and assign new materials]]
* [[Change visual fx]]
* [[Change Balancing]]
* [[Change enemy and NPC stats and gear]]
* [[Change enemy behaviour and known skills]]
* [[Change base stats of player characters]]
* [[Change presets and create new presets ("classes")]]
* [[Change player weapon and armour stats]]
* [[Change some exposed combat and gameplay variables]]
* [[Change the gold value of things]]
* [[Change what food and potions do]]
* [[Change crafting ingredients and results]]
* [[Change treasure settings of containers and characters]]
* [[Change trade inventories of characters]]
* [[Change magical properties of magic modifiers on generated items]]
* [[Change settings of magic generation of items]]
* [[Change some talent settings]]
* [[Change skill properties (e.g. damage, action points...)]]
* [[Change skill, crafting and item requirements; and talent requirements]]
* [[Change how statuses act and react]]
* [[Change some exposed surface settings]]
* [[Translate the game]]
* [[By using a loca kit, not the modding tool.]]
* [[Make one of those fancy camera-flies-through-the-level movies?]]
* [[Use splines!]]
* [[Change interactivity]]
* [[Change what items you can pick up and move]]
* [[Change what item tooltips are shown in the world]]
* [[Change how items behave when you destroy them]]
* [[Change, add, remove use actions on items]]
* [[Change text]]
* [[Add hints to the loading screen]]
* [[Change character names, item names and item descriptions]]
* [[Change contents of books]]
* [[Change dialogs]]
* [[Change journal entries]]
* [[Redecorate existing levels]]
* [[Move items and characters around]]
* [[Change the terrain]]
* [[Add books to the game]]
* [[Add keys to existing chests]]
* [[Add chests and containers to the game]]
* [[Add decorational items to the game]]
* [[Add weapons and armour to the game]]
* [[Change terrain]]
* [[Modify scripting]]
* [[Change story code]]
* [[Change behaviour script code]]
* [[ADD STUFF TO THE MAIN CAMPAIGN]]
== FAQ: Why can I not... ==
* [[Add talents to the game?]]
* [[Talents are coded in C++. They usually override or change the gameplay rules in such a unique way, that it's not viable to create reusable templates and make them data driven.]]
* [[Change all sounds in the game?]]
* [[We use Wwise and sounds have to be added and processed in Wwise.]]
* [[Mod the UI?]]

{| class="wikitable" style="width: 50%;"
| tables
| are
|-
| style="width: 30%;"|
hard
| yes
|-
| FAQ
|}

{{category header|background-color=#E0E0E0|border-color=lightgray}}
{{category newcolumn|rowspan=1|width=50%|background-color=#F7F7F7|border-color=lightgray}}

== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]

Main Page

2017-07-27T20:44:01Z

Larian octaaf:

[[File:editor.jpg]]

== Step 1: New Project - What type of project do I need? ==
* [[Campaign]]
* [[You want to create an entire story, with levels and fights and dialogues, and a lot of scripting.]]
* [[Add-on]]
* [[You want to modify non-story parts of the existing campaign or another mod.]]
* [[Story mod]]
* [[You want to change or add to the Divinity Original Sin 2 story code.]]
== Step 2: Load or Create Level ==
* [[Choose Level]]
* [[Load an existing level in your project or in the campaign]]
* [[Create New Level]]
* [[A fresh start.]]
* [[But I don't want to create or change a level: choose Sandbox]]
* [[Choose sandbox if you want to work on treasure, stats, textures, models...]]
== Step 3: Now how do I... ==
* [[MOD THE MAIN CAMPAIGN]]
* [[Modding visuals]]
* [[Change icons of statuses, skills, NPCs...]]
* [[Add player icons to select from]]
* [[Change 3D models]]
* [[Change a texture]]
* [[Change the atmosphere (lighting etc)]]
* [[Change animations]]
* [[Change existing materials, or create and assign new materials]]
* [[Change visual fx]]
* [[Change Balancing]]
* [[Change enemy and NPC stats and gear]]
* [[Change enemy behaviour and known skills]]
* [[Change base stats of player characters]]
* [[Change presets and create new presets ("classes")]]
* [[Change player weapon and armour stats]]
* [[Change some exposed combat and gameplay variables]]
* [[Change the gold value of things]]
* [[Change what food and potions do]]
* [[Change crafting ingredients and results]]
* [[Change treasure settings of containers and characters]]
* [[Change trade inventories of characters]]
* [[Change magical properties of magic modifiers on generated items]]
* [[Change settings of magic generation of items]]
* [[Change some talent settings]]
* [[Change skill properties (e.g. damage, action points...)]]
* [[Change skill, crafting and item requirements; and talent requirements]]
* [[Change how statuses act and react]]
* [[Change some exposed surface settings]]
* [[Translate the game]]
* [[By using a loca kit, not the modding tool.]]
* [[Make one of those fancy camera-flies-through-the-level movies?]]
* [[Use splines!]]
* [[Change interactivity]]
* [[Change what items you can pick up and move]]
* [[Change what item tooltips are shown in the world]]
* [[Change how items behave when you destroy them]]
* [[Change, add, remove use actions on items]]
* [[Change text]]
* [[Add hints to the loading screen]]
* [[Change character names, item names and item descriptions]]
* [[Change contents of books]]
* [[Change dialogs]]
* [[Change journal entries]]
* [[Redecorate existing levels]]
* [[Move items and characters around]]
* [[Change the terrain]]
* [[Add books to the game]]
* [[Add keys to existing chests]]
* [[Add chests and containers to the game]]
* [[Add decorational items to the game]]
* [[Add weapons and armour to the game]]
* [[Change terrain]]
* [[Modify scripting]]
* [[Change story code]]
* [[Change behaviour script code]]
* [[ADD STUFF TO THE MAIN CAMPAIGN]]
== FAQ: Why can I not... ==
* [[Add talents to the game?]]
* [[Talents are coded in C++. They usually override or change the gameplay rules in such a unique way, that it's not viable to create reusable templates and make them data driven.]]
* [[Change all sounds in the game?]]
* [[We use Wwise and sounds have to be added and processed in Wwise.]]
* [[Mod the UI?]]

{| class="wikitable" style="width: 50%;"
| tables
| are
|-
| style="width: 30%;"|
hard
| yes
|-
| FAQ
|}

{{category header|background-color=#E0E0E0|border-color=lightgray}}
{{category newcolumn|rowspan=1|width=50%|background-color=#F7F7F7|border-color=lightgray}}

== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]

Mod the UI?

2017-07-27T20:38:37Z

Larian octaaf: Created page with "1"

We use Wwise and sounds have to be added and processed in Wwise.

2017-07-27T20:38:35Z

Larian octaaf: Created page with "1"

Change all sounds in the game?

2017-07-27T20:38:33Z

Larian octaaf: Created page with "1"

Add talents to the game?

2017-07-27T20:38:30Z

Larian octaaf: Created page with "1"

Main Page

2017-07-27T20:38:27Z

Larian octaaf:

== Step 1: New Project - What type of project do I need? ==
* [[Campaign]]
* [[You want to create an entire story, with levels and fights and dialogues, and a lot of scripting.]]
* [[Add-on]]
* [[You want to modify non-story parts of the existing campaign or another mod.]]
* [[Story mod]]
* [[You want to change or add to the Divinity Original Sin 2 story code.]]
== Step 2: Load or Create Level ==
* [[Choose Level]]
* [[Load an existing level in your project or in the campaign]]
* [[Create New Level]]
* [[A fresh start.]]
* [[But I don't want to create or change a level: choose Sandbox]]
* [[Choose sandbox if you want to work on treasure, stats, textures, models...]]
== Step 3: Now how do I... ==
* [[MOD THE MAIN CAMPAIGN]]
* [[Modding visuals]]
* [[Change icons of statuses, skills, NPCs...]]
* [[Add player icons to select from]]
* [[Change 3D models]]
* [[Change a texture]]
* [[Change the atmosphere (lighting etc)]]
* [[Change animations]]
* [[Change existing materials, or create and assign new materials]]
* [[Change visual fx]]
* [[Change Balancing]]
* [[Change enemy and NPC stats and gear]]
* [[Change enemy behaviour and known skills]]
* [[Change base stats of player characters]]
* [[Change presets and create new presets ("classes")]]
* [[Change player weapon and armour stats]]
* [[Change some exposed combat and gameplay variables]]
* [[Change the gold value of things]]
* [[Change what food and potions do]]
* [[Change crafting ingredients and results]]
* [[Change treasure settings of containers and characters]]
* [[Change trade inventories of characters]]
* [[Change magical properties of magic modifiers on generated items]]
* [[Change settings of magic generation of items]]
* [[Change some talent settings]]
* [[Change skill properties (e.g. damage, action points...)]]
* [[Change skill, crafting and item requirements; and talent requirements]]
* [[Change how statuses act and react]]
* [[Change some exposed surface settings]]
* [[Translate the game]]
* [[By using a loca kit, not the modding tool.]]
* [[Make one of those fancy camera-flies-through-the-level movies?]]
* [[Use splines!]]
* [[Change interactivity]]
* [[Change what items you can pick up and move]]
* [[Change what item tooltips are shown in the world]]
* [[Change how items behave when you destroy them]]
* [[Change, add, remove use actions on items]]
* [[Change text]]
* [[Add hints to the loading screen]]
* [[Change character names, item names and item descriptions]]
* [[Change contents of books]]
* [[Change dialogs]]
* [[Change journal entries]]
* [[Redecorate existing levels]]
* [[Move items and characters around]]
* [[Change the terrain]]
* [[Add books to the game]]
* [[Add keys to existing chests]]
* [[Add chests and containers to the game]]
* [[Add decorational items to the game]]
* [[Add weapons and armour to the game]]
* [[Change terrain]]
* [[Modify scripting]]
* [[Change story code]]
* [[Change behaviour script code]]
* [[ADD STUFF TO THE MAIN CAMPAIGN]]
== FAQ: Why can I not... ==
* [[Add talents to the game?]]
* [[Talents are coded in C++. They usually override or change the gameplay rules in such a unique way, that it's not viable to create reusable templates and make them data driven.]]
* [[Change all sounds in the game?]]
* [[We use Wwise and sounds have to be added and processed in Wwise.]]
* [[Mod the UI?]]

{| class="wikitable" style="width: 50%;"
| tables
| are
|-
| style="width: 30%;"|
hard
| yes
|-
| FAQ
|}

{{category header|background-color=#E0E0E0|border-color=lightgray}}
{{category newcolumn|rowspan=1|width=50%|background-color=#F7F7F7|border-color=lightgray}}

== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]

ADD STUFF TO THE MAIN CAMPAIGN

2017-07-27T20:37:43Z

Larian octaaf: Created page with "1"

Change behaviour script code

2017-07-27T20:37:34Z

Larian octaaf: Created page with "1"

Change story code

2017-07-27T20:37:32Z

Larian octaaf: Created page with "1"

Modify scripting

2017-07-27T20:37:30Z

Larian octaaf: Created page with "1"

Change terrain

2017-07-27T20:37:28Z

Larian octaaf: Created page with "1"

Add weapons and armour to the game

2017-07-27T20:37:26Z

Larian octaaf: Created page with "1"

Add decorational items to the game

2017-07-27T20:37:24Z

Larian octaaf: Created page with "1"

Add chests and containers to the game

2017-07-27T20:37:23Z

Larian octaaf: Created page with "1"

Add keys to existing chests

2017-07-27T20:37:20Z

Larian octaaf: Created page with "1"