Difference between revisions of "Data Structure"

From The Official Visionaire Studio: Adventure Game Engine Wiki
 
(11 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
Every field is accessible through scripting, can be read from or written to. However, in practice it does not make sense to edit the majority of them, because the Visionaire Player does not react to all changes (without first reloading the scene) and certain fields are not stored into the savegame files. For this purpose there is a column '''Scriptable''' next to each field, which indicates whether or not the field can be manipulated through code.
 
Every field is accessible through scripting, can be read from or written to. However, in practice it does not make sense to edit the majority of them, because the Visionaire Player does not react to all changes (without first reloading the scene) and certain fields are not stored into the savegame files. For this purpose there is a column '''Scriptable''' next to each field, which indicates whether or not the field can be manipulated through code.
 +
 +
<span class="red">Please note that the information on whether a field is scriptable may not be 100% accurate. If it is marked as scriptable, it usually is. If it is marked as not scriptable, it may be nonetheless though. Feel free to try things out.</span>
  
 
The tables starting with '''Active''' contain dynamically created objects. For example all actions are stored in the "Actions" table but once an action gets executed an object in "ActiveActions" will be created where the currently active action is stored.
 
The tables starting with '''Active''' contain dynamically created objects. For example all actions are stored in the "Actions" table but once an action gets executed an object in "ActiveActions" will be created where the currently active action is stored.
  
You may have noticed some of these <span class="tip-t" title="hello I'm a naughty little tooltip">[?]</span> symbols floating around here & there on this page. They represent information. To access said information, you just need to hover your mouse cursor over the symbol. - <small>''very informative, no?''</small>
+
 
 +
'''For information on the field types and on how to access the data structure through scripting, please refer to the [[Scripting|basic scripting page]].'''
  
  
Line 223: Line 226:
 
|-
 
|-
 
| SavedObject
 
| SavedObject
| t_link to [[#Characters|Characters]] or [[#Objects|Objects]] or [[#Buttons|Buttons]]
+
| t_link to [[#Actions|Actions]]
| Object which is currently saved to execute an action on (usually through the "Save object" action part).
+
| Link to the original action object.
 
| 625
 
| 625
 
| class="cent" | <div class="cross"></div>  
 
| class="cent" | <div class="cross"></div>  
Line 329: Line 332:
 
|-
 
|-
 
| SavedObject
 
| SavedObject
| t_link to [[#Characters|Characters]] or [[#Objects|Objects]] or [[#Buttons|Buttons]]
+
| t_link to [[#Animations|Animations]]
| Object which is currently saved to execute an action on (usually through the "Save object" action part).
+
| Link to the original animation object.
 
| 626
 
| 626
 
| class="cent" | <div class="cross"></div>  
 
| class="cent" | <div class="cross"></div>  
Line 441: Line 444:
 
|-
 
|-
 
| SavedObject
 
| SavedObject
| t_link to [[#Characters|Characters]] or [[#Objects|Objects]] or [[#Buttons|Buttons]]
+
| t_link to [[#Texts|Texts]]
| Object which is currently saved to execute an action on (usually through the "Save object" action part).
+
| Link to the original text object.
 
| 624
 
| 624
 
| class="cent" | <div class="cross"></div>  
 
| class="cent" | <div class="cross"></div>  
Line 694: Line 697:
  
  
== Buttons ==
+
== AudioBusses ==
Table id: 2 <small>(eButtons)</small>
+
Table id: 37 <small>(eAudioBusses)</small>
 
{| class="ts sortable"
 
{| class="ts sortable"
 
|-
 
|-
Line 705: Line 708:
 
! style="width:5%" class="unsortable" | Storage
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| Actions
+
| Events
| t_links to [[#Actions|Actions]] (parent)
+
| t_links to [[#Events|Events]]
| All actions of this button.
+
|  
| 455
+
| 837
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ActiveSprite
+
| LinkedObjects
| t_link to [[#Sprites|Sprites]] (parent)
+
| t_links to [[#Objects|Objects]]
| Sprite which is shown if the button is active. If "Type" is 3 or 6 (command) and this button is currently selected then the button is active. If "Type" is 1 or 2 (scroll arrow) and it is possible to scroll the items then the button is also active. In all other situations the button is inactive (also see "InactiveSprite").
+
|  
| 342
+
| 881
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Animation
+
| Links
| t_link to [[#Animations|Animations]]
+
| t_links
| Animation which will be played automatically if the button is shown (see "Condition").
+
|  
| 545
+
| 830
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Animations
+
| OutputBus
| t_links to [[#Animations|Animations]] (parent)
+
| t_link to [[#AudioBusses|AudioBusses]]
| All animations of the button.
+
|  
| 546
+
| 850
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| CommandType
+
| Setings
| t_int
+
| t_string
| Only used if the button is a command ("Type" = 3 or 6). Defines the type of this command. Possible values:
+
|
* 0 (eButtonNormal): normal command (e.&nbsp;g. "Look at", "Push").
+
| 831
* 1 (eButtonCombined): combined command (e.&nbsp;g. "Use", "Give").
+
| class="cent" | <div class="cross"></div>
* 2 (eButtonGive): give command (e.&nbsp;g. "Give").
+
| class="cent" | V
| 612
+
|-
 +
| Type
 +
| t_int
 +
|
 +
| 829
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Condition
+
| Values
| t_link to [[#Conditions|Conditions]]
+
| t_links to [[#Values|Values]]
| If not empty then the button is only shown and detected by the cursor if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the button is active.
+
|  
| 543
+
| 837
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Blocks ==
 +
Table id: 41 <small>(eBlocks)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| ConditionNegate
+
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Active
 
| t_bool
 
| t_bool
| If true then the condition linked under "Condition" is negated.
+
|  
| 544
+
| 878
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Conjunction
+
| Config
| t_link to [[#Texts|Texts]]
+
| t_string
| The conjunction word for the action text (e.&nbsp;g. "with" in action text "Use item with&nbsp;..."). Only used if the button is a combined command ("Type" = 3 or 6 and "CommandType" = 1 or 2).
+
|  
| 296
+
| 874
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Cursor
+
| Links
| t_link to [[#Cursors|Cursors]]
+
| t_links
| Only used if button is a command ("Type" = 3 or 6). The cursor which is shown if the command is active.
+
|  
| 229
+
| 873
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Draggable
+
| Position
| t_bool
+
| t_point
| If true then items can be dragged (the item is shown instead of the cursor and can be dropped on any object) with this command (only if "Game >DraggableItems" is true and "Type" of this button is 3).
+
|  
| 567
+
| 876
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Group
+
| Type
| t_links to [[#Buttons|Buttons]]
+
| t_int
| List of commands ("Type" of the linked buttons must be 3 or 6) which are used for the button group. With a button group it is possible to define an action for a various number of commands (all commands which are linked by this button).
+
|  
| 584
+
| 889
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| InactiveSprite
+
| TypeName
| t_link to [[#Sprites|Sprites]] (parent)
+
| t_string
| Sprite which is shown if the button is inactive (also see "ActiveSprite").
+
|  
| 343
+
| 875
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== BlockContainers ==
 +
Table id: 40 <small>(eBlockContainers)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| MatrixId
+
| Blocks
| t_int
+
| t_links to [[#Blocks|Blocks]]
 
|  
 
|  
| 800
+
| 870
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| Name
 
| t_link to [[#Texts|Texts]]
 
| Only used if button is a command ("Type" = 3 or 6). The name of the command which is shown in the action text.
 
| 295
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Buttons ==
 +
Table id: 2 <small>(eButtons)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| Polygon
+
! style="width:15%" | Field
| t_vpoint
+
! style="width:15%" class="unsortable" | Type
| Polygon which defines the border of the button. The button is detected if the cursor is inside the polygon.
+
! class="unsortable" | Description
| 454
+
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Actions
 +
| t_links to [[#Actions|Actions]] (parent)
 +
| All actions of this button.
 +
| 455
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Rotation
+
| ActiveSprite
| t_float
+
| t_link to [[#Sprites|Sprites]] (parent)
| Defines the rotation in degrees.
+
| Sprite which is shown if the button is active. If "Type" is 3 or 6 (command) and this button is currently selected then the button is active. If "Type" is 1 or 2 (scroll arrow) and it is possible to scroll the items then the button is also active. In all other situations the button is inactive (also see "InactiveSprite").
| 796
+
| 342
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| RotationCenter
+
| Animation
| t_point
+
| t_link to [[#Animations|Animations]]
| Defines the center point of rotation.
+
| Animation which will be played automatically if the button is shown (see "Condition").
| 797
+
| 545
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| Scale
+
| Animations
| t_float
+
| t_links to [[#Animations|Animations]] (parent)
| Factor for scaling of the button (100 is original size).
+
| All animations of the button.
| 799
+
| 546
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| ScaleX
+
| CommandType
| t_float
+
| t_int
| Factor for horizontal scaling of the button (100 is original width).
+
| Only used if the button is a command ("Type" = 3 or 6). Defines the type of this command. Possible values:
| 814
+
* 0 (eButtonNormal): normal command (e.&nbsp;g. "Look at", "Push").
| class="cent" | <div class="tick"></div>
+
* 1 (eButtonCombined): combined command (e.&nbsp;g. "Use", "Give").
| class="cent" | S
+
* 2 (eButtonGive): give command (e.&nbsp;g. "Give").
 +
| 612
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| ScaleY
+
| Condition
| t_float
+
| t_link to [[#Conditions|Conditions]]
| Factor for vertical scaling of the button (100 is original height).
+
| If not empty then the button is only shown and detected by the cursor if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the button is active.
| 815
+
| 543
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| ShaderSet
+
| ConditionNegate
| t_int
+
| t_bool
| Sets shader configuration id for a button and all of its animations, see "shaderSetOptions()" command.
+
| If true then the condition linked under "Condition" is negated.
| 798
+
| 544
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| Type
 
| t_int
 
| Defines the type of this button. Possible values:
 
* 0 (eButtonPlaceholder): Placeholder for an item.
 
* 1 (eButtonScrollUp): Scroll arrow to scroll items up (number of items to scroll is defined by "Interface > ScollStepSize").
 
* 2 (eButtonScrollDown): Scroll arrow to scroll items down (number of items to scroll is defined by "Interface > ScollStepSize").
 
* 3 (eButtonCommand): Command.
 
* 4 (eButtonActionArea): Action area (only used to define individual actions for an area).
 
* 5 (eButtonCommandGroup): Command group (buttons in the group defined by "Group").
 
* 6 (eButtonCommandInGroup): Command in a command group (group defined by "Group"). This is basically the same as a command (3) with the only difference that this command cannot be selected for actions (because it is only selected through its group).
 
| 297
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Use
+
| Conjunction
| t_int
+
| t_link to [[#Texts|Texts]]
| Only used if button is a command ("Type" = 3 or 6). Defines on what the command can be used on. Possible values:
+
| The conjunction word for the action text (e.&nbsp;g. "with" in action text "Use item with&nbsp;..."). Only used if the button is a combined command ("Type" = 3 or 6 and "CommandType" = 1 or 2).
* 0 (eUseOnAll): on objects (scene objects and items) and characters.
+
| 296
* 1 (eUseOnCharacters): only on characters.
 
* 2 (eUseOnObjects): only on objects (scene objects and items).
 
| 336
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| UseOnCurrentCharacter
+
| Cursor
| t_bool
+
| t_link to [[#Cursors|Cursors]]
| Only used if button is a command ("Type" = 3 or 6) and "Use" is 1 or 2. If false the command can be used on all characters except the current character. If true the command can also be used on the current character.
+
| Only used if button is a command ("Type" = 3 or 6). The cursor which is shown if the command is active.
| 613
+
| 229
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Value
+
| Draggable
| t_link to [[#Values|Values]]
+
| t_bool
| If not empty then the button is only shown and detected by the cursor if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the button is active.
+
| If true then items can be dragged (the item is shown instead of the cursor and can be dropped on any object) with this command (only if "Game >DraggableItems" is true and "Type" of this button is 3).
| 882
+
| 567
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ValueInt
+
| Group
| t_int
+
| t_links to [[#Buttons|Buttons]]
| Integer value for querying the value linked under "Value".
+
| List of commands ("Type" of the linked buttons must be 3 or 6) which are used for the button group. With a button group it is possible to define an action for a various number of commands (all commands which are linked by this button).
| 884
+
| 584
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ValueOperator
+
| InactiveSprite
| t_int
+
| t_link to [[#Sprites|Sprites]] (parent)
| Operator for querying the value linked under "Value". Possible values:
+
| Sprite which is shown if the button is inactive (also see "ActiveSprite").
* 0: equals (=)
+
| 343
* 1: doesn't equal (!=)
 
* 2: equal or greater than (>=)
 
* 3: greater than (>)
 
* 4: equal or less than (<=)
 
* 5: less than (<)
 
| 883
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Visibility
+
| MatrixId
 
| t_int
 
| t_int
| Visibility of the button in percent. Must be between 0 and 100. A value of 0 means the object is not visible at all (but is still recognized by the cursor).
+
|  
| 888
+
| 800
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|}
 
 
 
== Characters ==
 
Table id: 0 <small>(eCharacters)</small>
 
{| class="ts sortable"
 
 
|-
 
|-
! style="width:15%" | Field
+
| Name
! style="width:15%" class="unsortable" | Type
+
| t_link to [[#Texts|Texts]]
! class="unsortable" | Description
+
| Only used if button is a command ("Type" = 3 or 6). The name of the command which is shown in the action text.
! style="width:3%" | id
+
| 295
! style="width:5%" class="unsortable" | Scriptable
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
| ActionCharacter
 
| t_link to [[#Characters|Characters]]
 
|  
 
| 505
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Offset
 +
| t_point
 +
| Offset for this button from its initial position. By changing the offset it is possible to move the button on the interface. The button image and all button animations will take the offset into account. Detecting a button ("Polygon") by the cursor also considers the offset.
 +
| 916
 +
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| Actions <span class="tip-r" title='Characters["Tom"].Actions'>[?]</span>
+
| Polygon
| t_links to [[#Actions|Actions]] (parent)
+
| t_vpoint
| All actions of the character.
+
| Polygon which defines the border of the button. The button is detected if the cursor is inside the polygon.
| 280
+
| 454
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ActionDestPosition <span class="tip-r" title='getObject("Characters[Tom]"):getPoint(VCharacterActionDestPosition)'>[?]</span>
+
| Rotation
| t_point
+
| t_float
| If this position is set and an action is executed on this character then the current character walks to this position (instead of directly to the character) to execute the action.  
+
| Defines the rotation in degrees.
| 734
+
| 796
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
 +
|-
 +
| RotationCenter
 +
| t_point
 +
| Defines the center point of rotation.
 +
| 797
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| Active <span class="tip-r" title='getObject("Characters[Tom]"):getBool(VCharacterActive)'>[?]</span>
+
| Scale
| t_bool
+
| t_float
| If true (default) the character is shown and detected by the cursor.
+
| Factor for scaling of the button (100 is original size).
| 502
+
| 799
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-  
+
|-
| ActiveCommand <span class="tooltip" title='getObject("Characters[Tom]"):getLink(VCharacterActiveCommand)'>[?]</span>
+
| ScaleX
| t_link to [[#Buttons|Buttons]]
+
| t_float
| Currently active command for this character. The button must have "Type" = 3.
+
| Factor for horizontal scaling of the button (100 is original width).
| 517
+
| 814
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| ActiveDialogFont
+
| ScaleY
| t_link to [[#Fonts|Fonts]]
+
| t_float
| Font which is used for a currently selected dialog part.
+
| Factor for vertical scaling of the button (100 is original height).
| 457
+
| 815
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| AnimIndex <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterAnimIndex)'>[?]</span>
 
| t_int
 
| Index for character animations. If there is more than one animation for a direction (e.&nbsp;g. two talk animations for direction 90°) this value decides which animation is used. The index starts with 0 (default, use first animation).
 
| 564
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| AnimState <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterAnimState)'>[?]</span>
+
| ShaderSet
 
| t_int
 
| t_int
| Type of currently playing character animation. Possible values:
+
| Sets shader configuration id for a button and all of its animations, see "shaderSetOptions()" command.
* 0 (eNoAnim): No animation.
+
| 798
* 1 (eWalkAnim): Walk animation.
+
| class="cent" | <div class="tick"></div>
* 2 (eTalkAnim): Talk animation.
 
* 3 (eStandingAnim): Standing animation.
 
* 4 (eCharacterAnim): Character animations.
 
* 5 (eRandomAnim): Random animations.
 
| 508
 
| class="cent" | <div class="cross"></div>
 
 
| class="cent" | S
 
| class="cent" | S
|-  
+
|-
| AudioBus
+
| Type
| t_link to [[#AudioBusses|AudioBusses]]
+
| t_int
|
+
| Defines the type of this button. Possible values:
| 855
+
* 0 (eButtonPlaceholder): Placeholder for an item.
 +
* 1 (eButtonScrollUp): Scroll arrow to scroll items up (number of items to scroll is defined by "Interface > ScollStepSize").
 +
* 2 (eButtonScrollDown): Scroll arrow to scroll items down (number of items to scroll is defined by "Interface > ScollStepSize").
 +
* 3 (eButtonCommand): Command.
 +
* 4 (eButtonActionArea): Action area (only used to define individual actions for an area).
 +
* 5 (eButtonCommandGroup): Command group (buttons in the group defined by "Group").
 +
* 6 (eButtonCommandInGroup): Command in a command group (group defined by "Group"). This is basically the same as a command (3) with the only difference that this command cannot be selected for actions (because it is only selected through its group).
 +
| 297
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| CommentSets
+
| Use
| t_links to [[#CommentSets|CommentSets]] (parent)
+
| t_int
| All comment sets of the character.
+
| Only used if button is a command ("Type" = 3 or 6). Defines on what the command can be used on. Possible values:
| 282
+
* 0 (eUseOnAll): on objects (scene objects and items) and characters.
 +
* 1 (eUseOnCharacters): only on characters.
 +
* 2 (eUseOnObjects): only on objects (scene objects and items).
 +
| 336
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Conditions <span class="tip-r" title='getObject("Characters[Tom]"):getLinks(VCharacterConditions)'>[?]</span>
+
| UseOnCurrentCharacter
| t_links to [[#Conditions|Conditions]]
+
| t_bool
| All conditions of the character.
+
| Only used if button is a command ("Type" = 3 or 6) and "Use" is 1 or 2. If false the command can be used on all characters except the current character. If true the command can also be used on the current character.
| 331
+
| 613
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| CurrentCommentSet <span class="tip-r" title='getObject("Characters[Tom]"):getLink(VCharacterCurrentCommentSet)'>[?]</span>
 
| t_link to [[#CommentSets|CommentSets]]
 
| Currently used comment set.
 
| 277
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| CurrentOutfit <span class="tip-r" title='getObject("Characters[Tom]"):getLink(VCharacterCurrentOutfit)'>[?]</span>
 
| t_link to [[#Outfits|Outfits]]
 
| Currently used outfit.
 
| 276
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| Destination <span class="tip-r" title='getObject("Characters[Tom]"):getPoint(VCharacterDestination)'>[?]</span>
 
| t_point
 
| Destination where the character is currently walking to.
 
| 513
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| DestinationObject <span class="tip-r" title='getObject("Characters[Tom]"):getPoint(VCharacterDestinationObject)'>[?]</span>
 
| t_point
 
| Scene object the character is currently walking to. The character will be aligned to the scene object when it is reached and an action is executed (see "Game > DestinationCommand", "Game > DestinationItem" and "Game > DestinationItemPicked").
 
| 515
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| DestVisibility <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterDestVisibility)'>[?]</span>
 
| t_int
 
| The visibility of the character is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the character will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility".
 
| 596
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| DialogActiveScrollDown
+
| Value
| t_sprite
+
| t_link to [[#Values|Values]]
| Active scroll arrow (for scrolling down). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
+
| If not empty then the button is only shown and detected by the cursor if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the button is active.
| 461
+
| 882
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| DialogActiveScrollUp
+
| ValueInt
| t_sprite
+
| t_int
| Active scroll arrow (for scrolling up). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
+
| Integer value for querying the value linked under "Value".
| 459
+
| 884
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| DialogArea
+
| ValueOperator
| t_rect
+
| t_int
| Defines the absolutely positioned rectangle on the screen where the dialog is displayed.
+
| Operator for querying the value linked under "Value". Possible values:
| 458
+
* 0: equals (=)
 +
* 1: doesn't equal (!=)
 +
* 2: equal or greater than (>=)
 +
* 3: greater than (>)
 +
* 4: equal or less than (<=)
 +
* 5: less than (<)
 +
| 883
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| DialogCursor
+
| Visibility
| t_link to [[#Cursors|Cursors]]
+
| t_int
| Cursor which will be displayed if a dialog is currently active.
+
| Visibility of the button in percent. Must be between 0 and 100. A value of 0 means the object is not visible at all (but is still recognized by the cursor).
| 283
+
| 888
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | S
|-
+
|}
| DialogInactiveScrollDown
+
 
| t_sprite
+
 
| Inactive scroll arrow (for scrolling down). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
+
== Characters ==
| 462
+
Table id: 0 <small>(eCharacters)</small>
| class="cent" | <div class="cross"></div>
+
{| class="ts sortable"
| class="cent" | V
 
 
|-
 
|-
| DialogInactiveScrollUp
+
! style="width:15%" | Field
| t_sprite
+
! style="width:15%" class="unsortable" | Type
| Inactive scroll arrow (for scrolling up). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
+
! class="unsortable" | Description
| 460
+
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| ActionCharacter
 +
| t_link to [[#Characters|Characters]]
 +
|
 +
| 505
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| Dialogs
+
| Actions
| t_links to [[#Dialogs|Dialogs]]
+
| t_links to [[#Actions|Actions]] (parent)
| All dialogs which can be spoken with this character.
+
| All actions of the character.
| 278
+
| 280
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| DialogSprite
+
| ActionDestPosition
| t_sprite
+
| t_point
| Sprite which is used as a background for dialogs.
+
| If this position is set and an action is executed on this character then the current character walks to this position (instead of directly to the character) to execute the action.  
| 463
+
| 734
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | V/S
 
|-
 
|-
| DialogVerticalSpace
+
| Active
| t_int
+
| t_bool
| Distance between two dialog part selections (in pixels).
+
| If true (default) the character is shown and detected by the cursor.
| 464
+
| 502
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| Direction <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterDirection)'>[?]</span>
 
| t_int
 
| Direction (in degress from 0 to 360) the character is currently looking at. The animation (or sprite) which best fits the direction is shown (e.&nbsp;g. if there are 4 animations for 0, 90, 180 and 270 degress and "Direction" is set to 80 then the second animation is shown).
 
| 599
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-  
 
|-  
| FollowAction <span class="tip-r" title='getObject("Characters[Tom]"):getLink(VCharacterFollowAction)'>[?]</span>
+
| ActiveCommand
| t_link to [[#Actions|Actions]]
+
| t_link to [[#Buttons|Buttons]]
| Action which is executed if this character is following another character ("FollowCharacter") and the other character is within reach (less pixel than "FollowReachDistance").
+
| Currently active command for this character. The button must have "Type" = 3.
| 506
+
| 517
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-  
+
|-
| FollowCharacter <span class="tip-r" title='getObject("Characters[Tom]"):getLink(VCharacterFollowCharacter)'>[?]</span>
+
| ActiveDialogFont
| t_link to [[#Characters|Characters]]
+
| t_link to [[#Fonts|Fonts]]
| Character which this character is currently following.
+
| Font which is used for a currently hovered dialog part.
| 504
+
| 457
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| ActiveUsedDialogFont
 +
| t_link to [[#Fonts|Fonts]]
 +
| Font which is used for a currently hovered – and previously selected – dialog part.
 +
| 920
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V
 
|-  
 
|-  
| FollowReachDistance <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterFollowReachDistance)'>[?]</span>
+
| AnimIndex
 
| t_int
 
| t_int
| If this character is following another character ("FollowCharacter") this value (in pixels) defines when the other character is within reach (see "FollowAction").
+
| Index for character animations. If there is more than one animation for a direction (e.&nbsp;g. two talk animations for direction 90°) this value decides which animation is used. The index starts with 0 (default, use first animation).
| 507
+
| 564
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| Font
+
| AnimState
| t_link to [[#Fonts|Fonts]]
+
| t_int
| Font which is used for all texts which are spoken by this character.
+
| Type of currently playing character animation. Possible values:
| 275
+
* 0 (eNoAnim): No animation.
 +
* 1 (eWalkAnim): Walk animation.
 +
* 2 (eTalkAnim): Talk animation.
 +
* 3 (eStandingAnim): Standing animation.
 +
* 4 (eCharacterAnim): Character animations.
 +
* 5 (eRandomAnim): Random animations.
 +
| 508
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-  
 
|-  
| HarmonizeWalkAnimations
+
| AudioBus
| t_bool
+
| t_link to [[#AudioBusses|AudioBusses]]
 
|  
 
|  
| 839
+
| 855
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| InactiveDialogFont
+
| CommentSets
| t_link to [[#Fonts|Fonts]]
+
| t_links to [[#CommentSets|CommentSets]] (parent)
| Font which is used for all dialog parts except the selected one (see "ActiveDialogFont").
+
| All comment sets of the character.
| 581
+
| 282
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Interfaces <span class="tip-r" title='getObject("Characters[Tom]"):getLinks(VCharacterInterfaces)'>
+
| Conditions
| t_links to [[#Interfaces|Interfaces]]
+
| t_links to [[#Conditions|Conditions]]
| All interfaces currently used for this character.
+
| All conditions of the character.
| 585
+
| 331
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V/S
+
| class="cent" | V
 
|-  
 
|-  
| Items <span class="tip-r" title='getObject("Characters[Tom]"):getLinks(VCharacterItems)'>
+
| CurrentCommentSet
| t_links to [[#Objects|Objects]]
+
| t_link to [[#CommentSets|CommentSets]]
| All items which are picked up by this character.
+
| Currently used comment set.
| 663
+
| 277
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| CurrentOutfit
 +
| t_link to [[#Outfits|Outfits]]
 +
| Currently used outfit.
 +
| 276
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| Destination
 +
| t_point
 +
| Destination where the character is currently walking to.
 +
| 513
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-
+
|-  
| LightmapActive
+
| DestinationObject
| t_bool
+
| t_point
|  
+
| Scene object the character is currently walking to. The character will be aligned to the scene object when it is reached and an action is executed (see "Game > DestinationCommand", "Game > DestinationItem" and "Game > DestinationItemPicked").
| 801
+
| 515
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-
+
|-  
| MatrixId
+
| DestVisibility
 
| t_int
 
| t_int
|  
+
| The visibility of the character is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the character will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility".
| 793
+
| 596
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| Name
+
| DialogActiveScrollDown
| t_link to [[#Texts|Texts]]
+
| t_sprite
| The name of the character (as shown in the action text).
+
| Active scroll arrow (for scrolling down). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
| 271
+
| 461
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Outfits <span class="tip-r" title='getObject("Characters[Tom]"):getLinks(VCharacterOutfits)'>
+
| DialogActiveScrollUp
| t_links to [[#Outfits|Outfits]] (parent)
+
| t_sprite
| All outfits of the character.
+
| Active scroll arrow (for scrolling up). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
| 281
+
| 459
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-  
+
|-
| Position <span class="tip-r" title='getObject("Characters[Tom]"):getPoint(VCharacterPosition)'>
+
| DialogArea
| t_point
+
| t_rect
| Current position of character (if field is set and character is walking, then it will stop walking).
+
| Defines the absolutely positioned rectangle on the screen where the dialog is displayed.
| 512
+
| 458
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
 
|-
 
| Scale <span class="tip-r" title='getObject("Characters[Tom]"):getBool(VCharacterScale)'>
 
| t_bool
 
| If false the character is not scaled and will always be drawn in the original size.
 
| 456
 
| class="cent" | <div class="tick"></div>
 
 
| class="cent" | V
 
| class="cent" | V
|-
 
| ScaleFactor <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterScale)'>
 
| t_int
 
| Factor in percent the character is scaled with. Must be > 0 (default is 100).
 
| 566
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| Scene <span class="tip-r" title='getObject("Characters[Tom]"):getLink(VCharacterScene)'>
 
| t_link to [[#Scenes|Scenes]]
 
| Scene where the character is currently on.
 
| 503
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| ShaderSet
+
| DialogCursor
| t_int
+
| t_link to [[#Cursors|Cursors]]
| Sets shader configuration id for a character, see "shaderSetOptions()" command.
+
| Cursor which will be displayed if a dialog is currently active.
| 795
+
| 283
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 +
|-
 +
| DialogInactiveScrollDown
 +
| t_sprite
 +
| Inactive scroll arrow (for scrolling down). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
 +
| 462
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| Size <span class="tip-r" title='getObject("Characters[Tom]"):getFloat(VCharacterSize)'>
+
| DialogInactiveScrollUp
| t_float
+
| t_sprite
| Current size of character in percent (100 = original size) taking "Scale", "ScaleFactor" and the current character position on the scene into account.
+
| Inactive scroll arrow (for scrolling up). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea").
| 749
+
| 460
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| StartObject
+
| Dialogs
| t_link to [[#Objects|Objects]]
+
| t_links to [[#Dialogs|Dialogs]]
| Scene object where the character is standing ("Object > Position") at the beginning of the game.
+
| All dialogs which can be spoken with this character.
| 311
+
| 278
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| DialogSprite
 +
| t_sprite
 +
| Sprite which is used as a background for dialogs.
 +
| 463
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| DialogVerticalSpace
 +
| t_int
 +
| Distance between two dialog part selections (in pixels).
 +
| 464
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| State  <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterState)'>
+
| Direction
| t_int
 
| Current state of character (only set to 2 to stop walking, do not set 3). Possible values:
 
* 2: standing.
 
* 3: walking.
 
| 511
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| TimeToDestVisibility <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterTimeToDestVisibility)'>
 
 
| t_int
 
| t_int
| Defines the time (in milliseconds) until the destination visibility ("DestVisibility") is reached. This value is used the next time when "DestVisibility" is set.
+
| Direction (in degress from 0 to 360) the character is currently looking at. The animation (or sprite) which best fits the direction is shown (e.&nbsp;g. if there are 4 animations for 0, 90, 180 and 270 degress and "Direction" is set to 80 then the second animation is shown).
| 597
+
| 599
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-  
 
|-  
| Tint <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterTint)'>
+
| FollowAction
| t_int
+
| t_link to [[#Actions|Actions]]
| Color (in BGR notation) the character will be drawn with. If the most significant byte is not 0 then this color will be ignored (default) and the lightmap (if present) and scene brightness will be used for the tint of the character. Otherwise the three lower bytes are used for the tint the character will be drawn with. The least significant byte specifies red, then green and the third byte specifies blue. E.&nbsp;g. with 0xFF0000 the character would be drawn with a blue light.
+
| Action which is executed if this character is following another character ("FollowCharacter") and the other character is within reach (less pixel than "FollowReachDistance").
| 664
+
| 506
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-
 
| Values <span class="tip-r" title='getObject("Characters[Tom]"):getLinks(VCharacterValues)'>
 
| t_links to [[#Values|Values]]
 
| All values of the character.
 
| 334
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
 
|-  
 
|-  
| Visibility <span class="tip-r" title='getObject("Characters[Tom]"):getInt(VCharacterVisibility)'>
+
| FollowCharacter
| t_int
+
| t_link to [[#Characters|Characters]]
| Visibility of the character in percent. Must be between 0 and 100. A value of 0 means the character is not visible at all (but is still recognized by the cursor).
+
| Character which this character is currently following.
| 595
+
| 504
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-  
 
|-  
| WalkingSound <span class="tip-r" title='getObject("Characters[Tom]"):getPath(VCharacterWalkingSound)'>
+
| FollowReachDistance
| t_path
+
| t_int
| Sound which is played when the character is walking.
+
| If this character is following another character ("FollowCharacter") this value (in pixels) defines when the other character is within reach (see "FollowAction").
| 272
+
| 507
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|}
 
 
 
 
 
== CommentSets ==
 
Table id: 16 <small>(eCommentSets)</small>
 
{| class="ts sortable"
 
 
|-
 
|-
! style="width:15%" | Field
+
| Font
! style="width:15%" class="unsortable" | Type
+
| t_link to [[#Fonts|Fonts]]
! class="unsortable" | Description
+
| Font which is used for all texts which are spoken by this character.
! style="width:3%" | id
+
| 275
! style="width:5%" class="unsortable" | Scriptable
+
| class="cent" | <div class="cross"></div>
! style="width:5%" class="unsortable" | Storage
+
| class="cent" | V
|-
+
|-  
| Entries
+
| HarmonizeWalkAnimations
| t_links to [[#CommentSetEntries|CommentSetEntries]]
+
| t_bool
| All comment set entries of this comment set.
+
|  
| 557
+
| 839
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
 
 
 
== CommentSetEntries ==
 
Table id: 27 <small>(eCommentSetEntries)</small>
 
{| class="ts sortable"
 
 
|-
 
|-
! style="width:15%" | Field
+
| InactiveDialogFont
! style="width:15%" class="unsortable" | Type
+
| t_link to [[#Fonts|Fonts]]
! class="unsortable" | Description
+
| Font which is used for all dialog parts except the one currently hovered (see "ActiveDialogFont").
! style="width:3%" | id
+
| 581
! style="width:5%" class="unsortable" | Scriptable
+
| class="cent" | <div class="tick"></div>
! style="width:5%" class="unsortable" | Storage
+
| class="cent" | V
 
|-
 
|-
| Command
+
| InactiveUsedDialogFont
| t_link to [[#Buttons|Buttons]]
+
| t_link to [[#Fonts|Fonts]]
| If empty this comment set entry is a standard comment set entry (used for all comments). If this link is a command ("Button > Type" must be 3) then this comment set entry will only be shown if a command is shown after an execution of an action with this command failed.
+
| Font which is used for all previously selected dialog parts except the one currently hovered (see "ActiveUsedDialogFont").
| 560
+
| 919
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Text
+
| Interfaces
| t_link to [[#Texts|Texts]]
+
| t_links to [[#Interfaces|Interfaces]]
| Text for this comment.
+
| All interfaces currently used for this character.
| 559
+
| 585
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | V/S
|}
+
|-
 
+
| Items
 
+
| t_links to [[#Objects|Objects]]
== Conditions ==
+
| All items which are picked up by this character.
Table id: 10 <small>(eConditions)</small>
+
| 663
{| class="ts sortable"
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
! style="width:15%" | Field
+
| LightmapActive
! style="width:15%" class="unsortable" | Type
+
| t_bool
! class="unsortable" | Description
+
|  
! style="width:3%" | id
+
| 801
! style="width:5%" class="unsortable" | Scriptable
+
| class="cent" | <div class="tick"></div>
! style="width:5%" class="unsortable" | Storage
+
| class="cent" | S
 
|-
 
|-
| Conditions
+
| MatrixId
| t_links to [[#Conditions|Conditions]]
+
| t_int
| All conditions of a combined condition (only used if "IsVariable" is false).
+
|  
| 844
+
| 793
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| ConditionsNegate
+
| Name
|  
+
| t_link to [[#Texts|Texts]]
| Table of booleans corresponding to the conditions linked in "Conditions". If true the correspoding condition will be negated (only used if "IsVariable" is false).
+
| The name of the character (as shown in the action text).
| 845
+
| 271
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| IsVariable
+
| Outfits
| t_bool
+
| t_links to [[#Outfits|Outfits]] (parent)
| If true this condition only contains true or false. If false this condition is a combined condition (see "Conditions", "ConditionsNegate").
+
| All outfits of the character.
| 193
+
| 281
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|-  
| Operator
+
| Position
| t_int
+
| t_point
| Defines how the conditions of a combined condition (linked in "Conditions") are combined (only used if "IsVariable" is false). Possible values:
+
| Current position of character (if field is set and character is walking, then it will stop walking).
* 0: logical AND.
+
| 512
* 1: logical OR.
+
| class="cent" | <div class="tick"></div>
| 198
+
| class="cent" | S
| class="cent" | <div class="cross"></div>
+
|-  
| class="cent" | V
+
| Scale
|-
 
| ReturnNegate
 
 
| t_bool
 
| t_bool
| If true then the combined result of "Conditions" will be negated (only used if "IsVariable" is false).
+
| If false the character is not scaled and will always be drawn in the original size.
| 195
+
| 456
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| Value
+
| ScaleFactor
| t_bool
+
| t_int
| Current value of the condition (true or false). This is only used if "IsVariable" is true.
+
| Factor in percent the character is scaled with. Must be > 0 (default is 100).
| 194
+
| 566
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
|}
+
|-
 
+
| Scene
 
+
| t_link to [[#Scenes|Scenes]]
== Cursors ==
+
| Scene where the character is currently on.
Table id: 15 <small>(eCursors)</small>
+
| 503
{| class="ts sortable"
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
! style="width:15%" | Field
+
| ShaderSet
! style="width:15%" class="unsortable" | Type
+
| t_int
! class="unsortable" | Description
+
| Sets shader configuration id for a character, see "shaderSetOptions()" command.
! style="width:3%" | id
+
| 795
! style="width:5%" class="unsortable" | Scriptable
+
| class="cent" | <div class="tick"></div>
! style="width:5%" class="unsortable" | Storage
+
| class="cent" | S
 
|-
 
|-
| ActiveAnimation
+
| Size
| t_link to [[#Animations|Animations]]
+
| t_float
| Animation of the active cursor.
+
| Current size of character in percent (100 = original size) taking "Scale", "ScaleFactor" and the current character position on the scene into account.
| 647
+
| 749
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| InactiveAnimation
+
| StartObject
| t_link to [[#Animations|Animations]]
+
| t_link to [[#Objects|Objects]]
| Animation of the inactive cursor.
+
| Scene object where the character is standing ("Object > Position") at the beginning of the game.
| 648
+
| 311
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
+
|-
 
+
| State
 
+
| t_int
== Dialogs ==
+
| Current state of character (only set to 2 to stop walking, do not set 3). Possible values:
Table id: 11 <small>(eDialogs)</small>
+
* 2: standing.
{| class="ts sortable"
+
* 3: walking.
 +
| 511
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| TimeToDestVisibility
 +
| t_int
 +
| Defines the time (in milliseconds) until the destination visibility ("DestVisibility") is reached. This value is used the next time when "DestVisibility" is set.
 +
| 597
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Tint
 +
| t_int
 +
| Color (in BGR notation) the character will be drawn with. If the most significant byte is not 0 then this color will be ignored (default) and the lightmap (if present) and scene brightness will be used for the tint of the character. Otherwise the three lower bytes are used for the tint the character will be drawn with. The least significant byte specifies red, then green and the third byte specifies blue. E.&nbsp;g. with 0xFF0000 the character would be drawn with a blue light.
 +
| 664
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Values
 +
| t_links to [[#Values|Values]]
 +
| All values of the character.
 +
| 334
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Visibility
 +
| t_int
 +
| Visibility of the character in percent. Must be between 0 and 100. A value of 0 means the character is not visible at all (but is still recognized by the cursor).
 +
| 595
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| WalkingSound
 +
| t_path
 +
| Sound which is played when the character is walking.
 +
| 272
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|}
 +
 
 +
 
 +
== CommentSets ==
 +
Table id: 16 <small>(eCommentSets)</small>
 +
{| class="ts sortable"
 
|-
 
|-
 
! style="width:15%" | Field
 
! style="width:15%" | Field
Line 1,442: Line 1,472:
 
! style="width:5%" class="unsortable" | Storage
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| DialogParts
+
| Entries
| t_links to [[#DialogParts|DialogParts]] (parent)
+
| t_links to [[#CommentSetEntries|CommentSetEntries]]
| All dialog part selections of this dialog.
+
| All comment set entries of this comment set.
| 202
+
| 557
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| Character
 
| t_link to [[#Characters|Characters]]
 
|
 
| 825
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
Line 1,458: Line 1,481:
  
  
== DialogParts ==
+
== CommentSetEntries ==
Table id: 12 <small>(eDialogParts)</small>
+
Table id: 27 <small>(eCommentSetEntries)</small>
 
{| class="ts sortable"
 
{| class="ts sortable"
 
|-
 
|-
Line 1,469: Line 1,492:
 
! style="width:5%" class="unsortable" | Storage
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| Action
+
| Command
| t_link to [[#Actions|Actions]] (parent)
+
| t_link to [[#Buttons|Buttons]]
| Action which is executed if this dialog part is selected. It is not allowed to start a dialog in this action.
+
| If empty this comment set entry is a standard comment set entry (used for all comments). If this link is a command ("Button > Type" must be 3) then this comment set entry will only be shown if a command is shown after an execution of an action with this command failed.
| 206
+
| 560
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| AltText
+
| Text
| t_link to [[#Texts|Texts]] (parent)
+
| t_link to [[#Texts|Texts]]
| Text which is spoken by the current character (only used if "UseAltText" is true, otherwise "Text" is spoken).
+
| Text for this comment.
| 465
+
| 559
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Conditions ==
 +
Table id: 10 <small>(eConditions)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| AnswerText
+
! style="width:15%" | Field
| t_link to [[#Texts|Texts]] (parent)
+
! style="width:15%" class="unsortable" | Type
| Text which is spoken by the other character (character where the dialog belongs to) after the text is spoken by the current character.
+
! class="unsortable" | Description
| 286
+
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Conditions
 +
| t_links to [[#Conditions|Conditions]]
 +
| All conditions of a combined condition (only used if "IsVariable" is false).
 +
| 844
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| Available
 
| t_bool
 
| If true then this dialog part is still available (see "Remove").
 
| 317
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| Condition
+
| ConditionsNegate
| t_link to [[#Conditions|Conditions]]
+
|  
| The dialog part selection is only shown if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the dialog part is shown.
+
| Table of booleans corresponding to the conditions linked in "Conditions". If true the correspoding condition will be negated (only used if "IsVariable" is false).
| 204
+
| 845
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ConditionNegate
+
| IsVariable
 
| t_bool
 
| t_bool
| If true then the condition linked under "Condition" is negated.
+
| If true this condition only contains true or false. If false this condition is a combined condition (see "Conditions", "ConditionsNegate").
| 614
+
| 193
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LinkedAction
+
| Operator
| t_link to [[#Actions|Actions]]
+
| t_int
| Action which is executed if this dialog part is selected and the link "Action" is empty. It is not allowed to start a dialog in this action.
+
| Defines how the conditions of a combined condition (linked in "Conditions") are combined (only used if "IsVariable" is false). Possible values:
| 655
+
* 0: logical AND.
 +
* 1: logical OR.
 +
| 198
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| NextDialog
+
| ReturnNegate
| t_link to [[#Dialogs|Dialogs]] (parent)
+
| t_bool
| Dialog which is shown when this dialog part is selected.
+
| If true then the combined result of "Conditions" will be negated (only used if "IsVariable" is false).
| 289
+
| 195
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|-
 +
| Value
 +
| t_bool
 +
| Current value of the condition (true or false). This is only used if "IsVariable" is true.
 +
| 194
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|}
 +
 +
 +
== Cursors ==
 +
Table id: 15 <small>(eCursors)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| Remove
+
| ActiveAnimation
| t_bool
+
| t_link to [[#Animations|Animations]]
| If true then this dialog part can only be selected once ("Available" will be set to false after selection).
+
| Animation of the active cursor.
| 288
+
| 647
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Return
+
| InactiveAnimation
| t_int
+
| t_link to [[#Animations|Animations]]
| Defines which dialog is shown if this dialog part is selected (and the dialog part does not have a dialog with active dialog parts below). Possible values:
+
| Animation of the inactive cursor.
* 0 (eDialogReturnToSame): the same dialog will be shown again.
+
| 648
* 1 (eDialogReturnToUpper): the "upper" dialog (which linked to the current dialog) will be shown.
 
* 2 (eDialogReturnToEnd): no dialog will be shown.
 
| 287
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Curves ==
 +
Table id: 42 <small>(eCurves)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| Text
+
! style="width:15%" | Field
| t_link to [[#Texts|Texts]] (parent)
+
! style="width:15%" class="unsortable" | Type
| Text which is shown as a selection in the dialog. Further it is spoken by the current character if "UseAltText" is false.
+
! class="unsortable" | Description
| 205
+
! style="width:3%" | id
| class="cent" | <div class="cross"></div>
+
! style="width:5%" class="unsortable" | Scriptable
| class="cent" | V
+
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| UseAltText
+
| Points
| t_bool
+
| t_vpoint
| If true then "AltText" will be spoken by the current character, otherwise "Text".
+
|  
| 466
+
| 895
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Value
+
| Type
| t_link to [[#Values|Values]]
+
| t_int
| The dialog part selection is only shown if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the dialog part is shown.
+
|  
| 885
+
| 896
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Dialogs ==
 +
Table id: 11 <small>(eDialogs)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| ValueInt
+
! style="width:15%" | Field
| t_int
+
! style="width:15%" class="unsortable" | Type
| Integer value for querying the value linked under "Value".
+
! class="unsortable" | Description
| 887
+
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| DialogParts
 +
| t_links to [[#DialogParts|DialogParts]] (parent)
 +
| All dialog part selections of this dialog.
 +
| 202
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ValueOperator
+
| Character
| t_int
+
| t_link to [[#Characters|Characters]]
| Operator for querying the value linked under "Value". Possible values:
+
|  
* 0: equals (=)
+
| 825
* 1: doesn't equal (!=)
 
* 2: equal or greater than (>=)
 
* 3: greater than (>)
 
* 4: equal or less than (<=)
 
* 5: less than (<)
 
| 886
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
Line 1,585: Line 1,646:
  
  
== Fonts ==
+
== DialogParts ==
Table id: 3 <small>(eFonts)</small>
+
Table id: 12 <small>(eDialogParts)</small>
 
{| class="ts sortable"
 
{| class="ts sortable"
 
|-
 
|-
Line 1,596: Line 1,657:
 
! style="width:5%" class="unsortable" | Storage
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| Alphabet
+
| Action
| t_string
+
| t_link to [[#Actions|Actions]] (parent)
| A string which contains all characters of the font. The characters have to be in the same order as they appear in the sprite linked in "Sprite" (from left to right and top to bottom). This value is only used for bitmap fonts ("TrueTypeFont" = false).
+
| Action which is executed if this dialog part is selected. It is not allowed to start a dialog in this action.
| 249
+
| 206
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| AltText
 +
| t_link to [[#Texts|Texts]] (parent)
 +
| Text which is spoken by the current character (only used if "UseAltText" is true, otherwise "Text" is spoken).
 +
| 465
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| AutoLineBreak
+
| AnswerText
 +
| t_link to [[#Texts|Texts]] (parent)
 +
| Text which is spoken by the other character (character where the dialog belongs to) after the text is spoken by the current character.
 +
| 286
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Available
 
| t_bool
 
| t_bool
| If true then line breaks will be added to all texts rendered with this font so that the maximum length of a line does not exceed a certain limit. Each line has a maximum width which is defined in "LineWidth".
+
| If true then this dialog part is still available (see "Remove").
| 634
+
| 317
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Condition
 +
| t_link to [[#Conditions|Conditions]]
 +
| The dialog part selection is only shown if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the dialog part is shown.
 +
| 204
 +
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Border
+
| ConditionNegate
 
| t_bool
 
| t_bool
| If true a font border will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true).
+
| If true then the condition linked under "Condition" is negated.
| 774
+
| 614
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| BorderColor
+
| LinkedAction
| t_int
+
| t_link to [[#Actions|Actions]]
| Color for font border. The least significant byte specifies red, then green and the third byte specifies blue (BGR notation). This value is only used for TrueType fonts ("TrueTypeFont" = true) and if "Border" is set to true.
+
| Action which is executed if this dialog part is selected and the link "Action" is empty. It is not allowed to start a dialog in this action.
| 775
+
| 655
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| NextDialog
 +
| t_link to [[#Dialogs|Dialogs]] (parent)
 +
| Dialog which is shown when this dialog part is selected.
 +
| 289
 +
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| BorderSize
+
| Remove
| t_float
+
| t_bool
| Size of font border in pixels. This value is only used for TrueType fonts ("TrueTypeFont" = true) and if "Border" is set to true.
+
| If true then this dialog part can only be selected once ("Available" will be set to false after selection).
| 776
+
| 288
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Color
+
| Return
 
| t_int
 
| t_int
| Font color. The least significant byte specifies red, then green and the third byte specifies blue (BGR notation). This value is only used for TrueType fonts ("TrueTypeFont" = true).
+
| Defines which dialog is shown if this dialog part is selected (and the dialog part does not have a dialog with active dialog parts below). Possible values:
| 773
+
* 0 (eDialogReturnToSame): the same dialog will be shown again.
| class="cent" | <div class="tick"></div>
+
* 1 (eDialogReturnToUpper): the "upper" dialog (which linked to the current dialog) will be shown.
 +
* 2 (eDialogReturnToEnd): no dialog will be shown.
 +
| 287
 +
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Font
+
| Text
| t_link
+
| t_link to [[#Texts|Texts]] (parent)
| Font which will be used as reference. This can be useful to define a new font with own color, size, etc. based on an existing TrueType font ("TrueTypeFont" = true). This can save a lot of resources compared to creating a new TrueType font.
+
| Text which is shown as a selection in the dialog. Further it is spoken by the current character if "UseAltText" is false.
| 770
+
| 205
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Kerning
+
| UseAltText
| t_string
+
| t_bool
| Defines spacings for individual letters or pairs of letters. This value is only used for bitmap fonts ("TrueTypeFont" = false).
+
| If true then "AltText" will be spoken by the current character, otherwise "Text".
| 703
+
| 466
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Letters
+
| Value
| t_vrect
+
| t_link to [[#Values|Values]]
| List of rectangles where each rectangle contains the position of a single character on the sprite linked in "Sprite". This value is only used for bitmap fonts ("TrueTypeFont" = false).
+
| The dialog part selection is only shown if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the dialog part is shown.
| 143
+
| 885
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LetterSpacing
+
| ValueInt
 
| t_int
 
| t_int
| Horizontal distance between two characters (in pixel). This value is only used for bitmap fonts ("TrueTypeFont" = false).
+
| Integer value for querying the value linked under "Value".
| 250
+
| 887
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LineWidth
+
| ValueOperator
 
| t_int
 
| t_int
| Maximum line width (in pixel) for automatic line break. This value is only used if "AutoLineBreak" is true.
+
| Operator for querying the value linked under "Value". Possible values:
| 635
+
* 0: equals (=)
| class="cent" | <div class="tick"></div>
+
* 1: doesn't equal (!=)
 +
* 2: equal or greater than (>=)
 +
* 3: greater than (>)
 +
* 4: equal or less than (<=)
 +
* 5: less than (<)
 +
| 886
 +
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Events ==
 +
Table id: 38 <small>(eEvents)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| Shadow
+
! style="width:15%" | Field
| t_bool
+
! style="width:15%" class="unsortable" | Type
| If true a font shadow will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true).
+
! class="unsortable" | Description
| 777
+
! style="width:3%" | id
| class="cent" | <div class="tick"></div>
+
! style="width:5%" class="unsortable" | Scriptable
| class="cent" | V
+
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| ShadowOffset
+
| Action
| t_point
+
| t_link
| Offset in pixels for font shadow (see "Shadow").
+
|  
| 778
+
| 864
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Size
+
| StartBus
| t_float
+
| t_link to [[#AudioBusses|AudioBusses]]
| Font size in pixels. This value is only used for TrueType fonts ("TrueTypeFont" = true).
+
|  
| 772
+
| 865
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SpaceWidth
+
| StopBus
| t_int
+
| t_link to [[#AudioBusses|AudioBusses]]
| Width of space (in pixels). This value is only used for bitmap fonts ("TrueTypeFont" = false).
+
|  
| 623
+
| 866
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
|-
 
| Sprite
 
| t_sprite
 
| Sprite with all characters of the font. This value is only used for bitmap fonts ("TrueTypeFont" = false).
 
| 248
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
 
|-
 
| TrueTypeFont
 
| t_bool
 
| If set to true this is a TrueType font. Either "TrueTypeFontPath" or "Font" must be set for a valid font.
 
| 769
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
|-
 
| TrueTypeFontPath
 
| t_path
 
| Path to TrueType font file. This value is only used for TrueType fonts ("TrueTypeFont" = true).
 
| 771
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
|-
 
| VerticalLetterSpacing
 
| t_int
 
| Vertical distance between two characters (in pixel).
 
| 540
 
| class="cent" | <div class="tick"></div>
 
 
| class="cent" | V
 
| class="cent" | V
 
|}
 
|}
  
  
== Game ==
+
== Fonts ==
Table id: -1 <small>(eGame)</small>
+
Table id: 3 <small>(eFonts)</small>
 
{| class="ts sortable"
 
{| class="ts sortable"
 
|-
 
|-
Line 1,742: Line 1,818:
 
! style="width:5%" class="unsortable" | Storage
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| About
+
| Alphabet
 
| t_string
 
| t_string
| Long description of game, authors can make additional comments here.
+
| A string which contains all characters of the font. The characters have to be in the same order as they appear in the sprite linked in "Sprite" (from left to right and top to bottom). This value is only used for bitmap fonts ("TrueTypeFont" = false).
| 125
+
| 249
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Actions
+
| AutoLineBreak
| t_links to [[#Actions|Actions]] (parent)
+
| t_bool
| All actions which can be started with a key. The key value is stored in "Action > ExecutionType".
+
| If true then line breaks will be added to all texts rendered with this font so that the maximum length of a line does not exceed a certain limit. Each line has a maximum width which is defined in "LineWidth".
| 318
+
| 634
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ActionTextFont
+
| Border
| t_link to [[#Fonts|Fonts]]
+
| t_bool
| Font which will be used for the action text (only used if "DrawActionText" is 1 or 2).
+
| If true a font border will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true).
| 589
+
| 774
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | V
 
|-
 
|-
| ActionTextRect
+
| BorderColor
| t_rect
+
| t_int
| Rectangle in which the action text will be drawn horizontally and vertically centered (only used if "DrawActionText" is 2).
+
| Color for font border. The least significant byte specifies red, then green and the third byte specifies blue (BGR notation). This value is only used for TrueType fonts ("TrueTypeFont" = true) and if "Border" is set to true.
| 590
+
| 775
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| ActiveCommand
 
| t_link to [[#Buttons|Buttons]]
 
| The currently active command.
 
| 610
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| AlignCharacterOnImExecution
+
| BorderSize
| t_bool
+
| t_float
| If true the active character will be automatically aligned to the clicked object when an action with an "immediate" execution type is executed.
+
| Size of font border in pixels. This value is only used for TrueType fonts ("TrueTypeFont" = true) and if "Border" is set to true.
| 582
+
| 776
| class="cent" | <div class="cross"></div>
 
| class="cent" | V/S
 
|-
 
| AlwaysAllowSkipText
 
| t_bool
 
| If true the active text can always be skipped with the left mouse button (even when the cursor is disabled or a cutscene is running).
 
| 565
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | V
 
|-
 
|-
| AudioContainerLinks
+
| Color
| t_links to [[#AudioBusses|AudioBusses]]
+
| t_int
|  
+
| Font color. The least significant byte specifies red, then green and the third byte specifies blue (BGR notation). This value is only used for TrueType fonts ("TrueTypeFont" = true).
| 835
+
| 773
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| AudioMixLinks
+
| Font
| t_links to [[#AudioBusses|AudioBusses]]
+
| t_link
|  
+
| Font which will be used as reference. This can be useful to define a new font with own color, size, etc. based on an existing TrueType font ("TrueTypeFont" = true). This can save a lot of resources compared to creating a new TrueType font.
| 834
+
| 770
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| AutoHideInterfacesInMenu
 
| t_bool
 
| If true all interfaces are hidden if the current scene is a menu. If it is necessary to display an interface on a menu then this option must be set to false and the interfaces must be hidden manually when necessary.
 
| 628
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| Behaviours
+
| Kerning
| t_links
+
| t_string
|
+
| Defines spacings for individual letters or pairs of letters. This value is only used for bitmap fonts ("TrueTypeFont" = false).
| 890
+
| 703
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| BlockContainers
+
| Letters
| t_links
+
| t_vrect
|  
+
| List of rectangles where each rectangle contains the position of a single character on the sprite linked in "Sprite". This value is only used for bitmap fonts ("TrueTypeFont" = false).
| 877
+
| 143
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| BuildOptions
+
| LetterSpacing
| t_string
+
| t_int
|  
+
| Horizontal distance between two characters (in pixel). This value is only used for bitmap fonts ("TrueTypeFont" = false).
| 819
+
| 250
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| BuildRules
+
| LineWidth
| t_vstring
+
| t_int
|  
+
| Maximum line width (in pixel) for automatic line break. This value is only used if "AutoLineBreak" is true.
| 804
+
| 635
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| CharacterComposedFile
+
| Shadow
| t_path
+
| t_bool
| Defines the filename for composing the character when compiling the game.
+
| If true a font shadow will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true).
| 620
+
| 777
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| ShadowOffset
 +
| t_point
 +
| Offset in pixels for font shadow (see "Shadow").
 +
| 778
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| Size
 +
| t_float
 +
| Font size in pixels. This value is only used for TrueType fonts ("TrueTypeFont" = true).
 +
| 772
 +
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| CharacterComposedFiles
+
| SpaceWidth
 
| t_int
 
| t_int
| The number of composed character files. Possible values:
+
| Width of space (in pixels). This value is only used for bitmap fonts ("TrueTypeFont" = false).
* 0 (eMainContainer): All characters are stored in the main container.
+
| 623
* 1 (eSingleContainer): All characters are stored in one file specified by "CharacterComposedFile".
+
| class="cent" | <div class="tick"></div>
* 2 (eMultipleContainers): Each character is stored in an own container specified by "CharacterComposedFile" (filename extended by the character number).
 
| 619
 
| class="cent" | <div class="cross"></div>
 
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| CharacterLinks
+
| Sprite
| t_links to [[#Characters|Characters]] (parent)
+
| t_sprite
| All characters of the game.
+
| Sprite with all characters of the font. This value is only used for bitmap fonts ("TrueTypeFont" = false).
| 118
+
| 248
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-  
+
|-
| CommandBehaviour
+
| TrueTypeFont
| t_int
+
| t_bool
| Behavior for selecting the standard command. Possible values:
+
| If set to true this is a TrueType font. Either "TrueTypeFontPath" or "Font" must be set for a valid font.
* 0 (eStdCommandAlways): set standard command after executing an action.
+
| 769
* 1 (eSetStdCommandNever): never set standard command.
 
* 2 (eSetStdCommandOnSuccess): set standard command after successful execution of an action.
 
| 244
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
 
|-
 
| CompanyName
 
| t_string
 
| The company name is used for the path where game log files and savegames are stored. E.&nbsp;g. on an English Windows the path could look like this: <code>C:\Users\USERNAME\AppData\Local\COMPANY_NAME\GAME_NAME</code>.
 
| 700
 
| class="cent" | <div class="cross"></div>
 
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ComposedFile
+
| TrueTypeFontPath
 
| t_path
 
| t_path
| Defines the filename for composing the main output file (.vis file) when compiling the game.
+
| Path to TrueType font file. This value is only used for TrueType fonts ("TrueTypeFont" = true).
| 616
+
| 771
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Containers
+
| VerticalLetterSpacing
| t_vstring
+
| t_int
|  
+
| Vertical distance between two characters (in pixel).
| 803
+
| 540
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
|-  
+
|}
| CurrentCharacter
+
 
| t_link to [[#Characters|Characters]]
+
 
| Character which is currently controlled by the player (active character).
+
== game ==
| 468
+
Table id: -1 <small>(eGame)</small>
| class="cent" | <div class="tick"></div>
+
{| class="ts sortable"
| class="cent" | S
+
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| CurrentObject
+
| About
| t_link to [[#Objects|Objects]] or [[#Characters|Characters]] or [[#Buttons|Buttons]]
+
| t_string
| The object currently below the cursor.
+
| Long description of game, authors can make additional comments here.
| 687
+
| 125
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
|-
 
| CurrentScene
 
| t_link to [[#Scenes|Scenes]]
 
| Scene which is currently shown.
 
| 469
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| CurrentText
 
| t_link to [[#ActiveTexts|ActiveTexts]]
 
| Text which is currently displayed.
 
| 477
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| Cursor
+
| Actions
| t_link to [[#Cursors|Cursors]]
+
| t_links to [[#Actions|Actions]] (parent)
|  
+
| All actions which can be started with a key. The key value is stored in "Action > ExecutionType".
| 856
+
| 318
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| CursorHorizontalScrollDistance
 
| t_int
 
| Distance of cursor to the left or right screen border where horizontal scrolling will be started.
 
| 689
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| CursorVerticalScrollDistance
 
| t_int
 
| Distance of cursor to the top or bottom screen border where vertical scrolling will be started.
 
| 690
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| Cursors
 
| t_links to [[#Cursors|Cursors]] (parent)
 
| All cursors of the game.
 
| 215
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| CustomActionParts
+
| ActionTextFont
| t_vstring
+
| t_link to [[#Fonts|Fonts]]
| All custom action parts from installed action part plugins.
+
| Font which will be used for the action text (only used if "DrawActionText" is 1 or 2).
| 857
+
| 589
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | V/S
 
|-
 
|-
| CutsceneAction
+
| ActionTextRect
| t_link to [[#Actions|Actions]]
+
| t_rect
| If a cutscene is active this links to the action which started (and should stop) the cutscene.
+
| Rectangle in which the action text will be drawn horizontally and vertically centered (only used if "DrawActionText" is 2).
| 633
+
| 590
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
|-
+
|-  
| DefaultMusicBus
+
| ActiveCommand
| t_link to [[#AudioBusses|AudioBusses]]
+
| t_link to [[#Buttons|Buttons]]
|  
+
| The currently active command.
| 854
+
| 610
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
 
|-
 
|-
| DefaultSoundBus
+
| AlignCharacterOnImExecution
| t_link to [[#AudioBusses|AudioBusses]]
+
| t_bool
|  
+
| If true the active character will be automatically aligned to the clicked object when an action with an "immediate" execution type is executed.
| 852
+
| 582
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V/S
 +
|-
 +
| AlwaysAllowSkipText
 +
| t_bool
 +
| If true the active text can always be skipped with the left mouse button (even when the cursor is disabled or a cutscene is running).
 +
| 565
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
 
|-
 
|-
| DefaultSpeechBus
+
| AudioContainerLinks
| t_link to [[#AudioBusses|AudioBusses]]
+
| t_links to [[#AudioBusses|AudioBusses]]
 
|  
 
|  
| 851
+
| 835
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| Description
+
| AudioMixLinks
| t_string
+
| t_links to [[#AudioBusses|AudioBusses]]
| Short description of the game.
+
|  
| 124
+
| 834
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| DestinationCommand
+
| AutoHideInterfacesInMenu
| t_link to [[#Buttons|Buttons]]
+
| t_bool
| When the user clicked on an object and the character walks to this object, this command will be executed when the object is reached.
+
| If true all interfaces are hidden if the current scene is a menu. If it is necessary to display an interface on a menu then this option must be set to false and the interfaces must be hidden manually when necessary.
| 483
+
| 628
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
|-
+
|-
| DestinationEvent
+
| Behaviours
| t_int
+
| t_links
| When the user clicked on an object and the character walks to this object, this event will be executed when the object is reached. Possible values:
+
|
* 0: no event.
+
| 890
* 1: left mousebutton click.
+
| class="cent" | <div class="cross"></div>
* 2: right mousebutton click.
+
| class="cent" | V
* 3: left mousebutton double click.
+
|-
* 4: left mousebutton hold.
+
| BlockContainers
* 5: mouse enters area.
+
| t_links
* 6: mouse leaves area.
+
|  
| 615
+
| 877
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
|-  
 
| DestinationItem
 
| t_link to [[#Objects|Objects]]
 
| When the user clicked on an object and the character walks to this object, this item will be used on the object when it is reached.
 
| 484
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-  
 
| DestinationItemPicked
 
| t_bool
 
| When the user clicked on an object and the character walks to this object, this will be set to true in case an item was picked up (see "DraggableObjects"). Then the item in "DestinationItem" will be dropped on the object when it is reached.
 
| 485
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| Dialog
+
| BuildOptions
| t_link to [[#Dialogs|Dialogs]]
+
| t_string
| Currently displayed dialog.
+
|  
| 476
+
| 819
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| DialogAction
+
| BuildRules
| t_link to [[#Actions|Actions]]
+
| t_vstring
| Running action which contains the text for the current dialog.
+
|  
| 481
+
| 804
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 +
|-
 +
| CharacterComposedFile
 +
| t_path
 +
| Defines the filename for composing the character when compiling the game.
 +
| 620
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| DisableInteractionDuringAnim
+
| CharacterComposedFiles
 
| t_int
 
| t_int
|  
+
| The number of composed character files. Possible values:
| 643
+
* 0 (eMainContainer): All characters are stored in the main container.
 +
* 1 (eSingleContainer): All characters are stored in one file specified by "CharacterComposedFile".
 +
* 2 (eMultipleContainers): Each character is stored in an own container specified by "CharacterComposedFile" (filename extended by the character number).
 +
| 619
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| CharacterLinks
 +
| t_links to [[#Characters|Characters]] (parent)
 +
| All characters of the game.
 +
| 118
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| DraggableItems
+
| CommandBehaviour
| t_bool
+
| t_int
| True if objects can be dragged from the interface.
+
| Behavior for selecting the standard command. Possible values:
| 305
+
* 0 (eStdCommandAlways): set standard command after executing an action.
 +
* 1 (eSetStdCommandNever): never set standard command.
 +
* 2 (eSetStdCommandOnSuccess): set standard command after successful execution of an action.
 +
| 244
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
|-  
+
|-
| DrawActionText
+
| CompanyName
| t_int
+
| t_string
| Defines if and where the action text is drawn. Possible values:
+
| The company name is used for the path where game log files and savegames are stored. E.&nbsp;g. on an English Windows the path could look like this: <code>C:\Users\USERNAME\AppData\Local\COMPANY_NAME\GAME_NAME</code>.
* 0 (eDrawNoActionText): do not draw action text.
+
| 700
* 1 (eDrawActionTextAtCurrentPos): draw action text at current cursor position.
+
| class="cent" | <div class="cross"></div>
* 2 (eDrawActionTextAtRect): draw action text centered in the rectangle defined by GameActionTextRect.
+
| class="cent" | V
| 588
+
|-
| class="cent" | <div class="tick"></div>
+
| ComposedFile
| class="cent" | V/S
+
| t_path
|-  
+
| Defines the filename for composing the main output file (.vis file) when compiling the game.
| ExecuteActionsDuringDialog
+
| 616
| t_bool
+
| class="cent" | <div class="cross"></div>
| If true the key actions (defined in "Actions") will also be executed if a dialog is currently displayed.
+
| class="cent" | V
| 578
+
|-
| class="cent" | <div class="tick"></div>
+
| Containers
| class="cent" | V/S
+
| t_vstring
|-  
 
| ExecuteCalledActionImmediately
 
| t_bool
 
 
|  
 
|  
| 790
+
| 803
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| FadeDelay
+
| CurrentCharacter
| t_int
+
| t_link to [[#Characters|Characters]]
| Delay for fade in/out of a scene in milliseconds.
+
| Character which is currently controlled by the player (active character).
| 234
+
| 468
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-
 
| FadeEffect
 
| t_int
 
| Effect for fade in/out of a scene. Possible values:
 
* 0 (eFadeNo): no effect, display new scene immediately.
 
* 1 (eFadeIn): fade in new scene (no fade out of current scene).
 
* 2 (eFadeOut): fade out current scene (no fade in of new scene).
 
* 3 (eFadeInAndOut): fade out current scene and fade in new scene.
 
* 4 (eFadeToNew): use alpha-blending to directly fade from current to new scene.
 
* 5 (eShiftLeft): shift current scene to the left and show new scene.
 
* 6 (eShiftRight): shift current scene to the right and show new scene.
 
* 7 (eTunnelEffect): use a tunnel effect for fade in/out.
 
| 547
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| FirstCharacter
+
| CurrentObject
| t_link to [[#Characters|Characters]]
+
| t_link to [[#Objects|Objects]] or [[#Characters|Characters]] or [[#Buttons|Buttons]]
| Character which is used for starting the game. This is the character which is controlled by the player.
+
| The object currently below the cursor.
| 303
+
| 687
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
|-
+
|-  
| FirstScene
+
| CurrentScene
 
| t_link to [[#Scenes|Scenes]]
 
| t_link to [[#Scenes|Scenes]]
| The first scene of the game (which is shown after the loading screen)
+
| Scene which is currently shown.
| 121
+
| 469
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| CurrentText
 +
| t_link to [[#ActiveTexts|ActiveTexts]]
 +
| Text which is currently displayed.
 +
| 477
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Cursor
 +
| t_link to [[#Cursors|Cursors]]
 +
|
 +
| 856
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| CursorHorizontalScrollDistance
 +
| t_int
 +
| Distance of cursor to the left or right screen border where horizontal scrolling will be started.
 +
| 689
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| CursorVerticalScrollDistance
 +
| t_int
 +
| Distance of cursor to the top or bottom screen border where vertical scrolling will be started.
 +
| 690
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Cursors
 +
| t_links to [[#Cursors|Cursors]] (parent)
 +
| All cursors of the game.
 +
| 215
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| FontLinks
+
| CustomActionParts
| t_links to [[#Fonts|Fonts]] (parent)
+
| t_vstring
| All fonts of the game.
+
| All custom action parts from installed action part plugins.
| 120
+
| 857
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| FullScreenIntro
+
| CutsceneAction
| t_bool
+
| t_link to [[#Actions|Actions]]
| True if the intro movie is scaled to fullscreen.
+
| If a cutscene is active this links to the action which started (and should stop) the cutscene.
| 247
+
| 633
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 +
|-
 +
| DefaultMusicBus
 +
| t_link to [[#AudioBusses|AudioBusses]]
 +
|
 +
| 854
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| GameComposedFile
+
| DefaultSoundBus
| t_path
+
| t_link to [[#AudioBusses|AudioBusses]]
| Defines the filename for composing the game object and its actions (e.&nbsp;g. left mouse button action, right mouse button action) when compiling the game.
+
|  
| 683
+
| 852
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| GameComposedFiles
+
| DefaultSpeechBus
| t_int
+
| t_link to [[#AudioBusses|AudioBusses]]
| The number of composed game files. Possible values:
+
|  
* 0 (eMainContainer): The game object is stored in the main container.
+
| 851
* 1 (eSingleContainer): The game object is stored in one file specified by "GameComposedFile".
+
| class="cent" | <div class="tick"></div>
| 682
+
| class="cent" | S
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
 
|-
 
|-
| GameName
+
| Description
 
| t_string
 
| t_string
| The game name is used for the path where game log files and savegames are stored. E.&nbsp;g. on an English Windows the path could look like this: <code>C:\Users\USERNAME\AppData\Local\COMPANY_NAME\GAME_NAME.</code>
+
| Short description of the game.
| 701
+
| 124
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| HiddenDialog
 
| t_link to [[#Dialogs|Dialogs]]
 
| If the user switches to a menu while a dialog is currently shown in a playable scene (e.&nbsp;g. the dialog parts are displayed) - this is only possible if "ExecuteActionsDuringDialog" is true - then the dialog is saved in this field. The dialog is hidden until the user switches back to a playable scene.
 
| 579
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V/S
 
 
|-  
 
|-  
| HideCursor
+
| DestinationCommand
| t_bool
+
| t_link to [[#Buttons|Buttons]]
| If true the cursor is hidden and no cursor interaction is possible.
+
| When the user clicked on an object and the character walks to this object, this command will be executed when the object is reached.
| 480
+
| 483
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-  
 
|-  
| HideInterfaces
+
| DestinationEvent
| t_bool
+
| t_int
| If true all interfaces are hidden, independent of individual interface visibility.
+
| When the user clicked on an object and the character walks to this object, this event will be executed when the object is reached. Possible values:
| 479
+
* 0: no event.
 +
* 1: left mousebutton click.
 +
* 2: right mousebutton click.
 +
* 3: left mousebutton double click.
 +
* 4: left mousebutton hold.
 +
* 5: mouse enters area.
 +
* 6: mouse leaves area.
 +
| 615
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-  
 
|-  
| HoldTime
+
| DestinationItem
| t_int
+
| t_link to [[#Objects|Objects]]
| Time (in milliseconds) until the 'Mouse holding' event (for "LeftHoldAction" and "LeftHoldingAction") is fired.
+
| When the user clicked on an object and the character walks to this object, this item will be used on the object when it is reached.
| 377
+
| 484
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
 
|-  
 
|-  
| HorizontalScrollDistance
+
| DestinationItemPicked
| t_int
+
| t_bool
| If the distance of the current character to the horizontal scene border is equal or smaller than this value then the scene will be scrolled horizontal to center the character (if the scene is larger than the viewable area). If this value is very small the character has to go very close to the border until the scene is scrolled, if the value is half the viewable size or larger then the character will always be centered.
+
| When the user clicked on an object and the character walks to this object, this will be set to true in case an item was picked up (see "DraggableObjects"). Then the item in "DestinationItem" will be dropped on the object when it is reached.
| 667
+
| 485
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| IconFile
+
| Dialog
| t_path
+
| t_link to [[#Dialogs|Dialogs]]
|  
+
| Currently displayed dialog.
| 818
+
| 476
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| Id
+
| DialogAction
| t_string
+
| t_link to [[#Actions|Actions]]
| Unique Identification number. Used for savegames in order to only load savegames for correct game.
+
| Running action which contains the text for the current dialog.
| 370
+
| 481
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| Interfaces
+
| DisableInteractionDuringAnim
| t_links to [[#Interfaces|Interfaces]] (parent)
+
| t_int
| All interfaces of the game.
+
|  
| 662
+
| 643
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|-  
| InterfaceClasses
+
| DraggableItems
| t_links to [[#InterfaceClasses|InterfaceClasses]] (parent)
+
| t_bool
| All interface classes of the game.
+
| True if objects can be dragged from the interface.
| 661
+
| 305
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| DrawActionText
 +
| t_int
 +
| Defines if and where the action text is drawn. Possible values:
 +
* 0 (eDrawNoActionText): do not draw action text.
 +
* 1 (eDrawActionTextAtCurrentPos): draw action text at current cursor position.
 +
* 2 (eDrawActionTextAtRect): draw action text centered in the rectangle defined by GameActionTextRect.
 +
| 588
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| ExecuteActionsDuringDialog
 +
| t_bool
 +
| If true the key actions (defined in "Actions") will also be executed if a dialog is currently displayed.
 +
| 578
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| ExecuteCalledActionImmediately
 +
| t_bool
 +
|
 +
| 790
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|-  
| InterfaceComposedFile
+
| FadeDelay
| t_path
+
| t_int
| Defines the filename for composing the interface when compiling the game.
+
| Delay for fade in/out of a scene in milliseconds.
| 671
+
| 234
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| FadeEffect
 +
| t_int
 +
| Effect for fade in/out of a scene. Possible values:
 +
* 0 (eFadeNo): no effect, display new scene immediately.
 +
* 1 (eFadeIn): fade in new scene (no fade out of current scene).
 +
* 2 (eFadeOut): fade out current scene (no fade in of new scene).
 +
* 3 (eFadeInAndOut): fade out current scene and fade in new scene.
 +
* 4 (eFadeToNew): use alpha-blending to directly fade from current to new scene.
 +
* 5 (eShiftLeft): shift current scene to the left and show new scene.
 +
* 6 (eShiftRight): shift current scene to the right and show new scene.
 +
* 7 (eTunnelEffect): use a tunnel effect for fade in/out.
 +
| 547
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| FirstCharacter
 +
| t_link to [[#Characters|Characters]]
 +
| Character which is used for starting the game. This is the character which is controlled by the player.
 +
| 303
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| InterfaceComposedFiles
+
| FirstScene
| t_int
+
| t_link to [[#Scenes|Scenes]]
| The number of composed interface files. Possible values:
+
| The first scene of the game (which is shown after the loading screen)
* 0 (eMainContainer): All interfaces are stored in the main container.
+
| 121
* 1 (eSingleContainer): All interfaces are stored in one file specified by "InterfaceComposedFile".
 
* 2 (eMultipleContainers): Each interface is stored in an own container specified by "InterfaceComposedFile" (filename extended by the interface number).
 
| 670
 
| class="cent" | <div class="cross"></div>
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| Intro
+
| FontLinks
| t_path
+
| t_links to [[#Fonts|Fonts]] (parent)
| Intro movie which will be played at the beginning of the game.
+
| All fonts of the game.
| 224
+
| 120
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Items
+
| FullScreenIntro
| t_links to [[#Objects|Objects]] (parent)
+
| t_bool
| All items of the game.
+
| True if the intro movie is scaled to fullscreen.
| 349
+
| 247
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| KeepCharacterSpritesDuringMenus
+
| GameComposedFile
| t_bool
+
| t_path
|  
+
| Defines the filename for composing the game object and its actions (e.&nbsp;g. left mouse button action, right mouse button action) when compiling the game.
| 642
+
| 683
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Languages
+
| GameComposedFiles
| t_links to [[#Languages|Languages]] (parent)
+
| t_int
| All languages of the game.
+
| The number of composed game files. Possible values:
| 259
+
* 0 (eMainContainer): The game object is stored in the main container.
 +
* 1 (eSingleContainer): The game object is stored in one file specified by "GameComposedFile".
 +
| 682
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LeftClickAction
+
| GameName
| t_link to [[#Actions|Actions]] (parent)
+
| t_string
| An action which will be started if the left mouse button is clicked.
+
| The game name is used for the path where game log files and savegames are stored. E.&nbsp;g. on an English Windows the path could look like this: <code>C:\Users\USERNAME\AppData\Local\COMPANY_NAME\GAME_NAME.</code>
| 563
+
| 701
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LeftClickBehaviour
+
| HiddenDialog
 +
| t_link to [[#Dialogs|Dialogs]]
 +
| If the user switches to a menu while a dialog is currently shown in a playable scene (e.&nbsp;g. the dialog parts are displayed) - this is only possible if "ExecuteActionsDuringDialog" is true - then the dialog is saved in this field. The dialog is hidden until the user switches back to a playable scene.
 +
| 579
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V/S
 +
|-
 +
| HideCursor
 +
| t_bool
 +
| If true the cursor is hidden and no cursor interaction is possible.
 +
| 480
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| HideInterfaces
 +
| t_bool
 +
| If true all interfaces are hidden, independent of individual interface visibility.
 +
| 479
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| HoldTime
 
| t_int
 
| t_int
| Defines if the character will be sent to the current position when the left mouse button is clicked. Possible values:
+
| Time (in milliseconds) until the 'Mouse holding' event (for "LeftHoldAction" and "LeftHoldingAction") is fired.
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
+
| 377
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
 
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
 
| 891
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
 +
|-
 +
| HorizontalScrollDistance
 +
| t_int
 +
| If the distance of the current character to the horizontal scene border is equal or smaller than this value then the scene will be scrolled horizontal to center the character (if the scene is larger than the viewable area). If this value is very small the character has to go very close to the border until the scene is scrolled, if the value is half the viewable size or larger then the character will always be centered.
 +
| 667
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| LeftDblClickAction
+
| IconFile
| t_link to [[#Actions|Actions]] (parent)
+
| t_path
| An action which will be started if the left mouse button is double clicked.
+
|  
| 379
+
| 818
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LeftHoldAction
+
| Id
| t_link to [[#Actions|Actions]] (parent)
+
| t_string
| Action which is started if the left mouse button is pressed for a certain time ("HoldTime") and "LeftMouseHold" is set to 3 or 4. The action is started when the mouse button is released.
+
| Unique Identification number. Used for savegames in order to only load savegames for correct game.
| 381
+
| 370
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LeftHoldingAction
+
| Interfaces
| t_link to [[#Actions|Actions]] (parent)
+
| t_links to [[#Interfaces|Interfaces]] (parent)
| Action which is started if the left mouse button is pressed for a certain time ("HoldTime") and "LeftMouseHolding" is set to 3. The action is started when the mouse button is pressed.
+
| All interfaces of the game.
| 386
+
| 662
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| LeftHoldBehaviour
+
| InterfaceClasses
| t_int
+
| t_links to [[#InterfaceClasses|InterfaceClasses]] (parent)
| Defines if the character will be sent to the current position when the left button is released. Possible values:
+
| All interface classes of the game.
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
+
| 661
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
+
| class="cent" | <div class="cross"></div>
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
+
| class="cent" | V
| 780
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| Loading
+
| InterfaceComposedFile
| t_link to [[#Loadings|Loadings]] (parent)
+
| t_path
| The loading screen which is shown on startup when the game is loaded.
+
| Defines the filename for composing the interface when compiling the game.
| 358
+
| 671
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ''MinificationFilter''
+
| InterfaceComposedFiles
| ''t_int''
+
| t_int
| ''DEPRECATED, see "NearestNeighborInterpolation" instead''
+
| The number of composed interface files. Possible values:
|  
+
* 0 (eMainContainer): All interfaces are stored in the main container.
| class="cent" |  
+
* 1 (eSingleContainer): All interfaces are stored in one file specified by "InterfaceComposedFile".
| class="cent" |  
+
* 2 (eMultipleContainers): Each interface is stored in an own container specified by "InterfaceComposedFile" (filename extended by the interface number).
 +
| 670
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | <div class="cross"></div>
 
|-
 
|-
| ''MagnificationFilter''
+
| Intro
| ''t_int''
+
| t_path
| ''DEPRECATED, see "NearestNeighborInterpolation" instead''
+
| Intro movie which will be played at the beginning of the game.
|  
+
| 224
| class="cent" |  
+
| class="cent" | <div class="cross"></div>
| class="cent" |  
+
| class="cent" | V
 
|-
 
|-
| MiddleClickAction
+
| Items
| t_link
+
| t_links to [[#Objects|Objects]] (parent)
| An action which will be started if the middle mouse button is clicked.
+
| All items of the game.
| 766
+
| 349
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| MiddleClickBehaviour
+
| KeepCharacterSpritesDuringMenus
| t_int
+
| t_bool
| Defines if the character will be sent to the current position when the middle mouse button is clicked. Possible values:
+
|
 +
| 642
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Languages
 +
| t_links to [[#Languages|Languages]] (parent)
 +
| All languages of the game.
 +
| 259
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| LeftClickAction
 +
| t_link to [[#Actions|Actions]] (parent)
 +
| An action which will be started if the left mouse button is clicked.
 +
| 563
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| LeftClickBehaviour
 +
| t_int
 +
| Defines if the character will be sent to the current position when the left mouse button is clicked. Possible values:
 
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
 
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
 
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
 
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
 
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
 
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
| 781
+
| 891
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
 
|-
 
|-
| MouseWheelDownAction
+
| LeftDblClickAction
| t_link to [[#Actions|Actions]]
+
| t_link to [[#Actions|Actions]] (parent)
| An action which will be started if the mouse wheel is moved down.
+
| An action which will be started if the left mouse button is double clicked.
| 768
+
| 379
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| MouseWheelUpAction
+
| LeftHoldAction
| t_link to [[#Actions|Actions]]
+
| t_link to [[#Actions|Actions]] (parent)
| An action which will be started if the mouse wheel is moved up.
+
| Action which is started if the left mouse button is pressed for a certain time ("HoldTime") and "LeftMouseHold" is set to 3 or 4. The action is started when the mouse button is released.
| 767
+
| 381
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| MovieComposedFile
+
| LeftHoldingAction
| t_path
+
| t_link to [[#Actions|Actions]] (parent)
| Defines the filename for composing the movies when compiling the game.
+
| Action which is started if the left mouse button is pressed for a certain time ("HoldTime") and "LeftMouseHolding" is set to 3. The action is started when the mouse button is pressed.
| 622
+
| 386
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| MovieComposedFiles
+
| LeftHoldBehaviour
 
| t_int
 
| t_int
| The number of composed movie files. Possible values:
+
| Defines if the character will be sent to the current position when the left button is released. Possible values:
* 0 (eMainContainer): All movies are stored in the main container.
+
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
* 1 (eSingleContainer): All movies are stored in one file specified by "MovieComposedFile".
+
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
| 621
+
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
 +
| 780
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| Loading
 +
| t_link to [[#Loadings|Loadings]] (parent)
 +
| The loading screen which is shown on startup when the game is loaded.
 +
| 358
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| NearestNeighborInterpolation
+
| ''MinificationFilter''
| t_bool
+
| ''t_int''
| If true nearest neighbor interpolation is used scaling of character images (pixel effect).
+
| ''DEPRECATED, see "NearestNeighborInterpolation" instead''
| 745
+
|  
| class="cent" | <div class="cross"></div>
+
| class="cent" |  
| class="cent" | V
+
| class="cent" |  
|-  
+
|-
| ObjectFont
+
| ''MagnificationFilter''
| t_link to [[#Fonts|Fonts]]
+
| ''t_int''
| The font used when displaying an object text. An object text can be set with an action part which links a text to a scene object or an interface button.
+
| ''DEPRECATED, see "NearestNeighborInterpolation" instead''
| 685
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
|-
 
| ObjectTextOutput
 
| t_int
 
 
|  
 
|  
| 702
+
| class="cent" |
 +
| class="cent" |
 +
|-
 +
| MiddleClickAction
 +
| t_link
 +
| An action which will be started if the middle mouse button is clicked.
 +
| 766
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-  
+
|-
| OverlayColor
+
| MiddleClickBehaviour
 
| t_int
 
| t_int
|  
+
| Defines if the character will be sent to the current position when the middle mouse button is clicked. Possible values:
| 841
+
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
 +
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
 +
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
 +
| 781
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
|-
 
| OverlayVisibility
 
| t_int
 
|
 
| 840
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| ParticleContainerLinks
+
| MouseWheelDownAction
| t_links to [[#ParticleContainers|ParticleContainers]] (parent)
+
| t_link to [[#Actions|Actions]]
| All particle systems of the game.
+
| An action which will be started if the mouse wheel is moved down.
| 448
+
| 768
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| PicBufferSize
 
| t_int
 
| Buffer size (in KB) for reserved memory at game startup. This buffer is used for all non-preloaded images and should be large enough to hold the largest image, otherwise memory must be allocated dynamically which can lead to memory fragmentation and crash the application. E.&nbsp;g. if the largest image is 1400x1200 and has an alpha channel then "PicBufferSize" must be set to a value >= 6563 (4 byte per pixel (red, green, blue and alpha channel), 1400 * 1200 * 4 = 6720000, divided by 1024 because unit is KB and not byte, 6720000 / 1024 = 6562.5).
 
| 733
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| PictureCacheSize
+
| MouseWheelUpAction
| t_int
+
| t_link to [[#Actions|Actions]]
| Size (in MB) for cache which stores the recently loaded images.
+
| An action which will be started if the mouse wheel is moved up.
| 669
+
| 767
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Plugins
+
| MovieComposedFile
| t_links to [[#Plugins|Plugins]]
+
| t_path
| Installed action part plugins.
+
| Defines the filename for composing the movies when compiling the game.
| 863
+
| 622
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| PreallocatedTextures
+
| MovieComposedFiles
 
| t_int
 
| t_int
|  
+
| The number of composed movie files. Possible values:
| 743
+
* 0 (eMainContainer): All movies are stored in the main container.
 +
* 1 (eSingleContainer): All movies are stored in one file specified by "MovieComposedFile".
 +
| 621
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| PreloadPicThreads
+
| NearestNeighborInterpolation
| t_int
+
| t_bool
| Number of threads used for preloading animations. "PreloadPicThreads" number of buffers with size of "PreloadedPicBufferSize" will be preallocated.
+
| If true nearest neighbor interpolation is used scaling of character images (pixel effect).
| 731
+
| 745
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|-  
| PreloadedPicBufferSize
+
| ObjectFont
 +
| t_link to [[#Fonts|Fonts]]
 +
| The font used when displaying an object text. An object text can be set with an action part which links a text to a scene object or an interface button.
 +
| 685
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| ObjectTextOutput
 
| t_int
 
| t_int
| Buffer size (in KB) for reserved memory at game startup. This buffer is used for preloading images and should be large enough to hold the largest image (of a preloaded animation), otherwise memory must be allocated dynamically which can lead to memory fragmentation and crash the application. E.&nbsp;g. if the largest image of all preloaded animations is 1400x1200 and has an alpha channel then "PreloadedPicBufferSize" must be set to a value >= 6563 (4 byte per pixel (red,green,blue and alpha channel), 1400 * 1200 * 4 = 6720000, divided by 1024 because unit is KB and not byte, 6720000 / 1024 = 6562.5).
+
|  
| 732
+
| 702
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| Quake
+
| OverlayColor
| t_bool
 
| If true a quake constantly moves the screen. The values "QuakeForce" and "QuakeSpeed" are used as parameters for the quake.
 
| 629
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| QuakeForce
 
 
| t_int
 
| t_int
| Number of maximum pixels the screen is moved by a quake. Value is only used if "Quake" is true.
+
|  
| 630
+
| 841
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-  
 
|-  
| QuakeSpeed
+
| OverlayVisibility
 
| t_int
 
| t_int
| Defines how long (in milliseconds) a moved screen is shown at the same position. A higher value results in a slower quake because the same screen is shown longer. Value is only used if "Quake" is true.
+
|  
| 631
+
| 840
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| RegisteredEventHandlers
+
| ParticleContainerLinks
| t_string
+
| t_links to [[#ParticleContainers|ParticleContainers]] (parent)
| All registered event handlers.
+
| All particle systems of the game.
| 759
+
| 448
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| PicBufferSize
 +
| t_int
 +
| Buffer size (in KB) for reserved memory at game startup. This buffer is used for all non-preloaded images and should be large enough to hold the largest image, otherwise memory must be allocated dynamically which can lead to memory fragmentation and crash the application. E.&nbsp;g. if the largest image is 1400x1200 and has an alpha channel then "PicBufferSize" must be set to a value >= 6563 (4 byte per pixel (red, green, blue and alpha channel), 1400 * 1200 * 4 = 6720000, divided by 1024 because unit is KB and not byte, 6720000 / 1024 = 6562.5).
 +
| 733
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| Reserved
+
| PictureCacheSize
| t_string
+
| t_int
| Licence number.
+
| Size (in MB) for cache which stores the recently loaded images.
| 369
+
| 669
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| RightClickAction
+
| Plugins
| t_link to [[#Actions|Actions]] (parent)
+
| t_links to [[#Plugins|Plugins]]
| Action which is started if the right mouse button is pressed and "RightMouseClick" is set to 3 or 4.
+
| Installed action part plugins.
| 337
+
| 863
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-  
+
|-
| RightClickBehaviour
+
| PreallocatedTextures
 
| t_int
 
| t_int
| Defines if the character will be sent to the current position when the right mouse button is clicked.Possible values:
+
|  
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
+
| 743
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
+
| class="cent" | <div class="cross"></div>
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
+
| class="cent" | V
| 782
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| SavedObject
 
| t_link to [[#Characters|Characters]] or [[#Objects|Objects]] or [[#Buttons|Buttons]]
 
| Object which is currently saved to execute an action on (usually through the "Save object" action part).
 
| 486
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| SaveGameName
+
| PreloadPicThreads
| t_string
 
| Used to store name of current savegame.
 
| 537
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | S
 
|-
 
| SavegameScreenshot
 
| t_path
 
| Image used as savegame screenshot for all scenes when game is played on a mobile device.
 
| 764
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
|-
 
| SaveNameOffsetY
 
 
| t_int
 
| t_int
|  
+
| Number of threads used for preloading animations. "PreloadPicThreads" number of buffers with size of "PreloadedPicBufferSize" will be preallocated.
| 843
+
| 731
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SceneComposedFile
+
| PreloadedPicBufferSize
| t_path
+
| t_int
| Defines the filename for composing the scenes when compiling the game.
+
| Buffer size (in KB) for reserved memory at game startup. This buffer is used for preloading images and should be large enough to hold the largest image (of a preloaded animation), otherwise memory must be allocated dynamically which can lead to memory fragmentation and crash the application. E.&nbsp;g. if the largest image of all preloaded animations is 1400x1200 and has an alpha channel then "PreloadedPicBufferSize" must be set to a value >= 6563 (4 byte per pixel (red,green,blue and alpha channel), 1400 * 1200 * 4 = 6720000, divided by 1024 because unit is KB and not byte, 6720000 / 1024 = 6562.5).
| 618
+
| 732
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|-  
| SceneComposedFiles
+
| Quake
 +
| t_bool
 +
| If true a quake constantly moves the screen. The values "QuakeForce" and "QuakeSpeed" are used as parameters for the quake.
 +
| 629
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| QuakeForce
 
| t_int
 
| t_int
| The number of composed scene files. Possible values:
+
| Number of maximum pixels the screen is moved by a quake. Value is only used if "Quake" is true.
* 0 (eMainContainer): All scenes are stored in the main container.
+
| 630
* 1 (eSingleContainer): All scenes are stored in one file specified by "SceneComposedFile".
+
| class="cent" | <div class="tick"></div>
* 2 (eMultipleContainers): Each scene is stored in an own container specified by "SceneComposedFile" (filename extended by the scene number).
+
| class="cent" | S
| 617
+
|-
 +
| QuakeSpeed
 +
| t_int
 +
| Defines how long (in milliseconds) a moved screen is shown at the same position. A higher value results in a slower quake because the same screen is shown longer. Value is only used if "Quake" is true.
 +
| 631
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| RegisteredEventHandlers
 +
| t_string
 +
| All registered event handlers.
 +
| 759
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| SceneLinks
+
| Reserved
| t_links to [[#Scenes|Scenes]] (parent)
+
| t_string
| All scenes of the game.
+
| Licence number.
| 117
+
| 369
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ScriptLinks
+
| RightClickAction
| t_links to [[#Scripts|Scripts]] (parent)
+
| t_link to [[#Actions|Actions]] (parent)
| All scripts of the game.
+
| Action which is started if the right mouse button is pressed and "RightMouseClick" is set to 3 or 4.
| 651
+
| 337
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| ScrollCenterCharacter
+
| RightClickBehaviour
| t_bool
+
| t_int
| If true the character linked in "ScrollCharacter" will be centered on the scene (if "ScrollTo" is false). If false then no character will be centered.
+
| Defines if the character will be sent to the current position when the right mouse button is clicked.Possible values:
| 561
+
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
 +
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
 +
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
 +
| 782
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
 
|-  
 
|-  
| ScrollCharacter
+
| SavedObject
| t_link to [[#Characters|Characters]]
+
| t_link to [[#Characters|Characters]] or [[#Objects|Objects]] or [[#Buttons|Buttons]]
| Character which will be centered on the current scene (if "ScrollCenterCharacter" is true and "ScrollTo" is false).
+
| Object which is currently saved to execute an action on (usually through the "Save object" action part).
| 611
+
| 486
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| ScrollDirectionHorizontal
+
| SaveGameName
| t_int
+
| t_string
| Horizontal direction the scene is currently scrolling. Possible values:
+
| Used to store name of current savegame.
* 0: currently no horizontal scrolling.
+
| 537
* 1: currently scrolling to the left.
 
* 2: currently scrolling to the right.
 
| 473
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| ScrollDirectionVertical
+
| SavegameScreenshot
 +
| t_path
 +
| Image used as savegame screenshot for all scenes when game is played on a mobile device.
 +
| 764
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| SaveNameOffsetY
 
| t_int
 
| t_int
| Vertical direction the scene is currently scrolling. Possible values:
+
|  
* 0: currently no vertical scrolling.
+
| 843
* 3: currently scrolling to the top.
 
* 4: currently scrolling to the bottom.
 
| 474
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
|-
 
| ScrollPosition
 
| t_point
 
| Upper left corner of current scroll position (on current scene).
 
| 470
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| ScrollSpeed
 
| t_int
 
| Number of pixels which will be scrolled in one second.
 
| 246
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| ScrollToPoint
 
| t_point
 
| Upper left corner the current scene is scrolling to.
 
| 471
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| ScrollTo
+
| SceneComposedFile
| t_bool
+
| t_path
| If true the scene is currently scrolling to "ScrollToPoint".
+
| Defines the filename for composing the scenes when compiling the game.
| 472
+
| 618
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| ShaderExclude
+
| SceneComposedFiles
 
| t_int
 
| t_int
| Defines which components (scene, interfaces, texts, cursor) will be excluded from shader programs. Possible values:
+
| The number of composed scene files. Possible values:
* 0 (eShaderExcludeNothing): standard, exclude nothing.
+
* 0 (eMainContainer): All scenes are stored in the main container.
* 1 (eShaderExcludeInterfaces): exclude interfaces, text on top, cursor.
+
* 1 (eSingleContainer): All scenes are stored in one file specified by "SceneComposedFile".
* 2 (eShaderExcludeTextsAndCursor): exclude text on top, cursor.
+
* 2 (eMultipleContainers): Each scene is stored in an own container specified by "SceneComposedFile" (filename extended by the scene number).
* 3 (eShaderExcludeCursor): exclude cursor
+
| 617
| 787
+
| class="cent" | <div class="cross"></div>
| class="cent" | <div class="tick"></div>
+
| class="cent" | V
| class="cent" | S
 
 
|-
 
|-
| ShaderLinks
+
| SceneLinks
| t_links to [[#Shaders|Shaders]]
+
| t_links to [[#Scenes|Scenes]] (parent)
|  
+
| All scenes of the game.
| 820
+
| 117
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ShowBlackScreenAfterVideo
+
| ScriptLinks
| t_bool
+
| t_links to [[#Scripts|Scripts]] (parent)
| If true a black screen will be shown after the video is finished (until the next game scene is ready and all images are loaded). Otherwise the last frame of the video is shown until the game is continued.
+
| All scripts of the game.
| 763
+
| 651
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| SmoothScrolling
 
| t_bool
 
|
 
| 826
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|-  
| SpeakerSoundPanFactor
+
| ScrollCenterCharacter
| t_int
+
| t_bool
| Speech output balance in percent. Defines if the speech output is played on left/right speaker depending on the character position. If set to 0 the speech output will be played equally on left and right speaker. If set to 100 the output volume on left/right speaker completely depends on the position of the character on the current scene.
+
| If true the character linked in "ScrollCharacter" will be centered on the scene (if "ScrollTo" is false). If false then no character will be centered.
| 758
+
| 561
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-
 
| SpeakerTextAlignment
 
| t_int
 
| Defines alignment of speaker text. Possible values:
 
* 0 (eAlignLeft): Align left.
 
* 1 (eAlignRight): Align right.
 
* 2 (eAlignCentered): Centered.
 
* 3 (eAlignLeftWithCenterPos): Align left (use center position).
 
* 4 (eAlignRightWithCenterPos): Align right (use center position).
 
* 5 (eAlignCenteredWithLeftPos): Centered (use left position).
 
| 592
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-  
 
|-  
| SpeechLanguage
+
| ScrollCharacter
| t_link to [[#Languages|Languages]]
+
| t_link to [[#Characters|Characters]]
| Defines the language which is used for speech output. If empty the language from "StandardLanguage" will be used.
+
| Character which will be centered on the current scene (if "ScrollCenterCharacter" is true and "ScrollTo" is false).
| 755
+
| 611
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-
 
| StandardLanguage
 
| t_link to [[#Languages|Languages]]
 
| Defines the currently used language.
 
| 306
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| StartAction
+
| ScrollDirectionHorizontal
| t_link to [[#Actions|Actions]] (parent)
+
| t_int
| This action will be executed once at the beginning of the game (after the game was loaded).
+
| ''DEPRECATED''
| 368
+
| 473
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| ScrollDirectionVertical
 +
| t_int
 +
| ''DEPRECATED''
 +
| 474
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 +
|-
 +
| ScrollPosition
 +
| t_point
 +
| Upper left corner of current scroll position (on current scene).
 +
| 470
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-  
 
|-  
| TextAlignment
+
| ScrollSpeed
 
| t_int
 
| t_int
| Defines alignment of spoken text. Possible values:
+
| Number of pixels which will be scrolled in one second.
* 0 (eAlignLeft): Align left.
+
| 246
* 1 (eAlignRight): Align right.
 
* 2 (eAlignCentered): Centered.
 
* 3 (eAlignLeftWithCenterPos): Align left (use center position).
 
* 4 (eAlignRightWithCenterPos): Align right (use center position).
 
* 5 (eAlignCenteredWithLeftPos): Centered (use left position).
 
| 593
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
 
|-  
 
|-  
| TextOutput
+
| ScrollToPoint
| t_int
+
| t_point
| Defines if spoken texts should be printed and/or spoken. Possible values:
+
| Upper left corner the current scene is scrolling to.
* 0 (eTextAndSpeechOutput): Display text and play speech file.
+
| 471
* 1 (eOnlySpeechOutput): Only play speech file.
 
* 2 (eOnlyTextOutput): Only display text.
 
| 583
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
|-
+
| ScrollTo
| TextSpeed
 
| t_int
 
| Speed for displaying texts (in percent). Default is 100.
 
| 646
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| UsedItem
 
| t_link to [[#Objects|Objects]]
 
| The currently picked up item. A picked up item is either dragged (shown instead of cursor) or displayed in the action text.
 
| 686
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | S
 
|-
 
| UsedItemPicked
 
 
| t_bool
 
| t_bool
| True if "UsedItem" = true and the used item is dragged (shown instead of cursor).
+
| If true the scene is currently scrolling to "ScrollToPoint".
| 730
+
| 472
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| Version
+
| ShaderExclude
| t_string
 
| Version number of the game.
 
| 627
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| VerticalScrollDistance
 
 
| t_int
 
| t_int
| If the distance of the current character to the vertical scene border is equal or smaller than this value then the scene will be scrolled vertical to center the character (if the scene is larger than the viewable area). If this value is very small the character has to go very close to the border until the scene is scrolled, if the value is half the viewable size or larger then the character will always be centered.
+
| Defines which components (scene, interfaces, texts, cursor) will be excluded from shader programs. Possible values:
| 668
+
* 0 (eShaderExcludeNothing): standard, exclude nothing.
 +
* 1 (eShaderExcludeInterfaces): exclude interfaces, text on top, cursor.
 +
* 2 (eShaderExcludeTextsAndCursor): exclude text on top, cursor.
 +
* 3 (eShaderExcludeCursor): exclude cursor
 +
| 787
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| VideoAudioLanguage
+
| ShaderLinks
| t_string
+
| t_links to [[#Shaders|Shaders]]
 
|  
 
|  
| 738
+
| 820
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ShowBlackScreenAfterVideo
 +
| t_bool
 +
| If true a black screen will be shown after the video is finished (until the next game scene is ready and all images are loaded). Otherwise the last frame of the video is shown until the game is continued.
 +
| 763
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
 
|-
 
|-
| VideosEncrypted
+
| SmoothScrolling
 
| t_bool
 
| t_bool
| If true the videos are stored in an encrypted container. This field is only relevant for compiled games.
 
| 699
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| VideoPauseScreen
 
| t_path
 
 
|  
 
|  
| 788
+
| 826
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| VideoSubtitleFont
+
| SpeakerSoundPanFactor
| t_link to [[#Fonts|Fonts]]
+
| t_int
|  
+
| Speech output balance in percent. Defines if the speech output is played on left/right speaker depending on the character position. If set to 0 the speech output will be played equally on left and right speaker. If set to 100 the output volume on left/right speaker completely depends on the position of the character on the current scene.
| 735
+
| 758
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
 
|-
 
|-
| VideoSubtitleLanguage
+
| SpeakerTextAlignment
| t_string
+
| t_int
|  
+
| Defines alignment of speaker text. Possible values:
| 737
+
* 0 (eAlignLeft): Align left.
 +
* 1 (eAlignRight): Align right.
 +
* 2 (eAlignCentered): Centered.
 +
* 3 (eAlignLeftWithCenterPos): Align left (use center position).
 +
* 4 (eAlignRightWithCenterPos): Align right (use center position).
 +
* 5 (eAlignCenteredWithLeftPos): Centered (use left position).
 +
| 592
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
|-
+
|-  
| VideoSubtitlePosition
+
| SpeechLanguage
| t_point
+
| t_link to [[#Languages|Languages]]
|  
+
| Defines the language which is used for speech output. If empty the language from "StandardLanguage" will be used.
| 736
+
| 755
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-
+
|-  
| WalksoundBus
+
| StandardLanguage
| t_link to [[#AudioBusses|AudioBusses]]
+
| t_link to [[#Languages|Languages]]
|  
+
| Defines the currently used language.
| 853
+
| 306
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | S
+
| class="cent" | V/S
 
|-
 
|-
| WaitCursor
+
| StartAction
| t_link to [[#Cursors|Cursors]]
+
| t_link to [[#Actions|Actions]] (parent)
|  
+
| This action will be executed once at the beginning of the game (after the game was loaded).
| 880
+
| 368
| class="cent" | <div class="cross"></div>
 
| class="cent" | V/S
 
|-
 
| WindowResolution
 
| t_point
 
| Screen resolution.
 
| 126
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
+
|-
 
+
| TextAlignment
 
+
| t_int
== Interfaces ==
+
| Defines alignment of spoken text. Possible values:
Table id: 1 <small>(eInterfaces)</small>
+
* 0 (eAlignLeft): Align left.
{| class="ts sortable"
+
* 1 (eAlignRight): Align right.
 +
* 2 (eAlignCentered): Centered.
 +
* 3 (eAlignLeftWithCenterPos): Align left (use center position).
 +
* 4 (eAlignRightWithCenterPos): Align right (use center position).
 +
* 5 (eAlignCenteredWithLeftPos): Centered (use left position).
 +
| 593
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| TextOutput
 +
| t_int
 +
| Defines if spoken texts should be printed and/or spoken. Possible values:
 +
* 0 (eTextAndSpeechOutput): Display text and play speech file.
 +
* 1 (eOnlySpeechOutput): Only play speech file.
 +
* 2 (eOnlyTextOutput): Only display text.
 +
| 583
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
! style="width:15%" | Field
+
|-
! style="width:15%" class="unsortable" | Type
+
| TextSpeed
! class="unsortable" | Description
+
| t_int
! style="width:3%" | id
+
| Speed for displaying texts (in percent). Default is 100.
! style="width:5%" class="unsortable" | Scriptable
+
| 646
! style="width:5%" class="unsortable" | Storage
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| ActionTextFont
+
| UsedItem
| t_link to [[#Fonts|Fonts]]
+
| t_link to [[#Objects|Objects]]
| Font which will be used for the action text - only used if "DrawActionText" is true.
+
| The currently picked up item. A picked up item is either dragged (shown instead of cursor) or displayed in the action text.
| 320
+
| 686
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| ActionTextRect
+
| UsedItemPicked
| t_rect
+
| t_bool
| Rectangle in which the action text will be drawn horizontally and vertically centered - only used if "DrawActionText" is true.
+
| True if "UsedItem" = true and the used item is dragged (shown instead of cursor).
| 319
+
| 730
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
 
|-
 
| ActiveCommand
 
| t_link to [[#Buttons|Buttons]]
 
|
 
| 607
 
| class="cent" | <div class="tick"></div>
 
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| Border
+
| Version
| t_vpoint
+
| t_string
| Polygon which defines the border of the interface. The interface is detected if the cursor is inside the polygon.
+
| Version number of the game.
| 325
+
| 627
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|-
 +
| VerticalScrollDistance
 +
| t_int
 +
| If the distance of the current character to the vertical scene border is equal or smaller than this value then the scene will be scrolled vertical to center the character (if the scene is larger than the viewable area). If this value is very small the character has to go very close to the border until the scene is scrolled, if the value is half the viewable size or larger then the character will always be centered.
 +
| 668
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| Buttons
+
| VideoAudioLanguage
| t_links to [[#Buttons|Buttons]] (parent)
+
| t_string
| All buttons of the interface: commands, arrows to scroll items, action areas, placeholder for items.
+
|
| 140
+
| 738
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| VideosEncrypted
 +
| t_bool
 +
| If true the videos are stored in an encrypted container. This field is only relevant for compiled games.
 +
| 699
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| InterfaceClass
+
| VideoPauseScreen
| t_link to [[#InterfaceClasses|InterfaceClasses]]
+
| t_path
| The class this interface belongs to.
+
|  
| 659
+
| 788
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Conditions
+
| VideoSubtitleFont
| t_links to [[#Conditions|Conditions]] (parent)
+
| t_link to [[#Fonts|Fonts]]
| The conditions of the interface.
+
|  
| 452
+
| 735
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| DestVisibility
 
| t_int
 
| The visibility of the interface (and all of its buttons) is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the interface will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility".
 
| 604
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-  
+
|-
| Displacement
+
| VideoSubtitleLanguage
| t_int
+
| t_string
| Defines where the interface is shown. Possible values:
+
|  
* 0: top.
+
| 737
* 1: bottom.
 
* 2: left.
 
* 3: right.
 
* 4: absolute, position on screen defined by "Offset".
 
* 5: relative, position defined by current cursor position and offset to the cursor position ("Offset").
 
| 314
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-
 
| DrawActionText
 
| t_bool
 
| Defines if the action text is drawn on this interface (if true then "ActionTextFont" and "ActionTextRect" must be set).
 
| 587
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
 
|-
 
|-
| ItemsScrollPosition
+
| VideoSubtitlePosition
| t_int
+
| t_point
| Current scroll position of the items in the interface/inventory.
+
|  
| 609
+
| 736
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| LeaveAction
+
| WalksoundBus
| t_link to [[#Actions|Actions]] (parent)
+
| t_link to [[#AudioBusses|AudioBusses]]
| Action which will be executed if the cursor leaves the interface (outside of polygon "Border").
 
| 388
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| MatrixId
 
| t_int
 
 
|  
 
|  
| 802
+
| 853
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
|-  
+
|-
| Offset
+
| WaitCursor
| t_point
+
| t_link to [[#Cursors|Cursors]]
| Offset (or absolute position) for displaying the interface (only used if "Displacement" is 4 or 5).
+
|  
| 302
+
| 880
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
 
|-
 
|-
| Position
+
| WindowResolution
 
| t_point
 
| t_point
| Absolute position of upper left corner of interface.
+
| Screen resolution.
| 688
+
| 126
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V/S
 
|-
 
| ScrollStepSize
 
| t_int
 
| Defines how many item positions will be scrolled if a scroll arrow is pushed.
 
| 138
 
| class="cent" | <div class="tick"></div>
 
 
| class="cent" | V
 
| class="cent" | V
|-
+
|}
| ShowAlways
+
 
| t_bool
+
 
|
+
== Interfaces ==
| 789
+
Table id: 1 <small>(eInterfaces)</small>
| class="cent" | <div class="tick"></div>
+
{| class="ts sortable"
| class="cent" | V/S
+
|-
|-  
+
! style="width:15%" | Field
| Size
+
! style="width:15%" class="unsortable" | Type
| t_int
+
! class="unsortable" | Description
| Defines the size of the interface (in pixels). Is needed if part of the interface is drawn into the scene (e.&nbsp;g. flowers on top of the interface) and the interface is aligned to the border. Is only used if > 0 and "Displacement" is 0, 1, 2 or 3.
+
! style="width:3%" | id
| 324
+
! style="width:5%" class="unsortable" | Scriptable
| class="cent" | <div class="tick"></div>
+
! style="width:5%" class="unsortable" | Storage
| class="cent" | V/S
 
 
|-
 
|-
| Sprite
+
| ActionTextFont
| t_sprite
+
| t_link to [[#Fonts|Fonts]]
| Background sprite of the interface.
+
| Font which will be used for the action text - only used if "DrawActionText" is true.
| 238
+
| 320
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| StandardCommand
+
| ActionTextRect
| t_link to [[#Buttons|Buttons]]
+
| t_rect
| Button which is the standard command (usually "Walk to") for this interface.
+
| Rectangle in which the action text will be drawn horizontally and vertically centered - only used if "DrawActionText" is true.
| 298
+
| 319
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| TimeToDestVisibility
 
| t_int
 
| Defines the time (in milliseconds) until the visibility defined in "DestVisibility" is reached. This value is used the next time when "DestVisibility" is set.
 
| 605
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| Values
+
| ActiveCommand
| t_links to [[#Values|Values]] (parent)
+
| t_link to [[#Buttons|Buttons]]
| The values of the interface.
+
|
| 453
+
| 607
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Border
 +
| t_vpoint
 +
| Polygon which defines the border of the interface. The interface is detected if the cursor is inside the polygon.
 +
| 325
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Buttons
 +
| t_links to [[#Buttons|Buttons]] (parent)
 +
| All buttons of the interface: commands, arrows to scroll items, action areas, placeholder for items.
 +
| 140
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| InterfaceClass
 +
| t_link to [[#InterfaceClasses|InterfaceClasses]]
 +
| The class this interface belongs to.
 +
| 659
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Conditions
 +
| t_links to [[#Conditions|Conditions]] (parent)
 +
| The conditions of the interface.
 +
| 452
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| Visibility
+
| DestVisibility
 
| t_int
 
| t_int
| Visibility of the interface (and all of its buttons) in percent. Must be between 0 and 100. A value of 0 means the interface is not visible at all. Note that the interface can only be visible if "Active" and "Visible" are true.
+
| The visibility of the interface (and all of its buttons) is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the interface will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility".
| 603
+
| 604
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-  
 
|-  
| Visible
+
| Displacement
| t_bool
+
| t_int
| If true the interface is visible - supposed "Visibility" is > 0. This option can be used to toggle the interface on/off without changing "Visibility".
+
| Defines where the interface is shown. Possible values:
| 606
+
* 0: top.
 +
* 1: bottom.
 +
* 2: left.
 +
* 3: right.
 +
* 4: absolute, position on screen defined by "Offset".
 +
* 5: relative, position defined by current cursor position and offset to the cursor position ("Offset").
 +
| 314
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
|}
+
|-  
 
+
| DrawActionText
 
+
| t_bool
== InterfaceClasses ==
+
| Defines if the action text is drawn on this interface (if true then "ActionTextFont" and "ActionTextRect" must be set).
Table id: 31 <small>(eInterfaceClasses)</small>
+
| 587
{| class="ts sortable"
 
|-
 
! style="width:15%" | Field
 
! style="width:15%" class="unsortable" | Type
 
! class="unsortable" | Description
 
! style="width:3%" | id
 
! style="width:5%" class="unsortable" | Scriptable
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
| Name
 
| t_string
 
| Interface class name. The name of the object itself will be set to the translated class name.
 
| 660
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
+
|-
 
+
| ItemsScrollPosition
 
+
| t_int
== Languages ==
+
| Current scroll position of the items in the interface/inventory.
Table id: 18 <small>(eLanguages)</small>
+
| 609
 
 
The language name is defined by the name of each language object.
 
 
 
 
 
== Loadings ==
 
Table id: 21 <small>(eLoadings)</small>
 
{| class="ts sortable"
 
|-
 
! style="width:15%" | Field
 
! style="width:15%" class="unsortable" | Type
 
! class="unsortable" | Description
 
! style="width:3%" | id
 
! style="width:5%" class="unsortable" | Scriptable
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
| Music
 
| t_path
 
| Music which is played while the loading screen is shown.
 
| 357
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
+
| class="cent" | S
 
|-
 
|-
| Sprite
+
| LeaveAction
| t_sprite
+
| t_link to [[#Actions|Actions]] (parent)
| Background sprite of the loading screen.
+
| Action which will be executed if the cursor leaves the interface (outside of polygon "Border").
| 353
+
| 388
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| StatusCover
 
| t_bool
 
| If false the status sprite will grow (from zero width to full width), if true the status sprite will shrink (from full width to zero width).
 
| 356
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|-
 +
| MatrixId
 +
| t_int
 +
|
 +
| 802
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Offset
 +
| t_point
 +
| Offset (or absolute position) for displaying the interface (only used if "Displacement" is 4 or 5).
 +
| 302
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| StatusSprite
+
| Position
| t_sprite
+
| t_point
| Sprite for progress bar.
+
| Absolute position of upper left corner of interface.
| 355
+
| 688
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V/S
 +
|-
 +
| ScrollStepSize
 +
| t_int
 +
| Defines how many item positions will be scrolled if a scroll arrow is pushed.
 +
| 138
 +
| class="cent" | <div class="tick"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
+
|-
 
+
| ShowAlways
 
+
| t_bool
== Objects ==
+
|
Table id: 6 <small>(eObjects)</small>
+
| 789
{| class="ts sortable"
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| Size
 +
| t_int
 +
| Defines the size of the interface (in pixels). Is needed if part of the interface is drawn into the scene (e.&nbsp;g. flowers on top of the interface) and the interface is aligned to the border. Is only used if > 0 and "Displacement" is 0, 1, 2 or 3.
 +
| 324
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
! style="width:15%" | Field
+
| Sprite
! style="width:15%" class="unsortable" | Type
+
| t_sprite
! class="unsortable" | Description
+
| Background sprite of the interface.
! style="width:3%" | id
+
| 238
! style="width:5%" class="unsortable" | Scriptable
 
! style="width:5%" class="unsortable" | Storage
 
|-
 
| Actions
 
| t_links to [[#Actions|Actions]] (parent)
 
| All actions of the object. "ExecutionType" defines when the action is started.
 
| 172
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Animation
+
| StandardCommand
| t_link to [[#Animations|Animations]]
+
| t_link to [[#Buttons|Buttons]]
| Animation which is automatically started if this object is active (see "Condition" and "Value").
+
| Button which is the standard command (usually "Walk to") for this interface.
| 171
+
| 298
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|-
 +
| TimeToDestVisibility
 +
| t_int
 +
| Defines the time (in milliseconds) until the visibility defined in "DestVisibility" is reached. This value is used the next time when "DestVisibility" is set.
 +
| 605
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| Animations
+
| Values
| t_links to [[#Animations|Animations]] (parent)
+
| t_links to [[#Values|Values]] (parent)
| All animations of the object.
+
| The values of the interface.
| 176
+
| 453
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| Center
 
| t_int
 
| Defines the line number (y coordinate) which decides if a character is in front or behind this object.
 
| 329
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| Condition
 
| t_link to [[#Conditions|Conditions]]
 
| If not empty then the object is only shown and detected by the cursor if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the object is active.
 
| 169
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| ConditionNegate
 
| t_bool
 
| If true then the condition linked under "Condition" is negated.
 
| 359
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| Conditions
 
| t_links to [[#Condition|Condition]] (parent)
 
| All conditions of the object.
 
| 175
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| DestVisibility
+
| Visibility
 
| t_int
 
| t_int
| The visibility of the object is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the object will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility".
+
| Visibility of the interface (and all of its buttons) in percent. Must be between 0 and 100. A value of 0 means the interface is not visible at all. Note that the interface can only be visible if "Active" and "Visible" are true.
| 601
+
| 603
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 +
|-
 +
| Visible
 +
| t_bool
 +
| If true the interface is visible - supposed "Visibility" is > 0. This option can be used to toggle the interface on/off without changing "Visibility".
 +
| 606
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|}
 +
 +
 +
== InterfaceClasses ==
 +
Table id: 31 <small>(eInterfaceClasses)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| Direction
+
! style="width:15%" | Field
| t_int
+
! style="width:15%" class="unsortable" | Type
| Direction in degrees which a character is aligned if it reaches this object ("Position").
+
! class="unsortable" | Description
| 222
+
! style="width:3%" | id
| class="cent" | <div class="cross"></div>
+
! style="width:5%" class="unsortable" | Scriptable
| class="cent" | V
+
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| IsItem
+
| Name
| t_bool
+
| t_string
| If true then this object is an item, otherwise it is a scene object.
+
| Interface class name. The name of the object itself will be set to the translated class name.
| 350
+
| 660
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
|-
 
| IsWalkable
 
| t_bool
 
| If true then then no action can be executed on this object with the standard command (see "Interface > StandardCommand").
 
| 384
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Languages ==
 +
Table id: 18 <small>(eLanguages)</small>
 +
 +
The language name is defined by the name of each language object.
 +
 +
 +
== Loadings ==
 +
Table id: 21 <small>(eLoadings)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| MatrixId
+
! style="width:15%" | Field
| t_int
+
! style="width:15%" class="unsortable" | Type
|  
+
! class="unsortable" | Description
| 792
+
! style="width:3%" | id
| class="cent" | <div class="cross"></div>
+
! style="width:5%" class="unsortable" | Scriptable
| class="cent" | S
+
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| Model
+
| Music
 
| t_path
 
| t_path
|  
+
| Music which is played while the loading screen is shown.
| 791
+
| 357
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Name
+
| Sprite
| t_link to [[#Texts|Texts]] (parent)
+
| t_sprite
| The name of the object (as shown in the action text).
+
| Background sprite of the loading screen.
| 251
+
| 353
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Offset
+
| StatusCover
| t_point
+
| t_bool
| Offset for this object from its initial position. By changing the offset it is possible to move the object on a scene. The object image and all object animations will take the offset into account. Detecting an object ("Polygon") by the cursor also considers the offset.
+
| If false the status sprite will grow (from zero width to full width), if true the status sprite will shrink (from full width to zero width).
| 779
+
| 356
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| ''ParticleSystem''
+
| StatusSprite
| ''t_link to [[#ParticleSystems|ParticleSystems]]''
+
| t_sprite
| ''DEPRECATED''
+
| Sprite for progress bar.
| 467
+
| 355
| class="cent" |
 
| class="cent" |
 
|-
 
| Polygon
 
| t_vpoint
 
| Polygon which defines the border of the object. The object is detected if the cursor is inside the polygon.
 
| 341
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Models ==
 +
Table id: 35 <small>(eModels)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| Position
+
| Model
| t_point
+
| t_path
| Position of the object on the scene (only used if "IsItem" is false). If the user clicked on this object then the current character walks to this position.
+
|  
| 339
+
| 706
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Rotation
+
| Textures
| t_float
+
| t_vpath
| Rotation for this object in radians (full rotation 2 pi, radian = degree * 180 / pi). The object image and all object animations will take the rotation into account.
+
|  
| 783
+
| 707
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Objects ==
 +
Table id: 6 <small>(eObjects)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| RotationCenter
+
! style="width:15%" | Field
| t_point
+
! style="width:15%" class="unsortable" | Type
| Coordinates (on screen) which define the center for object rotation (see "Rotation"). If set to -1,-1 (default) the image center is used as rotation center.
+
! class="unsortable" | Description
| 784
+
! style="width:3%" | id
| class="cent" | <div class="tick"></div>
+
! style="width:5%" class="unsortable" | Scriptable
| class="cent" | S
+
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| Scale
+
| Actions
| t_float
+
| t_links to [[#Actions|Actions]] (parent)
| Defines the scaling factor for this object. 1.0 means 100% (original size), 2.0 would be double size and 0.5 half size. The object image and all object animations will take the scaling into account.
+
| All actions of the object. "ExecutionType" defines when the action is started.
| 786
+
| 172
| class="cent" | <div class="tick"></div>
+
| class="cent" | <div class="cross"></div>
| class="cent" | S
+
| class="cent" | V
 
|-
 
|-
| ScaleX
+
| Animation
| t_float
+
| t_link to [[#Animations|Animations]]
| Factor for horizontal scaling of the button (100 is original width).
+
| Animation which is automatically started if this object is active (see "Condition" and "Value").
| 812
+
| 171
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| ScaleY
 
| t_float
 
| Factor for vertical scaling of the button (100 is original height).
 
| 812
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| ScrollFactorX
 
| t_int
 
| Horizontal scrolling-speed of this object in percent of screen's scrolling-speed (in %). If 100 then the object scrolls with same speed as the screen itself, otherwise it scrolls faster (> 100), slower (< 100) or not at all (0).
 
| 538
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ScrollFactorY
+
| Animations
| t_int
+
| t_links to [[#Animations|Animations]] (parent)
| Vertical scrolling-speed of this object in percent of screen's scrolling-speed (in %). If 100 then the object scrolls with same speed as the screen itself, otherwise it scrolls faster (> 100), slower (< 100) or not at all (0).
+
| All animations of the object.
| 539
+
| 176
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ShaderSet
+
| Center
 
| t_int
 
| t_int
| Sets shader configuration id for an object and all of its animations, see "shaderSetOptions()" command.
+
| Defines the line number (y coordinate) which decides if a character is in front or behind this object.
| 785
+
| 329
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
|-
 
| SnoopAnimation
 
| t_link to [[#Animations|Animations]]
 
| Animation which is shown when the snoop animations are active. The animation is only shown if the object is currently active. The snoop animations can be activated with an action part.
 
| 665
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SnoopAnimationPos
+
| Condition
| t_point
+
| t_link to [[#Conditions|Conditions]]
| Absolute position of the snoop animation (see "SnoopAnimation") on the scene.
+
| If not empty then the object is only shown and detected by the cursor if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the object is active.
| 666
+
| 169
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ConditionNegate
 +
| t_bool
 +
| If true then the condition linked under "Condition" is negated.
 +
| 359
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Sprite
+
| Conditions
| t_link to [[#Sprites|Sprites]] (parent)
+
| t_links to [[#Condition|Condition]] (parent)
| Sprite which is shown if the object is active.
+
| All conditions of the object.
| 170
+
| 175
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| TimeToDestVisibility
+
| DestVisibility
 
| t_int
 
| t_int
| Defines the time (in milliseconds) until the visibility defined in "DestVisibility" is reached. This value is used the next time when "DestVisibility" is set.
+
| The visibility of the object is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the object will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility".
| 602
+
| 601
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
| class="cent" | S
 
|-
 
|-
| Values
+
| Direction
| t_links to [[#Values|Values]] (parent)
+
| t_int
| All values of the object.
+
| Direction in degrees which a character is aligned if it reaches this object ("Position").
| 333
+
| 222
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Value
+
| IsItem
| t_link to [[#Values|Values]]
+
| t_bool
| If not empty then the object is only shown and detected by the cursor if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the object is active.
+
| If true then this object is an item, otherwise it is a scene object.
| 846
+
| 350
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ValueInt
+
| IsWalkable
| t_int
+
| t_bool
| Integer value for querying the value linked under "Value".
+
| If true then then no action can be executed on this object with the standard command (see "Interface > StandardCommand").
| 848
+
| 384
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ValueOperator
+
| MatrixId
 
| t_int
 
| t_int
| Operator for querying the value linked under "Value". Possible values:
+
|  
* 0: equals (=)
+
| 792
* 1: doesn't equal (!=)
 
* 2: equal or greater than (>=)
 
* 3: greater than (>)
 
* 4: equal or less than (<=)
 
* 5: less than (<)
 
| 847
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
| class="cent" | V
 
|-
 
| Visibility
 
| t_int
 
| Visibility of the object in percent. Must be between 0 and 100. A value of 0 means the object is not visible at all (but is still recognized by the cursor).
 
| 600
 
| class="cent" | <div class="tick"></div>
 
 
| class="cent" | S
 
| class="cent" | S
|}
 
 
 
== Outfits ==
 
Table id: 17 <small>(eOutfits)</small>
 
{| class="ts sortable"
 
 
|-
 
|-
! style="width:15%" | Field
+
| Model
! style="width:15%" class="unsortable" | Type
+
| t_path
! class="unsortable" | Description
+
|  
! style="width:3%" | id
+
| 791
! style="width:5%" class="unsortable" | Scriptable
+
| class="cent" | <div class="cross"></div>
! style="width:5%" class="unsortable" | Storage
+
| class="cent" | V
 
|-
 
|-
| AmbientLightColor
+
| Name
| t_int
+
| t_link to [[#Texts|Texts]] (parent)
| The ambient light color can be used to shade a 3D model with a basic color to adapt it to the lighting conditions in the surrounding scene.
+
| The name of the object (as shown in the action text).
| 729
+
| 251
| class="cent"  | <div class="tick"></div>
 
| class="cent"  | V/S
 
|-
 
| CameraAngle
 
| t_float
 
| This field sets the angle in degrees from which the camera shows each individual 3D model. By default, each model is shown from the front (0°), but the value range allows a model to be viewed from directly above (90°) or below (-90°).
 
| 711
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| CameraHeight
 
| t_float
 
| This field indicates the height of the camera relative to its 3D model. By default, the camera focuses on the center of the model, but the value range allows the camera to focus on the top (100 %) or bottom (-100 %) of the model.
 
| 710
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| CharacterAnimations
 
| t_links to [[#Animations|Animations]] (parent)
 
| Person animations, must be started manually.
 
| 269
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-  
+
|-
| CharacterSpeed
+
| Offset
| t_int
+
| t_point
| Speed of character with this outfit (in pixel per second).
+
| Offset for this object from its initial position. By changing the offset it is possible to move the object on a scene. The object image and all object animations will take the offset into account. Detecting an object ("Polygon") by the cursor also considers the offset.
| 270
+
| 779
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-  
+
|-
| LightColor
+
| ''ParticleSystem''
| t_int
+
| ''t_link to [[#ParticleSystems|ParticleSystems]]''
| The color (RGB, 1 byte per channel) of the direct light source used to shade a 3D model.
+
| ''DEPRECATED''
| 716
+
| 467
 +
| class="cent" |
 +
| class="cent" |
 +
|-
 +
| Polygon
 +
| t_vpoint
 +
| Polygon which defines the border of the object. The object is detected if the cursor is inside the polygon.
 +
| 341
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Position
 +
| t_point
 +
| Position of the object on the scene (only used if "IsItem" is false). If the user clicked on this object then the current character walks to this position.
 +
| 339
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Rotation
 +
| t_float
 +
| Rotation for this object in radians (full rotation 2 pi, radian = degree * 180 / pi). The object image and all object animations will take the rotation into account.
 +
| 783
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-  
+
|-
| LightPosX
+
| RotationCenter
 +
| t_point
 +
| Coordinates (on screen) which define the center for object rotation (see "Rotation"). If set to -1,-1 (default) the image center is used as rotation center.
 +
| 784
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Scale
 
| t_float
 
| t_float
| The first coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows.
+
| Defines the scaling factor for this object. 1.0 means 100% (original size), 2.0 would be double size and 0.5 half size. The object image and all object animations will take the scaling into account.
| 713
+
| 786
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-  
+
|-
| LightPosY
+
| ScaleX
 
| t_float
 
| t_float
| The second coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows.
+
| Factor for horizontal scaling of the button (100 is original width).
| 714
+
| 812
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-  
+
|-
| LightPosZ
+
| ScaleY
 
| t_float
 
| t_float
| The third coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows.
+
| Factor for vertical scaling of the button (100 is original height).
| 715
+
| 812
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-  
+
|-
| LightColor
+
| ScrollFactorX
 
| t_int
 
| t_int
|  
+
| Horizontal scrolling-speed of this object in percent of screen's scrolling-speed (in %). If 100 then the object scrolls with same speed as the screen itself, otherwise it scrolls faster (> 100), slower (< 100) or not at all (0).
| 716
+
| 538
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ScrollFactorY
 +
| t_int
 +
| Vertical scrolling-speed of this object in percent of screen's scrolling-speed (in %). If 100 then the object scrolls with same speed as the screen itself, otherwise it scrolls faster (> 100), slower (< 100) or not at all (0).
 +
| 539
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ShaderSet
 +
| t_int
 +
| Sets shader configuration id for an object and all of its animations, see "shaderSetOptions()" command.
 +
| 785
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
 
|-
 
|-
| Model
+
| SnoopAnimation
| t_path
+
| t_link to [[#Animations|Animations]]
| Path to the 3D model file used for the outfit.
+
| Animation which is shown when the "hotspot" (formerly known as "snoop") animations are active. The animation is only shown if the object is currently active. The "hotspot" animations can be activated with an action part.
| 708
+
| 665
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ModelAmbientOcclusion
+
| SnoopAnimationPos
| t_int
+
| t_point
| This field controls the intensity of self-shadowing of a 3D model in percent using ambient occlusion. A value of 0 deactivates ambient occlusion.
+
| Absolute position of the "hotspot" (formerly known as "snoop") animation (see "SnoopAnimation") on the scene.
| 752
+
| 666
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ModelFiles
+
| Sprite
| t_vpath
+
| t_link to [[#Sprites|Sprites]] (parent)
|  
+
| Sprite which is shown if the object is active.
| 807
+
| 170
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| ModelOutlineColor
+
| TimeToDestVisibility
 
| t_int
 
| t_int
| The color used for the contours of 3D models.
+
| Defines the time (in milliseconds) until the visibility defined in "DestVisibility" is reached. This value is used the next time when "DestVisibility" is set.
| 724
+
| 602
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
|-
 
| ModelOutlineWidth
 
| t_int
 
| The width of contours of 3D models.
 
| 725
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| ModelScaleFactor
 
| t_int
 
| The size of the displayed 3D model in percent. This field can be used to finetune the size or a model in the scene without changing the 3D model file.
 
| 718
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| ModelShadow
+
| Values
| t_int
+
| t_links to [[#Values|Values]] (parent)
| Indicates what type of shadow a 3D model casts. This can be either a simple blob shadow (1) or a realistic projected shadow (2). The value 0 disables shadows. Shadows are always cast straight downwards.
+
| All values of the object.
| 751
+
| 333
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ModelShadowVisibility
+
| Value
| t_int
+
| t_link to [[#Values|Values]]
| This field controls the visibility of the shadow of a 3D model in percent. A value of 0 deactivates shadows.
+
| If not empty then the object is only shown and detected by the cursor if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the object is active.
| 750
+
| 846
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-  
+
|-
| ModelShowOutline
+
| ValueInt
| t_bool
+
| t_int
| This flag indicates whether outlines of a 3D model are drawn.
+
| Integer value for querying the value linked under "Value".
| 723
+
| 848
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| ModelTextures
 
| t_vpath
 
| This field contains a list of texture paths used to draw a 3D model. This can be used to override the texture information stored in the 3D model file.
 
| 728
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| ModelToonNuances
 
| t_int
 
| Number of nuances of brightness used for toon shading. Using a relatively low number (2-5) creates more cartoon-like lighting of a 3D model.
 
| 722
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| ModelTurnSpeed
+
| ValueOperator
 
| t_int
 
| t_int
|  
+
| Operator for querying the value linked under "Value". Possible values:
| 867
+
* 0: equals (=)
 +
* 1: doesn't equal (!=)
 +
* 2: equal or greater than (>=)
 +
* 3: greater than (>)
 +
* 4: equal or less than (<=)
 +
* 5: less than (<)
 +
| 847
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| ModelUseToonShading
+
| Visibility
| t_bool
+
| t_int
| This flag indicates whether toon shading is used for a 3D model. The alternative is realistic shading.
+
| Visibility of the object in percent. Must be between 0 and 100. A value of 0 means the object is not visible at all (but is still recognized by the cursor).
| 721
+
| 600
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
| class="cent" | V/S
+
| class="cent" | S
 +
|}
 +
 
 +
 
 +
== Outfits ==
 +
Table id: 17 <small>(eOutfits)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| RandomAnimations
+
! style="width:15%" | Field
| t_links to [[#Animation|Animation]] (parent)
+
! style="width:15%" class="unsortable" | Type
|
+
! class="unsortable" | Description
* For playable characters (characters with an interface): Animations are shown if the user did not interact for a longer random time span (between "RandomMinTime" and "RandomMaxTime" milliseconds).
+
! style="width:3%" | id
* For non-playable characters (characters without an interface): Animations are shown after a random time span (between "RandomMinTime" and "RandomMaxTime" milliseconds).
+
! style="width:5%" class="unsortable" | Scriptable
| 321
+
! style="width:5%" class="unsortable" | Storage
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
 
|-
 
|-
| RandomMinTime
+
| AmbientLightColor
 
| t_int
 
| t_int
| Minimum time (in milliseconds) until a random animation (see "RandomAnimations") is started.
+
| The ambient light color can be used to shade a 3D model with a basic color to adapt it to the lighting conditions in the surrounding scene.
| 756
+
| 729
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | V/S
|-
+
|-  
| RandomMaxTime
+
| CameraAngle
| t_int
+
| t_float
| Maximum time (in milliseconds) until a random animation (see "RandomAnimations") is started.
+
| This field sets the angle in degrees from which the camera shows each individual 3D model. By default, each model is shown from the front (), but the value range allows a model to be viewed from directly above (90°) or below (-90°).
| 757
+
| 711
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | V/S
|-
+
|-  
| SlideWalkAnimation
+
| CameraHeight
| t_bool
+
| t_float
| If true the character position will be updated continuously during walking, otherwise the position will only be updated if a new frame of the walk animation is shown.
+
| This field indicates the height of the camera relative to its 3D model. By default, the camera focuses on the center of the model, but the value range allows the camera to focus on the top (100 %) or bottom (-100 %) of the model.
| 762
+
| 710
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
 
|-
 
|-
| StandingAnimations
+
| CharacterAnimations
 
| t_links to [[#Animations|Animations]] (parent)
 
| t_links to [[#Animations|Animations]] (parent)
| Standing animations, shown when person is standing.
+
| Person animations, must be started manually.
| 383
+
| 269
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|-  
| TalkAnimations
+
| CharacterSpeed
| t_links to [[#Animations|Animations]] (parent)
+
| t_int
| Talk animations.
+
| Speed of character with this outfit (in pixel per second).
| 268
+
| 270
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | V/S
|-
+
|-
| TurnAnimations
+
| LightColor
| t_links to [[#Animations|Animations]] (parent)
+
| t_int
| Turn animations.
+
| The color (RGB, 1 byte per channel) of the direct light source used to shade a 3D model.
| 810
+
| 716
| class="cent" | <div class="cross"></div>
+
| class="cent" | <div class="tick"></div>
| class="cent" | V
+
| class="cent" | V/S
|-
+
|-  
| UseLight
+
| LightPosX
| t_bool
+
| t_float
 +
| The first coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows.
 +
| 713
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| LightPosY
 +
| t_float
 +
| The second coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows.
 +
| 714
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| LightPosZ
 +
| t_float
 +
| The third coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows.
 +
| 715
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-  
 +
| LightColor
 +
| t_int
 
|  
 
|  
| 712
+
| 716
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
 
|-
 
|-
| WalkAnimations
+
| Model
| t_links to [[#Animations|Animations]] (parent)
+
| t_path
| Walk animations.
+
| Path to the 3D model file used for the outfit.
| 267
+
| 708
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
 
 
 
== ParticleContainers ==
 
Table id: 23 <small>(eParticleContainers)</small>
 
{| class="ts sortable"
 
 
|-
 
|-
! style="width:15%" | Field
+
| ModelAmbientOcclusion
! style="width:15%" class="unsortable" | Type
+
| t_int
! class="unsortable" | Description
+
| This field controls the intensity of self-shadowing of a 3D model in percent using ambient occlusion. A value of 0 deactivates ambient occlusion.
! style="width:3%" | id
+
| 752
! style="width:5%" class="unsortable" | Scriptable
+
| class="cent" | <div class="cross"></div>
! style="width:5%" class="unsortable" | Storage
+
| class="cent" | V
 
|-
 
|-
| ''CameraZoom''
+
| ModelFiles
| ''t_float''
+
| t_vpath
| ''DEPRECATED''
+
|  
|
+
| 807
| class="cent" |  
+
| class="cent" | <div class="cross"></div>
| class="cent" |  
+
| class="cent" | V
|-
+
|-
| ''CameraZPosition''
+
| ModelOutlineColor
| ''t_float''
+
| t_int
| ''DEPRECATED''
+
| The color used for the contours of 3D models.
|
+
| 724
| class="cent" |  
+
| class="cent" | <div class="tick"></div>
| class="cent" |  
+
| class="cent" | V/S
 +
|-  
 +
| ModelOutlineWidth
 +
| t_int
 +
| The width of contours of 3D models.
 +
| 725
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| ModelScaleFactor
 +
| t_int
 +
| The size of the displayed 3D model in percent. This field can be used to finetune the size or a model in the scene without changing the 3D model file.
 +
| 718
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| ''LeadTime''
+
| ModelShadow
| ''t_links to [[#Particles|Particles]] (parent)''
+
| t_int
| ''DEPRECATED''
+
| Indicates what type of shadow a 3D model casts. This can be either a simple blob shadow (1) or a realistic projected shadow (2). The value 0 disables shadows. Shadows are always cast straight downwards.
|
+
| 751
| class="cent" |  
+
| class="cent" | <div class="cross"></div>
| class="cent" |  
+
| class="cent" | V
 
|-
 
|-
| ''Particles''
+
| ModelShadowVisibility
| ''t_links to [[#Particles|Particles]] (parent)''
+
| t_int
| ''DEPRECATED''
+
| This field controls the visibility of the shadow of a 3D model in percent. A value of 0 deactivates shadows.
|
+
| 750
| class="cent" |  
+
| class="cent" | <div class="cross"></div>
| class="cent" |  
+
| class="cent" | V
 +
|-
 +
| ModelShowOutline
 +
| t_bool
 +
| This flag indicates whether outlines of a 3D model are drawn.
 +
| 723
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| PreviewScene
+
| ModelTextures
| t_link to [[#Scenes|Scenes]]
+
| t_vpath
| Scene for particles preview.
+
| This field contains a list of texture paths used to draw a 3D model. This can be used to override the texture information stored in the 3D model file.
| 824
+
| 728
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|-
 +
| ModelToonNuances
 +
| t_int
 +
| Number of nuances of brightness used for toon shading. Using a relatively low number (2-5) creates more cartoon-like lighting of a 3D model.
 +
| 722
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| Settings
+
| ModelTurnSpeed
| t_string
+
| t_int
| Particle system settings.
+
|  
| 806
+
| 867
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
+
|-
 
+
| ModelUseToonShading
 
+
| t_bool
== Particles ==
+
| This flag indicates whether toon shading is used for a 3D model. The alternative is realistic shading.
Table id: 22 <small>(eParticles)</small>
+
| 721
 
+
| class="cent" | <div class="tick"></div>
''DEPRECATED''
+
| class="cent" | V/S
 
 
 
 
== Points ==
 
Table id: 5 <small>(ePoints)</small>
 
{| class="ts sortable"
 
 
|-
 
|-
! style="width:15%" | Field
+
| RandomAnimations
! style="width:15%" class="unsortable" | Type
+
| t_links to [[#Animation|Animation]] (parent)
! class="unsortable" | Description
+
|
! style="width:3%" | id
+
* For playable characters (characters with an interface): Animations are shown if the user did not interact for a longer random time span (between "RandomMinTime" and "RandomMaxTime" milliseconds).
! style="width:5%" class="unsortable" | Scriptable
+
* For non-playable characters (characters without an interface): Animations are shown after a random time span (between "RandomMinTime" and "RandomMaxTime" milliseconds).
! style="width:5%" class="unsortable" | Storage
+
| 321
|-
 
| Position
 
| t_point
 
| Position on the scene.
 
| 146
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Relations
+
| RandomMinTime
| t_links to [[#Points|Points]]
+
| t_int
| Links to connected points for way system.
+
| Minimum time (in milliseconds) until a random animation (see "RandomAnimations") is started.
| 147
+
| 756
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| Size
+
| RandomMaxTime
 
| t_int
 
| t_int
| Size for character on this point (in percent).
+
| Maximum time (in milliseconds) until a random animation (see "RandomAnimations") is started.
| 145
+
| 757
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
 
 
== Scene ==
 
{| class="ts"
 
 
|-
 
|-
! style="width:10%; | Field !! style="width:10%;" | Type !! Description !! style="width:5%;" | Scriptable !! style="width:5%;" | Storage
+
| SlideWalkAnimation
 +
| t_bool
 +
| If true the character position will be updated continuously during walking, otherwise the position will only be updated if a new frame of the walk animation is shown.
 +
| 762
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| SceneActions
+
| StandingAnimations
| t_links to [[#Actions|Actions]] (parent)
+
| t_links to [[#Animations|Animations]] (parent)
| All actions of the scene. These actions can only be started by another action.
+
| Standing animations, shown when person is standing.
 +
| 383
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SceneActionAreas
+
| TalkAnimations
| t_links to [[#ActionArea|ActionArea]] (parent)
+
| t_links to [[#Animations|Animations]] (parent)
| All action areas of the scene (areas which contain actions that are executed if a character enters or leaves the area).
+
| Talk animations.
 +
| 268
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
 
| SceneBackgroundMusic
 
| t_path
 
| Background music which is played in a loop.
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| SceneBrightness
 
| t_int
 
| Defines the overall brightness of the scene (in %). Must be between '0' and '100'. '0' means this scene (with all its objects and characters) is completely dark (so everything is black), '100' means  that everything is drawn with its original brightness (default).
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | S
 
 
|-
 
|-
| SceneConditions
+
| TurnAnimations
| t_links to [[#Condition|Condition]] (parent)
+
| t_links to [[#Animations|Animations]] (parent)
| All conditions of the scene.
+
| Turn animations.
 +
| 810
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SceneContinueMusic
+
| UseLight
 
| t_bool
 
| t_bool
| If true then the background music from the last scene is continued instead of playing the background music of this scene (SceneBackgroundMusic).
+
|  
| class="cent" | <div class="cross"></div>
+
| 712
| class="cent" | V
 
|-
 
| SceneCurrentWaySystem
 
| t_link to [[#WaySystem|WaySystem]]
 
| Currently used way system (only relevant if SceneIsMenu is false).
 
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
 
|-
 
|-
| SceneCursor
+
| WalkAnimations
| t_link to [[#Cursor|Cursor]]
+
| t_links to [[#Animations|Animations]] (parent)
| Cursor which is displayed on this scene (only used if SceneIsMenu is true).
+
| Walk animations.
 +
| 267
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|-
+
|}
| SceneLightMap
+
 
| t_path
+
 
| Sprite which is used as a lightmap for the scene. The lightmap defines how the characters are shaded on different positions on the scene.
+
== ParticleContainers ==
| class="cent" | <div class="tick"></div>
+
Table id: 23 <small>(eParticleContainers)</small>
| class="cent" | V/S
+
{| class="ts sortable"
 
|-
 
|-
| SceneIsMenu
+
! style="width:15%" | Field
| t_bool
+
! style="width:15%" class="unsortable" | Type
| If true then this scene is a menu (for savegames, options, etc.) otherwise it is a playable scene (where characters can move, etc.).
+
! class="unsortable" | Description
| class="cent" | <div class="cross"></div>
+
! style="width:3%" | id
| class="cent" | V
+
! style="width:5%" class="unsortable" | Scriptable
|-
+
! style="width:5%" class="unsortable" | Storage
| SceneMusicBalance
 
| t_int
 
| Balance of the background music (SceneBackgroundMusic). Must be between '-100' (only left speaker) and '100' (only right speaker).
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
|-
 
| SceneMusicVolume
 
| t_int
 
| Volume of the background music (SceneBackgroundMusic). Must be between '0' (mute) and '100' (full volume).
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
| SceneName
+
| ''CameraZoom''
| t_link to [[#Text|Text]] (parent)
+
| ''t_float''
| The name of the scene (used for name in savegames).
+
| ''DEPRECATED''
| class="cent" | <div class="cross"></div>
+
|
| class="cent" | V
+
| class="cent" |  
 +
| class="cent" |  
 
|-
 
|-
| SceneObjects
+
| ''CameraZPosition''
| t_links to [[#Object|Object]] (parent)
+
| ''t_float''
| All objects of the scene.
+
| ''DEPRECATED''
| class="cent" | <div class="cross"></div>
+
|
| class="cent" | V
+
| class="cent" |  
 +
| class="cent" |  
 
|-
 
|-
| SceneParticleSystem
+
| ''LeadTime''
| t_link to [[#ParticleContainer|ParticleContainer]]
+
| ''t_links to [[#Particles|Particles]] (parent)''
| Particle system of the scene which is always shown.
+
| ''DEPRECATED''
| class="cent" | <div class="cross"></div>
+
|
| class="cent" | V
+
| class="cent" |  
 +
| class="cent" |  
 
|-
 
|-
| SceneSavegameAreas
+
| ''Particles''
| t_vrect
+
| ''t_links to [[#Particles|Particles]] (parent)''
| All areas where savegame screenshots are shown. A savegame can be selected by clicking inside an area.
+
| ''DEPRECATED''
| class="cent" | <div class="cross"></div>
+
|
| class="cent" | V
+
| class="cent" |  
 +
| class="cent" |  
 
|-
 
|-
| SceneSavegameFont
+
| PreviewScene
| t_link to [[#Font|Font]]
+
| t_link to [[#Scenes|Scenes]]
| Font which is used for the name of the savegame.
+
| Scene for particles preview.
 +
| 824
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SceneSavegameScreenshot
+
| Settings
| t_path
+
| t_string
| Image used as savegame screenshot for this scene when game is played on a mobile device.
+
| Particle system settings.
 +
| 806
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 +
|}
 +
 +
 +
== Particles ==
 +
Table id: 22 <small>(eParticles)</small>
 +
 +
''DEPRECATED''
 +
 +
 +
== Plugins ==
 +
Table id: 39 <small>(ePlugins)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| SceneSavegameScrollStep
+
! style="width:15%" | Field
| t_int
+
! style="width:15%" class="unsortable" | Type
| Defines how many savegame positions will be scrolled if the savegames are scrolled with an actionpart.
+
! class="unsortable" | Description
| class="cent" | <div class="cross"></div>
+
! style="width:3%" | id
| class="cent" | V
+
! style="width:5%" class="unsortable" | Scriptable
|-
+
! style="width:5%" class="unsortable" | Storage
| SceneScrollableArea
 
| t_rect
 
| Usually the scene can be scrolled to the edge in each direction. This area can limit the scrolling in each direction so the scene can not be scrolled to the edge.
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
 
|-
 
|-
|-
+
| Active
| SceneScrollOnEdges
 
 
| t_bool
 
| t_bool
| If true then the scene will be scrolled if the cursor is on the screen edge.
+
|  
| class="cent" | <div class="tick"></div>
+
| 860
| class="cent" | V/S
 
|-
 
| SceneSprite
 
| t_sprite
 
| Background sprite of the scene.
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SceneValues
+
| Data
| t_links to [[#Value|Value]] (parent)
+
| t_string
| All values of the scene.
+
|  
 +
| 862
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| SceneWaySystems
+
| Directory
| t_links to [[#WaySystem|WaySystem]] (parent)
+
| t_string
| All way systems of the scene.
+
|  
 +
| 861
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|}
 
|}
  
== Script ==
+
 
{| class="ts"
+
== Points ==
|-
+
Table id: 5 <small>(ePoints)</small>
! style="width:10%; | Field !! style="width:10%;" | Type !! Description !! style="width:5%;" | Scriptable !! style="width:5%;" | Storage
+
{| class="ts sortable"
 
|-
 
|-
| ScriptScript
+
! style="width:15%" | Field
| t_string
+
! style="width:15%" class="unsortable" | Type
| Script content.
+
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Position
 +
| t_point
 +
| Position on the scene.
 +
| 146
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
 
 
== Sprite ==
 
{| class="ts"
 
 
|-
 
|-
! style="width:10%; | Field !! style="width:10%;" | Type !! Description !! style="width:5%;" | Scriptable !! style="width:5%;" | Storage
+
| Relations
|-
+
| t_links to [[#Points|Points]]
| SpriteSprite
+
| Links to connected points for way system.
| t_sprite
+
| 147
| -
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
|}
 
 
== Text ==
 
{| class="ts"
 
 
|-
 
|-
! style="width:10%; | Field !! style="width:10%;" | Type !! Description !! style="width:5%;" | Scriptable !! style="width:5%;" | Storage
+
| Size
|-
+
| t_int
| TextTextLanguages
+
| Size for character on this point (in percent).
| t_vtext
+
| 145
| Language dependent texts for this text entry.
 
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|}
 
|}
  
== Value ==
+
 
{| class="ts"
+
== Scenes ==
 +
Table id: 4 <small>(eScenes)</small>
 +
{| class="ts sortable"
 
|-
 
|-
! style="width:10%; | Field !! style="width:10%;" | Type !! Description !! style="width:5%;" | Scriptable !! style="width:5%;" | Storage
+
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 
|-
 
|-
| ValueInt
+
| Actions
 +
| t_links to [[#Actions|Actions]] (parent)
 +
| All actions of the scene. These actions can only be started by another action.
 +
| 335
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ActionAreas
 +
| t_links to [[#ActionAreas|ActionAreas]] (parent)
 +
| All action areas of the scene (areas which contain actions that are executed if a character enters or leaves the area).
 +
| 681
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| AudioBusses
 +
| t_links to [[#AudioBusses|AudioBusses]]
 +
|
 +
| 838
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| BackgroundMusic
 +
| t_path
 +
| Background music which is played in a loop.
 +
| 132
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| Brightness
 
| t_int
 
| t_int
| The current integer value.
+
| Defines the overall brightness of the scene (in percent). Must be between 0 and 100. A velue of 0 means this scene (with all its objects and characters) is completely dark (so everything is black), 100 means that everything is drawn with its original brightness.
| class="cent" | <div class="tick"></div>
+
| 594
| class="cent" | V/S
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| ValueRandom
+
| CDTrack
| t_bool
+
| t_int
| If true then the value (ValueInt) will be set to a random value (between ValueRandomMin and ValueRandomMax) at the beginning of the game.
+
|  
 +
| 133
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ValueRandomMax
+
| Conditions
| t_int
+
| t_links to [[#Conditions|Conditions]] (parent)
| Upper bound for random value (see ValueRandom).
+
| All conditions of the scene.
 +
| 330
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| ValueRandomMin
+
| ContinueMusic
| t_int
+
| t_bool
| Lower bound for random value (see ValueRandom).
+
| If true then the background music from the last scene is continued instead of playing the background music of this scene ("BackgroundMusic").
 +
| 365
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-  
 
|-  
| ValueString
+
| CurrentWaySystem
| t_string
+
| t_link to [[#WaySystems|WaySystems]]
| The current string value.
+
| Currently used way system (only relevant if "IsMenu" is false).
 +
| 641
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | <div class="tick"></div>
 
| class="cent" | V/S
 
| class="cent" | V/S
|}
 
 
== WaySystem ==
 
{| class="ts"
 
 
|-
 
|-
! style="width:10%; | Field !! style="width:10%;" | Type !! Description !! style="width:5%;" | Scriptable !! style="width:5%;" | Storage
+
| Cursor
 +
| t_link to [[#Cursors|Cursors]]
 +
| Cursor which is displayed on this scene (only used if "IsMenu" is true).
 +
| 293
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| WaySystemBorder
+
| Curves
 +
| t_links to [[#Curves|Curves]]
 +
|
 +
| 892
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| LightMap
 +
| t_path
 +
| Sprite which is used as a lightmap for the scene. The lightmap defines how the characters are shaded on different positions on the scene.
 +
| 550
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| IsMenu
 +
| t_bool
 +
| If true then this scene is a menu (for savegames, options, etc.), otherwise it is a playable scene (where characters can move, etc.).
 +
| 292
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| MusicBalance
 +
| t_int
 +
| Balance of the background music ("BackgroundMusic"). Must be between -100 (only left speaker) and 100 (only right speaker).
 +
| 316
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| MusicVolume
 +
| t_int
 +
| Volume of the background music ("BackgroundMusic"). Must be between 0 (mute) and 100 (full volume).
 +
| 315
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| Name
 +
| t_link to [[#Texts|Texts]] (parent)
 +
| The name of the scene (used for name in savegames).
 +
| 364
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Objects
 +
| t_links to [[#Objects|Objects]] (parent)
 +
| All objects of the scene.
 +
| 136
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ParticleSystem
 +
| t_link to [[#ParticleContainers|ParticleContainers]]
 +
| Particle system of the scene which is always shown.
 +
| 441
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| SavegameAreas
 +
| t_vrect
 +
| All areas where savegame screenshots are shown (only if "IsMenu" is true). A savegame can be selected by clicking inside an area.
 +
| 322
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| SavegameFont
 +
| t_link to [[#Font|Font]]
 +
| Font which is used for the name of the savegame (only if "IsMenu" is true).
 +
| 348
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| SavegameScreenshot
 +
| t_path
 +
| Image used as savegame screenshot for this scene when game is played on a mobile device.
 +
| 765
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| SavegameScrollStep
 +
| t_int
 +
| Defines how many savegame positions will be scrolled if the savegames are scrolled with an actionpart (only if "IsMenu" is true).
 +
| 323
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| SaveTextAlignment
 +
| t_int
 +
| Defines the alignment of the timestamp text underneath the savegames (only if "IsMenu" is true). Possible Values:
 +
* 0: Left.
 +
* 1: Right.
 +
* 2: Center.
 +
| 930
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| SaveTextOffset
 +
| t_point
 +
| Defines the offset of the timestamp text underneath the savegames from its default location (only if "IsMenu" is true).
 +
| 929
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| ScrollableArea
 +
| t_rect
 +
| Usually the scene can be scrolled to the edge in each direction. This area can limit the scrolling in each direction so the scene can not be scrolled to the edge.
 +
| 568
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| ScrollOnEdges
 +
| t_bool
 +
| If true then the scene will be scrolled if the cursor is on the screen edge.
 +
| 232
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| ShaderSet
 +
| t_int
 +
| Sets shader configuration id for the scene, see "shaderSetOptions()" command.
 +
| 794
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Sprite
 +
| t_sprite
 +
| Background sprite of the scene.
 +
| 236
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| TestCharacter
 +
| t_link to [[#Characters|Characters]]
 +
|
 +
| 879
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Values
 +
| t_links to [[#Values|Values]] (parent)
 +
| All values of the scene.
 +
| 332
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| WaySystems
 +
| t_links to [[#WaySystems|WaySystems]] (parent)
 +
| All way systems of the scene.
 +
| 640
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Scripts ==
 +
Table id: 30 <small>(eScripts)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Script
 +
| t_string
 +
| Script content.
 +
| 652
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Type
 +
| t_string
 +
| Script type. Possible Values:
 +
* 0: Execution script.
 +
* 1: Definition script.
 +
| 653
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== ScriptVariables ==
 +
Table id: 34 <small>(eScriptVariables)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| IsGlobalVar
 +
| t_bool
 +
|
 +
| 697
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| Items
 +
| t_links
 +
|
 +
| 698
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| KeyType
 +
| t_int
 +
|
 +
| 694
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| Value
 +
| t_string
 +
|
 +
| 696
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| ValueType
 +
| t_int
 +
|
 +
| 695
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|}
 +
 
 +
 
 +
== Shaders ==
 +
Table id: 36 <small>(eShaders)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Compiled
 +
| t_string
 +
|
 +
| 823
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| FS
 +
| t_string
 +
|
 +
| 821
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| VS
 +
| t_string
 +
|
 +
| 822
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Sprites ==
 +
Table id: 13 <small>(eSprites)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Sprite
 +
| t_sprite
 +
|
 +
| 237
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Texts ==
 +
Table id: 14 <small>(eTexts)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| TextLanguages
 +
| t_vtext
 +
| Language-dependent texts for this text entry.
 +
| 761
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== TextLanguages ==
 +
Table id: 19 <small>(eTextLanguages)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Language
 +
| t_link to [[#Languages|Languages]]
 +
|
 +
| 258
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Sound
 +
| t_path
 +
|
 +
| 257
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Text
 +
| t_string
 +
|
 +
| 256
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Values ==
 +
Table id: 20 <small>(eValues)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Float
 +
| t_float
 +
| The current float value.
 +
| 805
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| Int
 +
| t_int
 +
| The current integer value.
 +
| 328
 +
| class="cent"  | <div class="tick"></div>
 +
| class="cent"  | V/S
 +
|-
 +
| Random
 +
| t_bool
 +
| If true then the value ("Int") will be set to a random value (between "RandomMin" and "RandomMax") at the beginning of the game.
 +
| 345
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| RandomMax
 +
| t_int
 +
| Upper bound for random value (see "Random").
 +
| 347
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| RandomMin
 +
| t_int
 +
| Lower bound for random value (see "Random").
 +
| 346
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| String
 +
| t_string
 +
| The current string value.
 +
| 632
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|}
 +
 
 +
 
 +
== WaySystems ==
 +
Table id: 29 <small>(eWaySystems)</small>
 +
{| class="ts sortable"
 +
|-
 +
! style="width:15%" | Field
 +
! style="width:15%" class="unsortable" | Type
 +
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Border
 
| t_vpoint
 
| t_vpoint
| Polygon which defines the wayborders of the scene. A character is only allowed to walk inside the wayborders.
+
| Polygon which defines the way borders of the scene. A character is only allowed to walk inside the way borders.
 +
| 638
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|-
 
|-
| WaySystemPoints
+
| Points
| t_links to [[#Point|Point]] (parent)
+
| t_links to [[#Points|Points]] (parent)
| Waypoints of the scene which store the character size. The waypoints are connected to each other to define where a character can walk.
+
| Way points of the scene which store the character size. The way points are connected to each other to define where a character can walk.
 +
| 639
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | <div class="cross"></div>
 
| class="cent" | V
 
| class="cent" | V
 
|}
 
|}
 
{{toc}}
 
{{toc}}

Latest revision as of 16:41, 13 August 2024

The Visionaire data structure consists of different tables (storing different types of objects) saved in an XML project file (.ved) on disk. Not all fields in this documentation are stored in the project files though, some of them are only created during the game and stored in the savegames. The Storage column describes where each field is saved. A field with Storage V is saved in the .ved file, a field with Storage S is stored in savegames.

Every field is accessible through scripting, can be read from or written to. However, in practice it does not make sense to edit the majority of them, because the Visionaire Player does not react to all changes (without first reloading the scene) and certain fields are not stored into the savegame files. For this purpose there is a column Scriptable next to each field, which indicates whether or not the field can be manipulated through code.

Please note that the information on whether a field is scriptable may not be 100% accurate. If it is marked as scriptable, it usually is. If it is marked as not scriptable, it may be nonetheless though. Feel free to try things out.

The tables starting with Active contain dynamically created objects. For example all actions are stored in the "Actions" table but once an action gets executed an object in "ActiveActions" will be created where the currently active action is stored.


For information on the field types and on how to access the data structure through scripting, please refer to the basic scripting page.


Actions

Table id: 7 (eActions)

Field Type Description id Scriptable Storage
ActionParts t_links to ActionParts (parent) Action parts of this action. The action parts will be executed if this action is started. 162
V
Command t_link to Buttons Command which must be active to execute this action. 161
V
ExecutionType t_int Defines when the action is started. Possible values:
  • 0 (eExecutionTypeRightMouseClick): Right mouse button click.
  • 1 (eExecutionTypeMouseEntersArea): Cursor enters area.
  • 2 (eExecutionTypeMouseLeavesArea): Cursor leaves area.
  • 3 (eExecutionTypeFixtureDropped): Item dropped.
  • 5 (eExecutionTypeCalledByOtherAction): Called by other action.
  • 6 (eExecutionTypeActionCommand): Command executed.
  • 7 (eExecutionTypeLeftMouseClickIm): Left mouse click.
  • 8: Character reached object.
  • 12 (eExecutionTypeLeftMouseDblClick): Left mouse button double click.
  • 13 (eExecutionTypeLeftMouseDblClickIm): Left mouse button double click (immediate execution).
  • 14 (eExecutionTypeLeftMouseHold): Left mouse button hold.
  • 15 (eExecutionTypeLeftMouseHoldIm): Left mouse button hold (immediate execution).
  • 16 (eExecutionTypeRightMouseClickIm): Right mouse button click (immediate execution).
  • 17 (eExecutionTypeActionCommandIm): Command executed (immediate execution).
  • 18 (eExecutionTypeCommandMouseClickIm): Command mouse click (immediate execution).
  • 19 (eExecutionTypeCombinedCommandMouseClickIm): Combined command mouse click (immediate execution).
  • 20 (eExecutionTypeFixtureDroppedIm): Item dropped (immediate execution).
  • 21 (eExecutionTypeActionCommandBoth): Command executed - both.
  • 22 (eExecutionTypeActionCommandImBoth): Command executed - both (immediate execution).
  • 23 (eExecutionTypeActionCommandOther): Command executed - other.
  • 24 (eExecutionTypeActionCommandImOther): Command executed - other (immediate execution).
  • 25 (eExecutionTypeFixtureDroppedBoth): Item dropped - both.
  • 26 (eExecutionTypeFixtureDroppedImBoth): Item dropped - both (immediate execution).
  • 27 (eExecutionTypeFixtureDroppedOther): Item dropped - other.
  • 28 (eExecutionTypeFixtureDroppedImOther): Item dropped - other (immediate execution).
  • 29: Character enters area.
  • 30: Character leaves area.
  • 31 (eAtBeginningOfScene): At beginning of scene.
  • 32 (eAtEndOfScene): At end of scene.
159
V
Fixture t_link to Objects Item which is necessary to execute this action. 160
V


ActionAreas

Table id: 32 (eActionAreas)

Field Type Description id Scriptable Storage
Actions t_links to AreaActions (parent) The actions which will be executed if a character enters or leaves the action area. 675
V
Polygon t_vpoint Polygon which defines the border of this action area. If a character enters or leaves this polygon, the actions linked from the "Actions" field are executed. 674
V


ActionParts

Table id: 8 (eActionParts)

Field Type Description id Scriptable Storage
AltInt t_int Integer parameter #2 of the action part. The content of this parameter (and if it is used at all) depends on the action part type as defined in the "Command" field. 290
V
AltInt2 t_int Integer parameter #3 of the action part. The content of this parameter (and if it is used at all) depends on the action part type as defined in the "Command" field. 591
V
AltLink t_link (parent if link to Texts) Link parameter #2 of the action part. The content of this parameter (and if it is used at all) depends on the action part type as defined in the "Command" field. 290
V
Command t_int Action part type (constant number). See Actionparts Documentation for all action part types. 179
V
Int t_int Integer parameter #1 of the action part. The content of this parameter (and if it is used at all) depends on the action part type as defined in the "Command" field. 242
V
Link t_link (parent if link to Texts) Link parameter #1 of the action part. The content of this parameter (and if it is used at all) depends on the action part type as defined in the "Command" field. 180
V
Path t_path File path parameter of the action part. The content of this parameter (and if it is used at all) depends on the action part type as defined in the "Command" field. 181
V
String t_string String parameter of the action part. The content of this parameter (and if it is used at all) depends on the action part type as defined in the "Command" field. 654
V


ActiveActions

Table id: 25 (eActiveActions)

This is a dynamic table. It contains all actions which are currently running. Once an action is finished, it is removed from the "ActiveActions" table again.

Field Type Description id Scriptable Storage
ActionPartIndex t_int Index of current active action part inside this action. If changing the current action part you have to make sure that "ContinueWaitForEndIfElse" is also correct for the new action part index. 489
S
ActionPartStarted t_bool True if the current action part is already started, e. g. if a text is shown but the action waits until the display of the text is finished. Only used internally for action parts which cause the action to wait. 488
S
ContinueWaitForEndIfElse t_int Total number of open if statements in this action at current position. Use with care. 490
S
PauseTime t_int Time past since last timer was started. Only valid if "TimerStarted" is true. 492
S
TimerStarted t_bool True if there is currently a timer running (e. g. waiting for pause). 491
S
SavedObject t_link to Actions Link to the original action object. 625
S
SavedValue t_int 842
S


ActiveAnimations

Table id: 26 (eActiveAnimations)

This is a dynamic table. It contains all animations which are currently running. Once an animation is finished, it is removed from the "ActiveAnimations" table again.

Field Type Description id Scriptable Storage
Active t_bool True if the animation was started. This value can be false if the animation was preloaded but not yet started. If set to false and the animation is not preloaded then it is deleted. If it is preloaded and set to false then the animation is hidden but kept alive. If set to true when the animation was not yet started (only possible if it was preloaded) then the animation is started. 580
S
CalledTime t_int Time past (in milliseconds) since frame was first shown or animation loop finished. 497
S
CurrentPosition t_point Position of animation on scene (each frame can have an offset to the animation which is defined in each sprite). 496
S
CurrentSpriteIndex t_int Index of currently active frame. 494
S
CurrentSpritePos t_point Position of currently active frame on scene. 495
S
FirstFrame t_int First frame of the animation to show. Default value is 1, so the animation is shown with the first available frame. 644
S
FrameCount t_int Total number of frames already shown in the current animation loop. 542
S
LastFrame t_int Last frame of the animation to show. Default value is the number of frames of the animation, so the animation is shown until the end. 645
S
Loops t_int Number of animation loops remaining (the current animation loop is also counted). 0 means infinite animation loops. 493
S
PlayOppositeDirection t_bool True if the animation is played backwards. 541
S
Preloaded t_bool True if the animation is preloaded. If it is preloaded the value of "Active" defines if the animation is shown or just kept in memory. 577
S
SavedObject t_link to Animations Link to the original animation object. 626
S
Size t_int Scaling of animation in percent (100 means animation is played in original size). 499
S
StartedByUser t_bool True if the animation was started by the user through an action part. Used internally to know which animations must be stored in savegames. 691
S
Waiting t_bool True if animation is currently waiting for next animation loop (e. g. if there is a random pause between animation loops). 500
S
WaitingTime t_int Total time (in milliseconds) currently waiting between two animation loops. Only valid if "Waiting" is true. 501
S


ActiveTexts

Table id: 24 (eActiveTexts)

This is a dynamic table. It contains all texts which are currently displayed. Once a text disappears, it is removed from the "ActiveTexts" table again.

Field Type Description id Scriptable Storage
Alignment t_int Defines alignment of text. Possible values:
  • 0 (eAlignLeft): Align left.
  • 1 (eAlignRight): Align right.
  • 2 (eAlignCentered): Centered.
  • 3 (eAlignLeftWithCenterPos): Align left (use center position).
  • 4 (eAlignRightWithCenterPos): Align right (use center position).
  • 5 (eAlignCenteredWithLeftPos): Centered (use left position).
744
S
Active t_bool True if the text is currently active. 529
S
Background t_bool True if the text is shown in the background. If false then the text is shown in the foreground and no user interaction is possible (except skipping the text). 527
S
CurrentText t_string Currently shown text. This is a part of the whole text between pause-tags or the whole text if there are no pause-tags. 522
S
Font t_link to Fonts Font used for displaying this text. 526
S
Owner t_link to Characters or Objects or Buttons Object which own this text. Only speaker texts do not have an owner. If an owner exists the text is only shown if the owner is currently active. 684
S
Position t_point Position on scene where the text is shown. 523
S
RemainingText t_string Remaining text after TextCurrentText. 521
S
SavedObject t_link to Texts Link to the original text object. 624
S
TimeElapsed t_int time (in msec) elapsed since showing current part (TextCurrentText) of text. 525
S
TimeToWait t_int Total time (in msec) for showing current part (TextCurrentText) of text. 524
S
WaitForAudio t_bool True if current part of text (TextCurrentText) is shown until the speech file for this text is finished. If value is true then TextTimeToWait will be ignored. 530
S


Animations

Table id: 9 (eAnimations)

Field Type Description id Scriptable Storage
Action t_link to Actions Action which is started when the animation is finished. 190
V
Center t_point Defines the center of the animation. If an animation is set to a position then the center will match this position (e. g. used for hotspot of cursor or feet center of character animation). 367
V
Direction t_int Defines the direction in degrees (0-359) this animation should be used for (only for character animations). 285
V
EndDirection t_int Defines the end direction for turn animations in degrees (0-359). 811
V
LoopRandom t_bool If true then there is a random pause between 2 loops of the animation. If false the next loop is shown immediately. 184
V
Mirror t_link to Animations Link to an animation which will be shown mirrored (horizontally) instead of this animation. If the link is not empty all other settings of this animation are not used (because settings are used from the linked animation). 284
V
ModelAnimIndex t_int Index of the animation stored in a 3D model file that is chosen for the current animation. If the animation index is invalid, the first animation stored in the 3D model file is used. 726
V
ModelAnimSpeed t_int Replay speed of a 3D model animation in ticks per second. This field can be used to finetune the duration of individual animations without changing the 3D model file. The default value is 15. 727
V
Move t_bool Effects drawing order of the animation. If true the drawing order depends on the current animation position, if false the drawing order depends on the object this animation belongs to (should only be set to true for animations which are moving vertically, or if the sprites have different height). 338
V
NumberOfLoops t_int Number of loops. Set to 0 if it is an endless animation. 187
V
Pause t_int Time (in milliseconds) between two frames of the animation. Is only used if "UseIndividualPause" is false (otherwise the pause is stored in each sprite). 188
V
Pauses t_vint 849
V
Position t_point Upper left corner of animation on scene (or interface). 189
V
PropertyFrames t_links to AnimationFrames (parent) Frames with special properties which will be used when the frame of the animation (identified by "FrameIndex") is shown. 576
V
Replay t_int Possible values:
  • 0 (eReplayNormal): animation loops are shown in normal order.
  • 1 (eReplayReverse): each loop of the animation is shown in reverse order.
  • 2 (eReplayRandom): all frames of an animation loop are shown in random order.
656
V
Sprites t_vsprites All sprites of the animation. 235
V
UseIndividualPause t_bool If true then the pause between two frames of the animation is stored in each sprite. If false then "Pause" is used for the pause between two frames. 344
V
WalkSteps t_vfloat Only used for character walk animations. Defines the distance (pixels in one second at 100% size) between animation frames. If "Outfit > SlideWalkAnimation" is true the character also moves while a frame is shown (the current position will be interpolated), if false the character only moves when a new frame is shown. 760
V


AnimationFrames

Table id: 28 (eAnimationFrames)

Field Type Description id Scriptable Storage
Action t_link to Actions An action which will be started when this frame is shown. 575
V
Index t_int Frame number to identify the frame. This is the n-th frame (index starting with 0) of the animation which linked to this frame by "Animation > PropertyFrames". 571
V
Sound t_path A sound which will be played when this frame is shown. 572
V
SoundBalance t_int Balance of the sound (as defined in "Sound"). Must be between -100 (only left speaker) and 100 (only right speaker). 574
V
SoundVolume t_int Volume of the sound (as defined in "Sound"). Must be between 0 (mute) and 100 (full volume). 573
V


AreaActions

Table id: 33 (eAreaActions)

Field Type Description id Scriptable Storage
Action t_link to Actions (parent) The action to execute if all conditions are fulfilled (see "Character" and "ExecuteAlways"). The execution type of the action ("Action > ExecutionType") must also match the character either entering or leaving the area (type is either 29 (CharacterEntersArea) or 30 (CharacterLeavesArea)). 680
V
Character t_link to Characters If set the action is only executed if the specified character enters/leaves (see "Action > ExecutionType") the area. If not set then the action is executed for all characters. 678
V
ExecuteAlways t_bool If false then the action is only executed if the scene of this area action is currently shown. If true then the action is always executed independently if the scene of this area action is currently shown or not. 679
V


AudioBusses

Table id: 37 (eAudioBusses)

Field Type Description id Scriptable Storage
Events t_links to Events 837
V
LinkedObjects t_links to Objects 881
V
Links t_links 830
V
OutputBus t_link to AudioBusses 850
V
Setings t_string 831
V
Type t_int 829
V
Values t_links to Values 837
V


Blocks

Table id: 41 (eBlocks)

Field Type Description id Scriptable Storage
Active t_bool 878
V
Config t_string 874
V
Links t_links 873
V
Position t_point 876
V
Type t_int 889
V
TypeName t_string 875
V


BlockContainers

Table id: 40 (eBlockContainers)

Field Type Description id Scriptable Storage
Blocks t_links to Blocks 870
V


Buttons

Table id: 2 (eButtons)

Field Type Description id Scriptable Storage
Actions t_links to Actions (parent) All actions of this button. 455
V
ActiveSprite t_link to Sprites (parent) Sprite which is shown if the button is active. If "Type" is 3 or 6 (command) and this button is currently selected then the button is active. If "Type" is 1 or 2 (scroll arrow) and it is possible to scroll the items then the button is also active. In all other situations the button is inactive (also see "InactiveSprite"). 342
V
Animation t_link to Animations Animation which will be played automatically if the button is shown (see "Condition"). 545
V
Animations t_links to Animations (parent) All animations of the button. 546
V
CommandType t_int Only used if the button is a command ("Type" = 3 or 6). Defines the type of this command. Possible values:
  • 0 (eButtonNormal): normal command (e. g. "Look at", "Push").
  • 1 (eButtonCombined): combined command (e. g. "Use", "Give").
  • 2 (eButtonGive): give command (e. g. "Give").
612
V
Condition t_link to Conditions If not empty then the button is only shown and detected by the cursor if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the button is active. 543
V
ConditionNegate t_bool If true then the condition linked under "Condition" is negated. 544
V
Conjunction t_link to Texts The conjunction word for the action text (e. g. "with" in action text "Use item with ..."). Only used if the button is a combined command ("Type" = 3 or 6 and "CommandType" = 1 or 2). 296
V
Cursor t_link to Cursors Only used if button is a command ("Type" = 3 or 6). The cursor which is shown if the command is active. 229
V
Draggable t_bool If true then items can be dragged (the item is shown instead of the cursor and can be dropped on any object) with this command (only if "Game >DraggableItems" is true and "Type" of this button is 3). 567
V
Group t_links to Buttons List of commands ("Type" of the linked buttons must be 3 or 6) which are used for the button group. With a button group it is possible to define an action for a various number of commands (all commands which are linked by this button). 584
V
InactiveSprite t_link to Sprites (parent) Sprite which is shown if the button is inactive (also see "ActiveSprite"). 343
V
MatrixId t_int 800
S
Name t_link to Texts Only used if button is a command ("Type" = 3 or 6). The name of the command which is shown in the action text. 295
V
Offset t_point Offset for this button from its initial position. By changing the offset it is possible to move the button on the interface. The button image and all button animations will take the offset into account. Detecting a button ("Polygon") by the cursor also considers the offset. 916
S
Polygon t_vpoint Polygon which defines the border of the button. The button is detected if the cursor is inside the polygon. 454
V
Rotation t_float Defines the rotation in degrees. 796
S
RotationCenter t_point Defines the center point of rotation. 797
S
Scale t_float Factor for scaling of the button (100 is original size). 799
S
ScaleX t_float Factor for horizontal scaling of the button (100 is original width). 814
S
ScaleY t_float Factor for vertical scaling of the button (100 is original height). 815
S
ShaderSet t_int Sets shader configuration id for a button and all of its animations, see "shaderSetOptions()" command. 798
S
Type t_int Defines the type of this button. Possible values:
  • 0 (eButtonPlaceholder): Placeholder for an item.
  • 1 (eButtonScrollUp): Scroll arrow to scroll items up (number of items to scroll is defined by "Interface > ScollStepSize").
  • 2 (eButtonScrollDown): Scroll arrow to scroll items down (number of items to scroll is defined by "Interface > ScollStepSize").
  • 3 (eButtonCommand): Command.
  • 4 (eButtonActionArea): Action area (only used to define individual actions for an area).
  • 5 (eButtonCommandGroup): Command group (buttons in the group defined by "Group").
  • 6 (eButtonCommandInGroup): Command in a command group (group defined by "Group"). This is basically the same as a command (3) with the only difference that this command cannot be selected for actions (because it is only selected through its group).
297
V
Use t_int Only used if button is a command ("Type" = 3 or 6). Defines on what the command can be used on. Possible values:
  • 0 (eUseOnAll): on objects (scene objects and items) and characters.
  • 1 (eUseOnCharacters): only on characters.
  • 2 (eUseOnObjects): only on objects (scene objects and items).
336
V
UseOnCurrentCharacter t_bool Only used if button is a command ("Type" = 3 or 6) and "Use" is 1 or 2. If false the command can be used on all characters except the current character. If true the command can also be used on the current character. 613
V
Value t_link to Values If not empty then the button is only shown and detected by the cursor if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the button is active. 882
V
ValueInt t_int Integer value for querying the value linked under "Value". 884
V
ValueOperator t_int Operator for querying the value linked under "Value". Possible values:
  • 0: equals (=)
  • 1: doesn't equal (!=)
  • 2: equal or greater than (>=)
  • 3: greater than (>)
  • 4: equal or less than (<=)
  • 5: less than (<)
883
V
Visibility t_int Visibility of the button in percent. Must be between 0 and 100. A value of 0 means the object is not visible at all (but is still recognized by the cursor). 888
S


Characters

Table id: 0 (eCharacters)

Field Type Description id Scriptable Storage
ActionCharacter t_link to Characters 505
S
Actions t_links to Actions (parent) All actions of the character. 280
V
ActionDestPosition t_point If this position is set and an action is executed on this character then the current character walks to this position (instead of directly to the character) to execute the action. 734
V/S
Active t_bool If true (default) the character is shown and detected by the cursor. 502
S
ActiveCommand t_link to Buttons Currently active command for this character. The button must have "Type" = 3. 517
S
ActiveDialogFont t_link to Fonts Font which is used for a currently hovered dialog part. 457
V
ActiveUsedDialogFont t_link to Fonts Font which is used for a currently hovered – and previously selected – dialog part. 920
V
AnimIndex t_int Index for character animations. If there is more than one animation for a direction (e. g. two talk animations for direction 90°) this value decides which animation is used. The index starts with 0 (default, use first animation). 564
S
AnimState t_int Type of currently playing character animation. Possible values:
  • 0 (eNoAnim): No animation.
  • 1 (eWalkAnim): Walk animation.
  • 2 (eTalkAnim): Talk animation.
  • 3 (eStandingAnim): Standing animation.
  • 4 (eCharacterAnim): Character animations.
  • 5 (eRandomAnim): Random animations.
508
S
AudioBus t_link to AudioBusses 855
S
CommentSets t_links to CommentSets (parent) All comment sets of the character. 282
V
Conditions t_links to Conditions All conditions of the character. 331
V
CurrentCommentSet t_link to CommentSets Currently used comment set. 277
V/S
CurrentOutfit t_link to Outfits Currently used outfit. 276
V/S
Destination t_point Destination where the character is currently walking to. 513
S
DestinationObject t_point Scene object the character is currently walking to. The character will be aligned to the scene object when it is reached and an action is executed (see "Game > DestinationCommand", "Game > DestinationItem" and "Game > DestinationItemPicked"). 515
S
DestVisibility t_int The visibility of the character is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the character will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility". 596
S
DialogActiveScrollDown t_sprite Active scroll arrow (for scrolling down). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea"). 461
V
DialogActiveScrollUp t_sprite Active scroll arrow (for scrolling up). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea"). 459
V
DialogArea t_rect Defines the absolutely positioned rectangle on the screen where the dialog is displayed. 458
V
DialogCursor t_link to Cursors Cursor which will be displayed if a dialog is currently active. 283
V
DialogInactiveScrollDown t_sprite Inactive scroll arrow (for scrolling down). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea"). 462
V
DialogInactiveScrollUp t_sprite Inactive scroll arrow (for scrolling up). Is displayed if a dialog is currently active and there are too many dialog parts to be displayed in the dialog area ("DialogArea"). 460
V
Dialogs t_links to Dialogs All dialogs which can be spoken with this character. 278
V
DialogSprite t_sprite Sprite which is used as a background for dialogs. 463
V
DialogVerticalSpace t_int Distance between two dialog part selections (in pixels). 464
V
Direction t_int Direction (in degress from 0 to 360) the character is currently looking at. The animation (or sprite) which best fits the direction is shown (e. g. if there are 4 animations for 0, 90, 180 and 270 degress and "Direction" is set to 80 then the second animation is shown). 599
S
FollowAction t_link to Actions Action which is executed if this character is following another character ("FollowCharacter") and the other character is within reach (less pixel than "FollowReachDistance"). 506
S
FollowCharacter t_link to Characters Character which this character is currently following. 504
S
FollowReachDistance t_int If this character is following another character ("FollowCharacter") this value (in pixels) defines when the other character is within reach (see "FollowAction"). 507
S
Font t_link to Fonts Font which is used for all texts which are spoken by this character. 275
V
HarmonizeWalkAnimations t_bool 839
V
InactiveDialogFont t_link to Fonts Font which is used for all dialog parts except the one currently hovered (see "ActiveDialogFont"). 581
V
InactiveUsedDialogFont t_link to Fonts Font which is used for all previously selected dialog parts except the one currently hovered (see "ActiveUsedDialogFont"). 919
V
Interfaces t_links to Interfaces All interfaces currently used for this character. 585
V/S
Items t_links to Objects All items which are picked up by this character. 663
S
LightmapActive t_bool 801
S
MatrixId t_int 793
S
Name t_link to Texts The name of the character (as shown in the action text). 271
V
Outfits t_links to Outfits (parent) All outfits of the character. 281
V
Position t_point Current position of character (if field is set and character is walking, then it will stop walking). 512
S
Scale t_bool If false the character is not scaled and will always be drawn in the original size. 456
V
ScaleFactor t_int Factor in percent the character is scaled with. Must be > 0 (default is 100). 566
V/S
Scene t_link to Scenes Scene where the character is currently on. 503
S
ShaderSet t_int Sets shader configuration id for a character, see "shaderSetOptions()" command. 795
S
Size t_float Current size of character in percent (100 = original size) taking "Scale", "ScaleFactor" and the current character position on the scene into account. 749
S
StartObject t_link to Objects Scene object where the character is standing ("Object > Position") at the beginning of the game. 311
V
State t_int Current state of character (only set to 2 to stop walking, do not set 3). Possible values:
  • 2: standing.
  • 3: walking.
511
S
TimeToDestVisibility t_int Defines the time (in milliseconds) until the destination visibility ("DestVisibility") is reached. This value is used the next time when "DestVisibility" is set. 597
S
Tint t_int Color (in BGR notation) the character will be drawn with. If the most significant byte is not 0 then this color will be ignored (default) and the lightmap (if present) and scene brightness will be used for the tint of the character. Otherwise the three lower bytes are used for the tint the character will be drawn with. The least significant byte specifies red, then green and the third byte specifies blue. E. g. with 0xFF0000 the character would be drawn with a blue light. 664
S
Values t_links to Values All values of the character. 334
V
Visibility t_int Visibility of the character in percent. Must be between 0 and 100. A value of 0 means the character is not visible at all (but is still recognized by the cursor). 595
S
WalkingSound t_path Sound which is played when the character is walking. 272
V/S


CommentSets

Table id: 16 (eCommentSets)

Field Type Description id Scriptable Storage
Entries t_links to CommentSetEntries All comment set entries of this comment set. 557
V


CommentSetEntries

Table id: 27 (eCommentSetEntries)

Field Type Description id Scriptable Storage
Command t_link to Buttons If empty this comment set entry is a standard comment set entry (used for all comments). If this link is a command ("Button > Type" must be 3) then this comment set entry will only be shown if a command is shown after an execution of an action with this command failed. 560
V
Text t_link to Texts Text for this comment. 559
V


Conditions

Table id: 10 (eConditions)

Field Type Description id Scriptable Storage
Conditions t_links to Conditions All conditions of a combined condition (only used if "IsVariable" is false). 844
V
ConditionsNegate Table of booleans corresponding to the conditions linked in "Conditions". If true the correspoding condition will be negated (only used if "IsVariable" is false). 845
V
IsVariable t_bool If true this condition only contains true or false. If false this condition is a combined condition (see "Conditions", "ConditionsNegate"). 193
V
Operator t_int Defines how the conditions of a combined condition (linked in "Conditions") are combined (only used if "IsVariable" is false). Possible values:
  • 0: logical AND.
  • 1: logical OR.
198
V
ReturnNegate t_bool If true then the combined result of "Conditions" will be negated (only used if "IsVariable" is false). 195
V
Value t_bool Current value of the condition (true or false). This is only used if "IsVariable" is true. 194
V/S


Cursors

Table id: 15 (eCursors)

Field Type Description id Scriptable Storage
ActiveAnimation t_link to Animations Animation of the active cursor. 647
V
InactiveAnimation t_link to Animations Animation of the inactive cursor. 648
V


Curves

Table id: 42 (eCurves)

Field Type Description id Scriptable Storage
Points t_vpoint 895
V
Type t_int 896
V


Dialogs

Table id: 11 (eDialogs)

Field Type Description id Scriptable Storage
DialogParts t_links to DialogParts (parent) All dialog part selections of this dialog. 202
V
Character t_link to Characters 825
V


DialogParts

Table id: 12 (eDialogParts)

Field Type Description id Scriptable Storage
Action t_link to Actions (parent) Action which is executed if this dialog part is selected. It is not allowed to start a dialog in this action. 206
V
AltText t_link to Texts (parent) Text which is spoken by the current character (only used if "UseAltText" is true, otherwise "Text" is spoken). 465
V
AnswerText t_link to Texts (parent) Text which is spoken by the other character (character where the dialog belongs to) after the text is spoken by the current character. 286
V
Available t_bool If true then this dialog part is still available (see "Remove"). 317
S
Condition t_link to Conditions The dialog part selection is only shown if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the dialog part is shown. 204
V
ConditionNegate t_bool If true then the condition linked under "Condition" is negated. 614
V
LinkedAction t_link to Actions Action which is executed if this dialog part is selected and the link "Action" is empty. It is not allowed to start a dialog in this action. 655
V
NextDialog t_link to Dialogs (parent) Dialog which is shown when this dialog part is selected. 289
V
Remove t_bool If true then this dialog part can only be selected once ("Available" will be set to false after selection). 288
V
Return t_int Defines which dialog is shown if this dialog part is selected (and the dialog part does not have a dialog with active dialog parts below). Possible values:
  • 0 (eDialogReturnToSame): the same dialog will be shown again.
  • 1 (eDialogReturnToUpper): the "upper" dialog (which linked to the current dialog) will be shown.
  • 2 (eDialogReturnToEnd): no dialog will be shown.
287
V
Text t_link to Texts (parent) Text which is shown as a selection in the dialog. Further it is spoken by the current character if "UseAltText" is false. 205
V
UseAltText t_bool If true then "AltText" will be spoken by the current character, otherwise "Text". 466
V
Value t_link to Values The dialog part selection is only shown if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the dialog part is shown. 885
V
ValueInt t_int Integer value for querying the value linked under "Value". 887
V
ValueOperator t_int Operator for querying the value linked under "Value". Possible values:
  • 0: equals (=)
  • 1: doesn't equal (!=)
  • 2: equal or greater than (>=)
  • 3: greater than (>)
  • 4: equal or less than (<=)
  • 5: less than (<)
886
V


Events

Table id: 38 (eEvents)

Field Type Description id Scriptable Storage
Action t_link 864
V
StartBus t_link to AudioBusses 865
V
StopBus t_link to AudioBusses 866
V


Fonts

Table id: 3 (eFonts)

Field Type Description id Scriptable Storage
Alphabet t_string A string which contains all characters of the font. The characters have to be in the same order as they appear in the sprite linked in "Sprite" (from left to right and top to bottom). This value is only used for bitmap fonts ("TrueTypeFont" = false). 249
V
AutoLineBreak t_bool If true then line breaks will be added to all texts rendered with this font so that the maximum length of a line does not exceed a certain limit. Each line has a maximum width which is defined in "LineWidth". 634
V
Border t_bool If true a font border will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true). 774
V
BorderColor t_int Color for font border. The least significant byte specifies red, then green and the third byte specifies blue (BGR notation). This value is only used for TrueType fonts ("TrueTypeFont" = true) and if "Border" is set to true. 775
V
BorderSize t_float Size of font border in pixels. This value is only used for TrueType fonts ("TrueTypeFont" = true) and if "Border" is set to true. 776
V
Color t_int Font color. The least significant byte specifies red, then green and the third byte specifies blue (BGR notation). This value is only used for TrueType fonts ("TrueTypeFont" = true). 773
V
Font t_link Font which will be used as reference. This can be useful to define a new font with own color, size, etc. based on an existing TrueType font ("TrueTypeFont" = true). This can save a lot of resources compared to creating a new TrueType font. 770
V
Kerning t_string Defines spacings for individual letters or pairs of letters. This value is only used for bitmap fonts ("TrueTypeFont" = false). 703
V
Letters t_vrect List of rectangles where each rectangle contains the position of a single character on the sprite linked in "Sprite". This value is only used for bitmap fonts ("TrueTypeFont" = false). 143
V
LetterSpacing t_int Horizontal distance between two characters (in pixel). This value is only used for bitmap fonts ("TrueTypeFont" = false). 250
V
LineWidth t_int Maximum line width (in pixel) for automatic line break. This value is only used if "AutoLineBreak" is true. 635
V
Shadow t_bool If true a font shadow will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true). 777
V
ShadowOffset t_point Offset in pixels for font shadow (see "Shadow"). 778
V
Size t_float Font size in pixels. This value is only used for TrueType fonts ("TrueTypeFont" = true). 772
V
SpaceWidth t_int Width of space (in pixels). This value is only used for bitmap fonts ("TrueTypeFont" = false). 623
V
Sprite t_sprite Sprite with all characters of the font. This value is only used for bitmap fonts ("TrueTypeFont" = false). 248
V
TrueTypeFont t_bool If set to true this is a TrueType font. Either "TrueTypeFontPath" or "Font" must be set for a valid font. 769
V
TrueTypeFontPath t_path Path to TrueType font file. This value is only used for TrueType fonts ("TrueTypeFont" = true). 771
V
VerticalLetterSpacing t_int Vertical distance between two characters (in pixel). 540
V


game

Table id: -1 (eGame)

Field Type Description id Scriptable Storage
About t_string Long description of game, authors can make additional comments here. 125
V
Actions t_links to Actions (parent) All actions which can be started with a key. The key value is stored in "Action > ExecutionType". 318
V
ActionTextFont t_link to Fonts Font which will be used for the action text (only used if "DrawActionText" is 1 or 2). 589
V/S
ActionTextRect t_rect Rectangle in which the action text will be drawn horizontally and vertically centered (only used if "DrawActionText" is 2). 590
V
ActiveCommand t_link to Buttons The currently active command. 610
V/S
AlignCharacterOnImExecution t_bool If true the active character will be automatically aligned to the clicked object when an action with an "immediate" execution type is executed. 582
V/S
AlwaysAllowSkipText t_bool If true the active text can always be skipped with the left mouse button (even when the cursor is disabled or a cutscene is running). 565
V/S
AudioContainerLinks t_links to AudioBusses 835
V
AudioMixLinks t_links to AudioBusses 834
V
AutoHideInterfacesInMenu t_bool If true all interfaces are hidden if the current scene is a menu. If it is necessary to display an interface on a menu then this option must be set to false and the interfaces must be hidden manually when necessary. 628
V/S
Behaviours t_links 890
V
BlockContainers t_links 877
V
BuildOptions t_string 819
V
BuildRules t_vstring 804
V
CharacterComposedFile t_path Defines the filename for composing the character when compiling the game. 620
V
CharacterComposedFiles t_int The number of composed character files. Possible values:
  • 0 (eMainContainer): All characters are stored in the main container.
  • 1 (eSingleContainer): All characters are stored in one file specified by "CharacterComposedFile".
  • 2 (eMultipleContainers): Each character is stored in an own container specified by "CharacterComposedFile" (filename extended by the character number).
619
V
CharacterLinks t_links to Characters (parent) All characters of the game. 118
V
CommandBehaviour t_int Behavior for selecting the standard command. Possible values:
  • 0 (eStdCommandAlways): set standard command after executing an action.
  • 1 (eSetStdCommandNever): never set standard command.
  • 2 (eSetStdCommandOnSuccess): set standard command after successful execution of an action.
244
V/S
CompanyName t_string The company name is used for the path where game log files and savegames are stored. E. g. on an English Windows the path could look like this: C:\Users\USERNAME\AppData\Local\COMPANY_NAME\GAME_NAME. 700
V
ComposedFile t_path Defines the filename for composing the main output file (.vis file) when compiling the game. 616
V
Containers t_vstring 803
V
CurrentCharacter t_link to Characters Character which is currently controlled by the player (active character). 468
S
CurrentObject t_link to Objects or Characters or Buttons The object currently below the cursor. 687
S
CurrentScene t_link to Scenes Scene which is currently shown. 469
S
CurrentText t_link to ActiveTexts Text which is currently displayed. 477
S
Cursor t_link to Cursors 856
S
CursorHorizontalScrollDistance t_int Distance of cursor to the left or right screen border where horizontal scrolling will be started. 689
S
CursorVerticalScrollDistance t_int Distance of cursor to the top or bottom screen border where vertical scrolling will be started. 690
S
Cursors t_links to Cursors (parent) All cursors of the game. 215
V
CustomActionParts t_vstring All custom action parts from installed action part plugins. 857
V
CutsceneAction t_link to Actions If a cutscene is active this links to the action which started (and should stop) the cutscene. 633
S
DefaultMusicBus t_link to AudioBusses 854
S
DefaultSoundBus t_link to AudioBusses 852
S
DefaultSpeechBus t_link to AudioBusses 851
S
Description t_string Short description of the game. 124
V
DestinationCommand t_link to Buttons When the user clicked on an object and the character walks to this object, this command will be executed when the object is reached. 483
S
DestinationEvent t_int When the user clicked on an object and the character walks to this object, this event will be executed when the object is reached. Possible values:
  • 0: no event.
  • 1: left mousebutton click.
  • 2: right mousebutton click.
  • 3: left mousebutton double click.
  • 4: left mousebutton hold.
  • 5: mouse enters area.
  • 6: mouse leaves area.
615
S
DestinationItem t_link to Objects When the user clicked on an object and the character walks to this object, this item will be used on the object when it is reached. 484
S
DestinationItemPicked t_bool When the user clicked on an object and the character walks to this object, this will be set to true in case an item was picked up (see "DraggableObjects"). Then the item in "DestinationItem" will be dropped on the object when it is reached. 485
S
Dialog t_link to Dialogs Currently displayed dialog. 476
S
DialogAction t_link to Actions Running action which contains the text for the current dialog. 481
S
DisableInteractionDuringAnim t_int 643
V
DraggableItems t_bool True if objects can be dragged from the interface. 305
V/S
DrawActionText t_int Defines if and where the action text is drawn. Possible values:
  • 0 (eDrawNoActionText): do not draw action text.
  • 1 (eDrawActionTextAtCurrentPos): draw action text at current cursor position.
  • 2 (eDrawActionTextAtRect): draw action text centered in the rectangle defined by GameActionTextRect.
588
V/S
ExecuteActionsDuringDialog t_bool If true the key actions (defined in "Actions") will also be executed if a dialog is currently displayed. 578
V/S
ExecuteCalledActionImmediately t_bool 790
V
FadeDelay t_int Delay for fade in/out of a scene in milliseconds. 234
V/S
FadeEffect t_int Effect for fade in/out of a scene. Possible values:
  • 0 (eFadeNo): no effect, display new scene immediately.
  • 1 (eFadeIn): fade in new scene (no fade out of current scene).
  • 2 (eFadeOut): fade out current scene (no fade in of new scene).
  • 3 (eFadeInAndOut): fade out current scene and fade in new scene.
  • 4 (eFadeToNew): use alpha-blending to directly fade from current to new scene.
  • 5 (eShiftLeft): shift current scene to the left and show new scene.
  • 6 (eShiftRight): shift current scene to the right and show new scene.
  • 7 (eTunnelEffect): use a tunnel effect for fade in/out.
547
V/S
FirstCharacter t_link to Characters Character which is used for starting the game. This is the character which is controlled by the player. 303
V
FirstScene t_link to Scenes The first scene of the game (which is shown after the loading screen) 121
V
FontLinks t_links to Fonts (parent) All fonts of the game. 120
V
FullScreenIntro t_bool True if the intro movie is scaled to fullscreen. 247
V
GameComposedFile t_path Defines the filename for composing the game object and its actions (e. g. left mouse button action, right mouse button action) when compiling the game. 683
V
GameComposedFiles t_int The number of composed game files. Possible values:
  • 0 (eMainContainer): The game object is stored in the main container.
  • 1 (eSingleContainer): The game object is stored in one file specified by "GameComposedFile".
682
V
GameName t_string The game name is used for the path where game log files and savegames are stored. E. g. on an English Windows the path could look like this: C:\Users\USERNAME\AppData\Local\COMPANY_NAME\GAME_NAME. 701
V
HiddenDialog t_link to Dialogs If the user switches to a menu while a dialog is currently shown in a playable scene (e. g. the dialog parts are displayed) - this is only possible if "ExecuteActionsDuringDialog" is true - then the dialog is saved in this field. The dialog is hidden until the user switches back to a playable scene. 579
V/S
HideCursor t_bool If true the cursor is hidden and no cursor interaction is possible. 480
S
HideInterfaces t_bool If true all interfaces are hidden, independent of individual interface visibility. 479
S
HoldTime t_int Time (in milliseconds) until the 'Mouse holding' event (for "LeftHoldAction" and "LeftHoldingAction") is fired. 377
V/S
HorizontalScrollDistance t_int If the distance of the current character to the horizontal scene border is equal or smaller than this value then the scene will be scrolled horizontal to center the character (if the scene is larger than the viewable area). If this value is very small the character has to go very close to the border until the scene is scrolled, if the value is half the viewable size or larger then the character will always be centered. 667
S
IconFile t_path 818
V
Id t_string Unique Identification number. Used for savegames in order to only load savegames for correct game. 370
V
Interfaces t_links to Interfaces (parent) All interfaces of the game. 662
V
InterfaceClasses t_links to InterfaceClasses (parent) All interface classes of the game. 661
V
InterfaceComposedFile t_path Defines the filename for composing the interface when compiling the game. 671
V
InterfaceComposedFiles t_int The number of composed interface files. Possible values:
  • 0 (eMainContainer): All interfaces are stored in the main container.
  • 1 (eSingleContainer): All interfaces are stored in one file specified by "InterfaceComposedFile".
  • 2 (eMultipleContainers): Each interface is stored in an own container specified by "InterfaceComposedFile" (filename extended by the interface number).
670
Intro t_path Intro movie which will be played at the beginning of the game. 224
V
Items t_links to Objects (parent) All items of the game. 349
V
KeepCharacterSpritesDuringMenus t_bool 642
V
Languages t_links to Languages (parent) All languages of the game. 259
V
LeftClickAction t_link to Actions (parent) An action which will be started if the left mouse button is clicked. 563
V
LeftClickBehaviour t_int Defines if the character will be sent to the current position when the left mouse button is clicked. Possible values:
  • 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
  • 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
  • 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
891
V/S
LeftDblClickAction t_link to Actions (parent) An action which will be started if the left mouse button is double clicked. 379
V
LeftHoldAction t_link to Actions (parent) Action which is started if the left mouse button is pressed for a certain time ("HoldTime") and "LeftMouseHold" is set to 3 or 4. The action is started when the mouse button is released. 381
V
LeftHoldingAction t_link to Actions (parent) Action which is started if the left mouse button is pressed for a certain time ("HoldTime") and "LeftMouseHolding" is set to 3. The action is started when the mouse button is pressed. 386
V
LeftHoldBehaviour t_int Defines if the character will be sent to the current position when the left button is released. Possible values:
  • 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
  • 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
  • 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
780
V/S
Loading t_link to Loadings (parent) The loading screen which is shown on startup when the game is loaded. 358
V
MinificationFilter t_int DEPRECATED, see "NearestNeighborInterpolation" instead
MagnificationFilter t_int DEPRECATED, see "NearestNeighborInterpolation" instead
MiddleClickAction t_link An action which will be started if the middle mouse button is clicked. 766
V
MiddleClickBehaviour t_int Defines if the character will be sent to the current position when the middle mouse button is clicked. Possible values:
  • 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
  • 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
  • 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
781
V/S
MouseWheelDownAction t_link to Actions An action which will be started if the mouse wheel is moved down. 768
V
MouseWheelUpAction t_link to Actions An action which will be started if the mouse wheel is moved up. 767
V
MovieComposedFile t_path Defines the filename for composing the movies when compiling the game. 622
V
MovieComposedFiles t_int The number of composed movie files. Possible values:
  • 0 (eMainContainer): All movies are stored in the main container.
  • 1 (eSingleContainer): All movies are stored in one file specified by "MovieComposedFile".
621
V
NearestNeighborInterpolation t_bool If true nearest neighbor interpolation is used scaling of character images (pixel effect). 745
V
ObjectFont t_link to Fonts The font used when displaying an object text. An object text can be set with an action part which links a text to a scene object or an interface button. 685
V
ObjectTextOutput t_int 702
V
OverlayColor t_int 841
S
OverlayVisibility t_int 840
S
ParticleContainerLinks t_links to ParticleContainers (parent) All particle systems of the game. 448
V
PicBufferSize t_int Buffer size (in KB) for reserved memory at game startup. This buffer is used for all non-preloaded images and should be large enough to hold the largest image, otherwise memory must be allocated dynamically which can lead to memory fragmentation and crash the application. E. g. if the largest image is 1400x1200 and has an alpha channel then "PicBufferSize" must be set to a value >= 6563 (4 byte per pixel (red, green, blue and alpha channel), 1400 * 1200 * 4 = 6720000, divided by 1024 because unit is KB and not byte, 6720000 / 1024 = 6562.5). 733
V
PictureCacheSize t_int Size (in MB) for cache which stores the recently loaded images. 669
V
Plugins t_links to Plugins Installed action part plugins. 863
V
PreallocatedTextures t_int 743
V
PreloadPicThreads t_int Number of threads used for preloading animations. "PreloadPicThreads" number of buffers with size of "PreloadedPicBufferSize" will be preallocated. 731
V
PreloadedPicBufferSize t_int Buffer size (in KB) for reserved memory at game startup. This buffer is used for preloading images and should be large enough to hold the largest image (of a preloaded animation), otherwise memory must be allocated dynamically which can lead to memory fragmentation and crash the application. E. g. if the largest image of all preloaded animations is 1400x1200 and has an alpha channel then "PreloadedPicBufferSize" must be set to a value >= 6563 (4 byte per pixel (red,green,blue and alpha channel), 1400 * 1200 * 4 = 6720000, divided by 1024 because unit is KB and not byte, 6720000 / 1024 = 6562.5). 732
V
Quake t_bool If true a quake constantly moves the screen. The values "QuakeForce" and "QuakeSpeed" are used as parameters for the quake. 629
S
QuakeForce t_int Number of maximum pixels the screen is moved by a quake. Value is only used if "Quake" is true. 630
S
QuakeSpeed t_int Defines how long (in milliseconds) a moved screen is shown at the same position. A higher value results in a slower quake because the same screen is shown longer. Value is only used if "Quake" is true. 631
S
RegisteredEventHandlers t_string All registered event handlers. 759
S
Reserved t_string Licence number. 369
V
RightClickAction t_link to Actions (parent) Action which is started if the right mouse button is pressed and "RightMouseClick" is set to 3 or 4. 337
V
RightClickBehaviour t_int Defines if the character will be sent to the current position when the right mouse button is clicked.Possible values:
  • 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
  • 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
  • 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
782
V/S
SavedObject t_link to Characters or Objects or Buttons Object which is currently saved to execute an action on (usually through the "Save object" action part). 486
S
SaveGameName t_string Used to store name of current savegame. 537
S
SavegameScreenshot t_path Image used as savegame screenshot for all scenes when game is played on a mobile device. 764
V
SaveNameOffsetY t_int 843
V
SceneComposedFile t_path Defines the filename for composing the scenes when compiling the game. 618
V
SceneComposedFiles t_int The number of composed scene files. Possible values:
  • 0 (eMainContainer): All scenes are stored in the main container.
  • 1 (eSingleContainer): All scenes are stored in one file specified by "SceneComposedFile".
  • 2 (eMultipleContainers): Each scene is stored in an own container specified by "SceneComposedFile" (filename extended by the scene number).
617
V
SceneLinks t_links to Scenes (parent) All scenes of the game. 117
V
ScriptLinks t_links to Scripts (parent) All scripts of the game. 651
V
ScrollCenterCharacter t_bool If true the character linked in "ScrollCharacter" will be centered on the scene (if "ScrollTo" is false). If false then no character will be centered. 561
S
ScrollCharacter t_link to Characters Character which will be centered on the current scene (if "ScrollCenterCharacter" is true and "ScrollTo" is false). 611
S
ScrollDirectionHorizontal t_int DEPRECATED 473
S
ScrollDirectionVertical t_int DEPRECATED 474
S
ScrollPosition t_point Upper left corner of current scroll position (on current scene). 470
S
ScrollSpeed t_int Number of pixels which will be scrolled in one second. 246
V/S
ScrollToPoint t_point Upper left corner the current scene is scrolling to. 471
S
ScrollTo t_bool If true the scene is currently scrolling to "ScrollToPoint". 472
S
ShaderExclude t_int Defines which components (scene, interfaces, texts, cursor) will be excluded from shader programs. Possible values:
  • 0 (eShaderExcludeNothing): standard, exclude nothing.
  • 1 (eShaderExcludeInterfaces): exclude interfaces, text on top, cursor.
  • 2 (eShaderExcludeTextsAndCursor): exclude text on top, cursor.
  • 3 (eShaderExcludeCursor): exclude cursor
787
S
ShaderLinks t_links to Shaders 820
V
ShowBlackScreenAfterVideo t_bool If true a black screen will be shown after the video is finished (until the next game scene is ready and all images are loaded). Otherwise the last frame of the video is shown until the game is continued. 763
V/S
SmoothScrolling t_bool 826
V
SpeakerSoundPanFactor t_int Speech output balance in percent. Defines if the speech output is played on left/right speaker depending on the character position. If set to 0 the speech output will be played equally on left and right speaker. If set to 100 the output volume on left/right speaker completely depends on the position of the character on the current scene. 758
V/S
SpeakerTextAlignment t_int Defines alignment of speaker text. Possible values:
  • 0 (eAlignLeft): Align left.
  • 1 (eAlignRight): Align right.
  • 2 (eAlignCentered): Centered.
  • 3 (eAlignLeftWithCenterPos): Align left (use center position).
  • 4 (eAlignRightWithCenterPos): Align right (use center position).
  • 5 (eAlignCenteredWithLeftPos): Centered (use left position).
592
V/S
SpeechLanguage t_link to Languages Defines the language which is used for speech output. If empty the language from "StandardLanguage" will be used. 755
S
StandardLanguage t_link to Languages Defines the currently used language. 306
V/S
StartAction t_link to Actions (parent) This action will be executed once at the beginning of the game (after the game was loaded). 368
V
TextAlignment t_int Defines alignment of spoken text. Possible values:
  • 0 (eAlignLeft): Align left.
  • 1 (eAlignRight): Align right.
  • 2 (eAlignCentered): Centered.
  • 3 (eAlignLeftWithCenterPos): Align left (use center position).
  • 4 (eAlignRightWithCenterPos): Align right (use center position).
  • 5 (eAlignCenteredWithLeftPos): Centered (use left position).
593
V/S
TextOutput t_int Defines if spoken texts should be printed and/or spoken. Possible values:
  • 0 (eTextAndSpeechOutput): Display text and play speech file.
  • 1 (eOnlySpeechOutput): Only play speech file.
  • 2 (eOnlyTextOutput): Only display text.
583
S
TextSpeed t_int Speed for displaying texts (in percent). Default is 100. 646
S
UsedItem t_link to Objects The currently picked up item. A picked up item is either dragged (shown instead of cursor) or displayed in the action text. 686
S
UsedItemPicked t_bool True if "UsedItem" = true and the used item is dragged (shown instead of cursor). 730
S
Version t_string Version number of the game. 627
V
VerticalScrollDistance t_int If the distance of the current character to the vertical scene border is equal or smaller than this value then the scene will be scrolled vertical to center the character (if the scene is larger than the viewable area). If this value is very small the character has to go very close to the border until the scene is scrolled, if the value is half the viewable size or larger then the character will always be centered. 668
S
VideoAudioLanguage t_string 738
S
VideosEncrypted t_bool If true the videos are stored in an encrypted container. This field is only relevant for compiled games. 699
V
VideoPauseScreen t_path 788
V
VideoSubtitleFont t_link to Fonts 735
S
VideoSubtitleLanguage t_string 737
S
VideoSubtitlePosition t_point 736
S
WalksoundBus t_link to AudioBusses 853
S
WaitCursor t_link to Cursors 880
V/S
WindowResolution t_point Screen resolution. 126
V


Interfaces

Table id: 1 (eInterfaces)

Field Type Description id Scriptable Storage
ActionTextFont t_link to Fonts Font which will be used for the action text - only used if "DrawActionText" is true. 320
V
ActionTextRect t_rect Rectangle in which the action text will be drawn horizontally and vertically centered - only used if "DrawActionText" is true. 319
V
ActiveCommand t_link to Buttons 607
S
Border t_vpoint Polygon which defines the border of the interface. The interface is detected if the cursor is inside the polygon. 325
V
Buttons t_links to Buttons (parent) All buttons of the interface: commands, arrows to scroll items, action areas, placeholder for items. 140
V
InterfaceClass t_link to InterfaceClasses The class this interface belongs to. 659
V
Conditions t_links to Conditions (parent) The conditions of the interface. 452
V
DestVisibility t_int The visibility of the interface (and all of its buttons) is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the interface will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility". 604
S
Displacement t_int Defines where the interface is shown. Possible values:
  • 0: top.
  • 1: bottom.
  • 2: left.
  • 3: right.
  • 4: absolute, position on screen defined by "Offset".
  • 5: relative, position defined by current cursor position and offset to the cursor position ("Offset").
314
V/S
DrawActionText t_bool Defines if the action text is drawn on this interface (if true then "ActionTextFont" and "ActionTextRect" must be set). 587
V
ItemsScrollPosition t_int Current scroll position of the items in the interface/inventory. 609
S
LeaveAction t_link to Actions (parent) Action which will be executed if the cursor leaves the interface (outside of polygon "Border"). 388
V
MatrixId t_int 802
S
Offset t_point Offset (or absolute position) for displaying the interface (only used if "Displacement" is 4 or 5). 302
V/S
Position t_point Absolute position of upper left corner of interface. 688
V/S
ScrollStepSize t_int Defines how many item positions will be scrolled if a scroll arrow is pushed. 138
V
ShowAlways t_bool 789
V/S
Size t_int Defines the size of the interface (in pixels). Is needed if part of the interface is drawn into the scene (e. g. flowers on top of the interface) and the interface is aligned to the border. Is only used if > 0 and "Displacement" is 0, 1, 2 or 3. 324
V/S
Sprite t_sprite Background sprite of the interface. 238
V
StandardCommand t_link to Buttons Button which is the standard command (usually "Walk to") for this interface. 298
V
TimeToDestVisibility t_int Defines the time (in milliseconds) until the visibility defined in "DestVisibility" is reached. This value is used the next time when "DestVisibility" is set. 605
S
Values t_links to Values (parent) The values of the interface. 453
V
Visibility t_int Visibility of the interface (and all of its buttons) in percent. Must be between 0 and 100. A value of 0 means the interface is not visible at all. Note that the interface can only be visible if "Active" and "Visible" are true. 603
S
Visible t_bool If true the interface is visible - supposed "Visibility" is > 0. This option can be used to toggle the interface on/off without changing "Visibility". 606
V/S


InterfaceClasses

Table id: 31 (eInterfaceClasses)

Field Type Description id Scriptable Storage
Name t_string Interface class name. The name of the object itself will be set to the translated class name. 660
V


Languages

Table id: 18 (eLanguages)

The language name is defined by the name of each language object.


Loadings

Table id: 21 (eLoadings)

Field Type Description id Scriptable Storage
Music t_path Music which is played while the loading screen is shown. 357
V
Sprite t_sprite Background sprite of the loading screen. 353
V
StatusCover t_bool If false the status sprite will grow (from zero width to full width), if true the status sprite will shrink (from full width to zero width). 356
V
StatusSprite t_sprite Sprite for progress bar. 355
V


Models

Table id: 35 (eModels)

Field Type Description id Scriptable Storage
Model t_path 706
V
Textures t_vpath 707
V


Objects

Table id: 6 (eObjects)

Field Type Description id Scriptable Storage
Actions t_links to Actions (parent) All actions of the object. "ExecutionType" defines when the action is started. 172
V
Animation t_link to Animations Animation which is automatically started if this object is active (see "Condition" and "Value"). 171
V
Animations t_links to Animations (parent) All animations of the object. 176
V
Center t_int Defines the line number (y coordinate) which decides if a character is in front or behind this object. 329
V
Condition t_link to Conditions If not empty then the object is only shown and detected by the cursor if the condition is true (or the condition is false and "ConditionNegate" is true). If this condition query results in false and a "Value" is also defined, it depends on the value whether the object is active. 169
V
ConditionNegate t_bool If true then the condition linked under "Condition" is negated. 359
V
Conditions t_links to Condition (parent) All conditions of the object. 175
V
DestVisibility t_int The visibility of the object is fading to the visibility defined by this value. Must be between 0 and 100. A value of 0 means the object will not be visible at all (but is still recognized by the cursor). The time to fade from the current visibility to "DestVisibility" is defined by "TimeToDestVisibility". 601
S
Direction t_int Direction in degrees which a character is aligned if it reaches this object ("Position"). 222
V
IsItem t_bool If true then this object is an item, otherwise it is a scene object. 350
V
IsWalkable t_bool If true then then no action can be executed on this object with the standard command (see "Interface > StandardCommand"). 384
V
MatrixId t_int 792
S
Model t_path 791
V
Name t_link to Texts (parent) The name of the object (as shown in the action text). 251
V
Offset t_point Offset for this object from its initial position. By changing the offset it is possible to move the object on a scene. The object image and all object animations will take the offset into account. Detecting an object ("Polygon") by the cursor also considers the offset. 779
S
ParticleSystem t_link to ParticleSystems DEPRECATED 467
Polygon t_vpoint Polygon which defines the border of the object. The object is detected if the cursor is inside the polygon. 341
V
Position t_point Position of the object on the scene (only used if "IsItem" is false). If the user clicked on this object then the current character walks to this position. 339
V
Rotation t_float Rotation for this object in radians (full rotation 2 pi, radian = degree * 180 / pi). The object image and all object animations will take the rotation into account. 783
S
RotationCenter t_point Coordinates (on screen) which define the center for object rotation (see "Rotation"). If set to -1,-1 (default) the image center is used as rotation center. 784
S
Scale t_float Defines the scaling factor for this object. 1.0 means 100% (original size), 2.0 would be double size and 0.5 half size. The object image and all object animations will take the scaling into account. 786
S
ScaleX t_float Factor for horizontal scaling of the button (100 is original width). 812
S
ScaleY t_float Factor for vertical scaling of the button (100 is original height). 812
S
ScrollFactorX t_int Horizontal scrolling-speed of this object in percent of screen's scrolling-speed (in %). If 100 then the object scrolls with same speed as the screen itself, otherwise it scrolls faster (> 100), slower (< 100) or not at all (0). 538
V
ScrollFactorY t_int Vertical scrolling-speed of this object in percent of screen's scrolling-speed (in %). If 100 then the object scrolls with same speed as the screen itself, otherwise it scrolls faster (> 100), slower (< 100) or not at all (0). 539
V
ShaderSet t_int Sets shader configuration id for an object and all of its animations, see "shaderSetOptions()" command. 785
S
SnoopAnimation t_link to Animations Animation which is shown when the "hotspot" (formerly known as "snoop") animations are active. The animation is only shown if the object is currently active. The "hotspot" animations can be activated with an action part. 665
V
SnoopAnimationPos t_point Absolute position of the "hotspot" (formerly known as "snoop") animation (see "SnoopAnimation") on the scene. 666
V
Sprite t_link to Sprites (parent) Sprite which is shown if the object is active. 170
V
TimeToDestVisibility t_int Defines the time (in milliseconds) until the visibility defined in "DestVisibility" is reached. This value is used the next time when "DestVisibility" is set. 602
S
Values t_links to Values (parent) All values of the object. 333
V
Value t_link to Values If not empty then the object is only shown and detected by the cursor if the value query (consisting of "Value", "ValueOperator" and "ValueInt") is met. If this query results in false and a "Condition" is also defined, it depends on the condition whether the object is active. 846
V
ValueInt t_int Integer value for querying the value linked under "Value". 848
V
ValueOperator t_int Operator for querying the value linked under "Value". Possible values:
  • 0: equals (=)
  • 1: doesn't equal (!=)
  • 2: equal or greater than (>=)
  • 3: greater than (>)
  • 4: equal or less than (<=)
  • 5: less than (<)
847
V
Visibility t_int Visibility of the object in percent. Must be between 0 and 100. A value of 0 means the object is not visible at all (but is still recognized by the cursor). 600
S


Outfits

Table id: 17 (eOutfits)

Field Type Description id Scriptable Storage
AmbientLightColor t_int The ambient light color can be used to shade a 3D model with a basic color to adapt it to the lighting conditions in the surrounding scene. 729
V/S
CameraAngle t_float This field sets the angle in degrees from which the camera shows each individual 3D model. By default, each model is shown from the front (0°), but the value range allows a model to be viewed from directly above (90°) or below (-90°). 711
V/S
CameraHeight t_float This field indicates the height of the camera relative to its 3D model. By default, the camera focuses on the center of the model, but the value range allows the camera to focus on the top (100 %) or bottom (-100 %) of the model. 710
V/S
CharacterAnimations t_links to Animations (parent) Person animations, must be started manually. 269
V
CharacterSpeed t_int Speed of character with this outfit (in pixel per second). 270
V/S
LightColor t_int The color (RGB, 1 byte per channel) of the direct light source used to shade a 3D model. 716
V/S
LightPosX t_float The first coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows. 713
V/S
LightPosY t_float The second coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows. 714
V/S
LightPosZ t_float The third coordinate of the light source used to directly light 3D models. The model itself is positioned at the origin. The light position does not influence the position of shadows. 715
V/S
LightColor t_int 716
V/S
Model t_path Path to the 3D model file used for the outfit. 708
V
ModelAmbientOcclusion t_int This field controls the intensity of self-shadowing of a 3D model in percent using ambient occlusion. A value of 0 deactivates ambient occlusion. 752
V
ModelFiles t_vpath 807
V
ModelOutlineColor t_int The color used for the contours of 3D models. 724
V/S
ModelOutlineWidth t_int The width of contours of 3D models. 725
V/S
ModelScaleFactor t_int The size of the displayed 3D model in percent. This field can be used to finetune the size or a model in the scene without changing the 3D model file. 718
V/S
ModelShadow t_int Indicates what type of shadow a 3D model casts. This can be either a simple blob shadow (1) or a realistic projected shadow (2). The value 0 disables shadows. Shadows are always cast straight downwards. 751
V
ModelShadowVisibility t_int This field controls the visibility of the shadow of a 3D model in percent. A value of 0 deactivates shadows. 750
V
ModelShowOutline t_bool This flag indicates whether outlines of a 3D model are drawn. 723
V/S
ModelTextures t_vpath This field contains a list of texture paths used to draw a 3D model. This can be used to override the texture information stored in the 3D model file. 728
V
ModelToonNuances t_int Number of nuances of brightness used for toon shading. Using a relatively low number (2-5) creates more cartoon-like lighting of a 3D model. 722
V/S
ModelTurnSpeed t_int 867
V
ModelUseToonShading t_bool This flag indicates whether toon shading is used for a 3D model. The alternative is realistic shading. 721
V/S
RandomAnimations t_links to Animation (parent)
  • For playable characters (characters with an interface): Animations are shown if the user did not interact for a longer random time span (between "RandomMinTime" and "RandomMaxTime" milliseconds).
  • For non-playable characters (characters without an interface): Animations are shown after a random time span (between "RandomMinTime" and "RandomMaxTime" milliseconds).
321
V
RandomMinTime t_int Minimum time (in milliseconds) until a random animation (see "RandomAnimations") is started. 756
V
RandomMaxTime t_int Maximum time (in milliseconds) until a random animation (see "RandomAnimations") is started. 757
V
SlideWalkAnimation t_bool If true the character position will be updated continuously during walking, otherwise the position will only be updated if a new frame of the walk animation is shown. 762
V/S
StandingAnimations t_links to Animations (parent) Standing animations, shown when person is standing. 383
V
TalkAnimations t_links to Animations (parent) Talk animations. 268
V
TurnAnimations t_links to Animations (parent) Turn animations. 810
V
UseLight t_bool 712
V/S
WalkAnimations t_links to Animations (parent) Walk animations. 267
V


ParticleContainers

Table id: 23 (eParticleContainers)

Field Type Description id Scriptable Storage
CameraZoom t_float DEPRECATED
CameraZPosition t_float DEPRECATED
LeadTime t_links to Particles (parent) DEPRECATED
Particles t_links to Particles (parent) DEPRECATED
PreviewScene t_link to Scenes Scene for particles preview. 824
V
Settings t_string Particle system settings. 806
V


Particles

Table id: 22 (eParticles)

DEPRECATED


Plugins

Table id: 39 (ePlugins)

Field Type Description id Scriptable Storage
Active t_bool 860
V
Data t_string 862
V
Directory t_string 861
V


Points

Table id: 5 (ePoints)

Field Type Description id Scriptable Storage
Position t_point Position on the scene. 146
V
Relations t_links to Points Links to connected points for way system. 147
V
Size t_int Size for character on this point (in percent). 145
V


Scenes

Table id: 4 (eScenes)

Field Type Description id Scriptable Storage
Actions t_links to Actions (parent) All actions of the scene. These actions can only be started by another action. 335
V
ActionAreas t_links to ActionAreas (parent) All action areas of the scene (areas which contain actions that are executed if a character enters or leaves the area). 681
V
AudioBusses t_links to AudioBusses 838
V
BackgroundMusic t_path Background music which is played in a loop. 132
V/S
Brightness t_int Defines the overall brightness of the scene (in percent). Must be between 0 and 100. A velue of 0 means this scene (with all its objects and characters) is completely dark (so everything is black), 100 means that everything is drawn with its original brightness. 594
S
CDTrack t_int 133
V
Conditions t_links to Conditions (parent) All conditions of the scene. 330
V
ContinueMusic t_bool If true then the background music from the last scene is continued instead of playing the background music of this scene ("BackgroundMusic"). 365
V
CurrentWaySystem t_link to WaySystems Currently used way system (only relevant if "IsMenu" is false). 641
V/S
Cursor t_link to Cursors Cursor which is displayed on this scene (only used if "IsMenu" is true). 293
V
Curves t_links to Curves 892
V
LightMap t_path Sprite which is used as a lightmap for the scene. The lightmap defines how the characters are shaded on different positions on the scene. 550
V/S
IsMenu t_bool If true then this scene is a menu (for savegames, options, etc.), otherwise it is a playable scene (where characters can move, etc.). 292
V
MusicBalance t_int Balance of the background music ("BackgroundMusic"). Must be between -100 (only left speaker) and 100 (only right speaker). 316
V/S
MusicVolume t_int Volume of the background music ("BackgroundMusic"). Must be between 0 (mute) and 100 (full volume). 315
V/S
Name t_link to Texts (parent) The name of the scene (used for name in savegames). 364
V
Objects t_links to Objects (parent) All objects of the scene. 136
V
ParticleSystem t_link to ParticleContainers Particle system of the scene which is always shown. 441
V
SavegameAreas t_vrect All areas where savegame screenshots are shown (only if "IsMenu" is true). A savegame can be selected by clicking inside an area. 322
V
SavegameFont t_link to Font Font which is used for the name of the savegame (only if "IsMenu" is true). 348
V
SavegameScreenshot t_path Image used as savegame screenshot for this scene when game is played on a mobile device. 765
V
SavegameScrollStep t_int Defines how many savegame positions will be scrolled if the savegames are scrolled with an actionpart (only if "IsMenu" is true). 323
V
SaveTextAlignment t_int Defines the alignment of the timestamp text underneath the savegames (only if "IsMenu" is true). Possible Values:
  • 0: Left.
  • 1: Right.
  • 2: Center.
930
V
SaveTextOffset t_point Defines the offset of the timestamp text underneath the savegames from its default location (only if "IsMenu" is true). 929
V
ScrollableArea t_rect Usually the scene can be scrolled to the edge in each direction. This area can limit the scrolling in each direction so the scene can not be scrolled to the edge. 568
V/S
ScrollOnEdges t_bool If true then the scene will be scrolled if the cursor is on the screen edge. 232
V/S
ShaderSet t_int Sets shader configuration id for the scene, see "shaderSetOptions()" command. 794
S
Sprite t_sprite Background sprite of the scene. 236
V
TestCharacter t_link to Characters 879
V
Values t_links to Values (parent) All values of the scene. 332
V
WaySystems t_links to WaySystems (parent) All way systems of the scene. 640
V


Scripts

Table id: 30 (eScripts)

Field Type Description id Scriptable Storage
Script t_string Script content. 652
V
Type t_string Script type. Possible Values:
  • 0: Execution script.
  • 1: Definition script.
653
V


ScriptVariables

Table id: 34 (eScriptVariables)

Field Type Description id Scriptable Storage
IsGlobalVar t_bool 697
S
Items t_links 698
S
KeyType t_int 694
S
Value t_string 696
S
ValueType t_int 695
S


Shaders

Table id: 36 (eShaders)

Field Type Description id Scriptable Storage
Compiled t_string 823
V
FS t_string 821
V
VS t_string 822
V


Sprites

Table id: 13 (eSprites)

Field Type Description id Scriptable Storage
Sprite t_sprite 237
V


Texts

Table id: 14 (eTexts)

Field Type Description id Scriptable Storage
TextLanguages t_vtext Language-dependent texts for this text entry. 761
V


TextLanguages

Table id: 19 (eTextLanguages)

Field Type Description id Scriptable Storage
Language t_link to Languages 258
V
Sound t_path 257
V
Text t_string 256
V


Values

Table id: 20 (eValues)

Field Type Description id Scriptable Storage
Float t_float The current float value. 805
V/S
Int t_int The current integer value. 328
V/S
Random t_bool If true then the value ("Int") will be set to a random value (between "RandomMin" and "RandomMax") at the beginning of the game. 345
V
RandomMax t_int Upper bound for random value (see "Random"). 347
V
RandomMin t_int Lower bound for random value (see "Random"). 346
V
String t_string The current string value. 632
V/S


WaySystems

Table id: 29 (eWaySystems)

Field Type Description id Scriptable Storage
Border t_vpoint Polygon which defines the way borders of the scene. A character is only allowed to walk inside the way borders. 638
V
Points t_links to Points (parent) Way points of the scene which store the character size. The way points are connected to each other to define where a character can walk. 639
V