Difference between revisions of "Data Structure"

From The Official Visionaire Studio: Adventure Game Engine Wiki
 
(176 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Visionaire Data Structure ==
+
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.
  
This is the official documentation of the Visionaire Data Structure.<br><br>
+
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.
  
The complete data structure is now well documented. It consists of different tables (storing different types of objects) and is stored in a XML file on disk (ved-file). Not all fields in this documentation are stored in the ved-files (project files), some of them are only created during the game and stored in the savegames. The column 'Storage' describes where each field is saved. A field with Storage 'V' is saved in the ved-file. If there is a 'S' in this column then this field is stored in savegames. If you want you can write your own tools which manipulate the ved-files to edit some settings differently than the Visionaire Editor (for fields with Storage type 'V').
+
<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>
  
Each field is accesible through scripting now. Theoretically every field can be read or written. However, in practice it does not make sense for all fields to change them because the Visionaire Player does not react to all changes and certain fields are not stored in savegames. For this purpose there is a column 'Scriptable' next to each field indicating if the field can be written. Fields which can be changed with the Scripting Language are displayed in a different color. If you want to access a field through scripting you have to use the field constants. A field constant starts with a 'V' followed by the field name. E.g. to access the field GameCurrentScene you would have to use the constant VGameCurrentScene (the scripting command could look like this: "game:getLink(VGameCurrentScene)").
+
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 table Action but once an action gets executed an object in ActiveAction will be created where the currently active action is stored.
 
<br>
 
  
== Action ==
+
'''For information on the field types and on how to access the data structure through scripting, please refer to the [[Scripting|basic scripting page]].'''
{| class="gruen" border="1"
+
 
| valign="top" |
+
 
'''Table'''
+
== Actions ==
| valign="top" |
+
Table id: 7 <small>(eActions)</small>
'''Field'''
+
{| class="ts sortable"
| valign="top" |
+
|-
'''Field Type'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Description'''
+
! class="unsortable" | Description
| valign="top" align="center" |
+
! style="width:3%" | id
'''Scriptable'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Storage'''
 
 
|-
 
|-
| rowspan="4" valign="top" |
+
| ActionParts
Action
+
| t_links to [[#ActionParts|ActionParts]] (parent)
| valign="top" |
+
| Action parts of this action. The action parts will be executed if this action is started.
ActionActionParts
+
| 162
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_links to [[#ActionPart|ActionPart]] (parent)
+
| class="cent" | V
| valign="top" |
 
Actionparts of this action. The actionparts will be executed if this action is started.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Command
ActionCommand
+
| t_link to [[#Buttons|Buttons]]
| valign="top" |
+
| Command which must be active to execute this action.
t_link to [[#Button|Button]]
+
| 161
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Command which must be active to execute this action.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ExecutionType
ActionExecutionType
+
| t_int
| valign="top" |
+
| Defines when the action is started. Possible values:
t_int
+
* 0 (eExecutionTypeRightMouseClick): Right mouse button click.
| valign="top" |
+
* 1 (eExecutionTypeMouseEntersArea): Cursor enters area.
Defines when the action is started.<br>
+
* 2 (eExecutionTypeMouseLeavesArea): Cursor leaves area.
'0': right mouse button click.<br>
+
* 3 (eExecutionTypeFixtureDropped): Item dropped.
'1': cursor enters area.<br>
+
* 5 (eExecutionTypeCalledByOtherAction): Called by other action.
'2': cursor leaves area.<br>
+
* 6 (eExecutionTypeActionCommand): Command executed.
'3': item dropped.<br>
+
* 7 (eExecutionTypeLeftMouseClickIm): Left mouse click.
'5': called by an other action.<br>
+
* 8: Character reached object.
'6': command executed.<br>
+
* 12 (eExecutionTypeLeftMouseDblClick): Left mouse button double click.
'7': left mouse click.<br>
+
* 13 (eExecutionTypeLeftMouseDblClickIm): Left mouse button double click (immediate execution).
'8': character reached object.<br>
+
* 14 (eExecutionTypeLeftMouseHold): Left mouse button hold.
'12': left mouse button double click.<br>
+
* 15 (eExecutionTypeLeftMouseHoldIm): Left mouse button hold (immediate execution).
'13': left mouse button double click (immediate execution).<br>
+
* 16 (eExecutionTypeRightMouseClickIm): Right mouse button click (immediate execution).
'14': left mouse button hold.<br>
+
* 17 (eExecutionTypeActionCommandIm): Command executed (immediate execution).
'15': left mouse button hold (immediate execution).<br>
+
* 18 (eExecutionTypeCommandMouseClickIm): Command mouse click (immediate execution).
'16': right mouse button click (immediate execution).<br>
+
* 19 (eExecutionTypeCombinedCommandMouseClickIm): Combined command mouse click (immediate execution).
'17': command executed (immediate execution).<br>
+
* 20 (eExecutionTypeFixtureDroppedIm): Item dropped (immediate execution).
'20': item dropped (immediate execution).<br>
+
* 21 (eExecutionTypeActionCommandBoth): Command executed - both.
'21': command executed - both.<br>
+
* 22 (eExecutionTypeActionCommandImBoth): Command executed - both (immediate execution).
'22': command executed - both (immediate execution).<br>
+
* 23 (eExecutionTypeActionCommandOther): Command executed - other.
'23': command executed - other.<br>
+
* 24 (eExecutionTypeActionCommandImOther): Command executed - other (immediate execution).
'24': command executed - other (immediate execution).<br>
+
* 25 (eExecutionTypeFixtureDroppedBoth): Item dropped - both.
'25': item dropped - both.<br>
+
* 26 (eExecutionTypeFixtureDroppedImBoth): Item dropped - both (immediate execution).
'26': item dropped - both (immediate execution).<br>
+
* 27 (eExecutionTypeFixtureDroppedOther): Item dropped - other.
'27': item dropped - other.<br>
+
* 28 (eExecutionTypeFixtureDroppedImOther): Item dropped - other (immediate execution).
'28': item dropped - other (immediate execution).<br>
+
* 29: Character enters area.
'29': character enters area.<br>
+
* 30: Character leaves area.
'30': character leaves area.<br>
+
* 31 (eAtBeginningOfScene): At beginning of scene.
| valign="top" align="center" |
+
* 32 (eAtEndOfScene): At end of scene.
-
+
| 159
| valign="top" align="center" |
+
| class="cent" | <div class="cross"></div>
V
+
| class="cent" | V
 
|-
 
|-
| valign="top" |
+
| Fixture
ActionFixture
+
| t_link to [[#Objects|Objects]]
| valign="top" |
+
| Item which is necessary to execute this action.
t_link to [[#Object|Object]]
+
| 160
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Item which is necessary to execute this action.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== ActionArea ==
+
 
{| class="gruen" border="1"
+
== ActionAreas ==
| valign="top" |
+
Table id: 32 <small>(eActionAreas)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="2" valign="top" |
+
! style="width:15%" | Field
ActionArea
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
ActionAreaActions
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_links to [[#AreaAction|AreaAction]] (parent)
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
The actions which will be executed if a character enters or leaves the action area (see ActionAreaPolygon).
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Actions
ActionAreaPolygon
+
| t_links to [[#AreaActions|AreaActions]] (parent)
| valign="top" |
+
| The actions which will be executed if a character enters or leaves the action area.
t_vpoint
+
| 675
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Polygon which defines the border of this action area. If a character enters or leaves this polygon then the actions from ActionAreaActions are executed.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| Polygon
| valign="top" align="center" |
+
| t_vpoint
V
+
| 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|}
 
|}
  
== ActionPart ==
+
 
{| class="gruen" border="1"
+
== ActionParts ==
| valign="top" |
+
Table id: 8 <small>(eActionParts)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| AltInt
'''Storage'''
+
| 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| rowspan="7" valign="top" |
+
| AltInt2
ActionPart
+
|t_int
| valign="top" |
+
| 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.
ActionPartAltInt
+
| 591
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_int
+
| class="cent" | V
| valign="top" |
 
Parameter #2. Defined by ActionPartCommand.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| AltLink
ActionPartAltInt2
+
| t_link (parent if link to [[#Texts|Texts]])
| valign="top" |
+
| 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.
t_int
+
| 290
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Parameter #3. Defined by ActionPartCommand.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Command
ActionPartAltLink
+
| t_int
| valign="top" |
+
| Action part type (constant number). See [[Actionparts Documentation]] for all action part types.
t_link
+
| 179
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Link to desired object #2. The type of the link object (e.g. Scene, Interface, Character) is defined by ActionPartCommand.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Int
ActionPartCommand
+
| t_int
| valign="top" |
+
| 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.
t_int
+
| 242
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Actionpart type. See [[Actionparts Documentation]] for all action part types.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Link
ActionPartInt
+
| t_link (parent if link to [[#Texts|Texts]])
| valign="top" |
+
| 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.
t_int
+
| 180
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Parameter #1. Defined by ActionPartCommand.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Path
ActionPartLink
+
| t_path
| valign="top" |
+
| 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.
t_link (parent if link to [[#Text|Text]])
+
| 181
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Link to desired object. The type of the link object (e.g. Scene, Interface, Character) is defined by ActionPartCommand.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| String
ActionPartPath
+
| t_string
| valign="top" |
+
| 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.
t_path
+
| 654
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Path to a file (e.g. sound file, movie file, image file).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== ActiveAction ==
+
 
{| class="gruen" border="1"
+
== ActiveActions ==
| valign="top" |
+
Table id: 25 <small>(eActiveActions)</small>
'''Table'''
+
 
| valign="top" |
+
''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'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="5" valign="top" |
+
! style="width:15%" | Field
ActiveAction
+
! style="width:15%" class="unsortable" | Type
| valign="top" class="scriptable" |
+
! class="unsortable" | Description
ActionActionPartIndex
+
! style="width:3%" | id
| valign="top" class="scriptable" |
+
! style="width:5%" class="unsortable" | Scriptable
t_int
+
! style="width:5%" class="unsortable" | Storage
| valign="top" class="scriptable" |
 
Index of current active actionpart inside this action. If changing the current action part you have to make sure that ActionContinueWaitForEndIfElse is also correct for the new action part index.
 
| valign="top" align="center" class="scriptable" |
 
Yes
 
| valign="top" align="center" class="scriptable" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
ActionContinueWaitForEndIfElse
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Total number of open if statements in this action at current position. Use with care.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ActionPartIndex
ActionActionPartStarted
+
| t_int
| valign="top" |
+
| 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.
t_bool
+
| 489
| valign="top" |
+
| class="cent" | <div class="tick"></div>
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.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ActionPartStarted
ActionPauseTime
+
| t_bool
| valign="top" |
+
|True if the current action part is already started, e.&nbsp;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.
t_int
+
| 488
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Time past since last timer was started. Only valid if ActionTimerStarted is true.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ContinueWaitForEndIfElse
ActionTimerStarted
+
| t_int
| valign="top" |
+
| Total number of open if statements in this action at current position. Use with care.
t_bool
+
| 490
| valign="top" |
+
|  class="cent" | <div class="tick"></div>
True if there is currently a timer running (e.g. waiting for pause).
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| PauseTime
| valign="top" align="center" |
+
| t_int
S
+
| Time past since last timer was started. Only valid if "TimerStarted" is true.
 +
| 492
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| TimerStarted
 +
| t_bool
 +
| True if there is currently a timer running (e.&nbsp;g. waiting for pause).
 +
| 491
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| SavedObject
 +
| t_link to [[#Actions|Actions]]
 +
| Link to the original action object.
 +
| 625
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| SavedValue
 +
| t_int
 +
|
 +
| 842
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 
|}
 
|}
  
== ActiveAnimation ==
+
 
{| class="gruen" border="1"
+
== ActiveAnimations ==
| valign="top" |
+
Table id: 26 <small>(eActiveAnimations)</small>
'''Table'''
+
 
| valign="top" |
+
''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'''
+
{| class="ts sortable"
| valign="top" |
+
|-
'''Field Type'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Description'''
+
! class="unsortable" | Description
| valign="top" align="center" |
+
! style="width:3%" | id
'''Scriptable'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Storage'''
 
 
|-
 
|-
| rowspan="15" valign="top" |
+
| Active
ActiveAnimation
+
| t_bool
| valign="top" class="scriptable" |
+
| 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.
AnimationActive
+
| 580
| valign="top" class="scriptable" |
+
| class="cent" | <div class="tick"></div>
t_bool
+
| class="cent" | S
| valign="top" class="scriptable" |
 
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.
 
| valign="top" align="center" class="scriptable" |
 
Yes
 
| valign="top" align="center" class="scriptable" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
AnimationCalledTime
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Time (in msec) past since frame was first shown or animation loop finished.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
AnimationCurrentPosition
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Position on scene of animation (each frame can have an offset to the animation which is defined in each sprite).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
AnimationCurrentSpriteIndex
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Index of currently active frame.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
AnimationCurrentSpritePos
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Position on scene of currently active frame.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
AnimationFirstFrame
 
| valign="top" |
 
t_int
 
| valign="top" |
 
First frame of the animation to show. Default value is 1, so the animation is shown with the first available frame.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| CalledTime
AnimationFrameCount
+
| t_int
| valign="top" |
+
| Time past (in milliseconds) since frame was first shown or animation loop finished.
t_int
+
| 497
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Total number of frames already shown in the current animation loop.
+
| class="cent" | S
| valign="top" align="center" |
+
|-  
-
+
| CurrentPosition
| valign="top" align="center" |
+
| t_point
S
+
| Position of animation on scene (each frame can have an offset to the animation which is defined in each sprite).
|- class="scriptable"
+
| 496
| valign="top" |
+
| class="cent" | <div class="tick"></div>
AnimationLastFrame
+
| class="cent" | S
| valign="top" |
+
|-  
t_int
+
| CurrentSpriteIndex
| valign="top" |
+
| 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.
+
| Index of currently active frame.
| valign="top" align="center" |
+
| 494
Yes
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | S
S
+
|-  
|- class="scriptable"
+
| CurrentSpritePos
| valign="top" |
+
| t_point
AnimationLoops
+
| Position of currently active frame on scene.
| valign="top" |
+
| 495
t_int
+
| class="cent" | <div class="tick"></div>
| valign="top" |
+
| class="cent" | S
Number of animation loops remaining (the current animation loop is also counted). 0 means infinite animation loops.
+
|-  
| valign="top" align="center" |
+
| FirstFrame
Yes
+
| t_int
| valign="top" align="center" |
+
| First frame of the animation to show. Default value is 1, so the animation is shown with the first available frame.
S
+
| 644
|- class="scriptable"
+
| class="cent" | <div class="tick"></div>  
| valign="top" |
+
| class="cent" | S
AnimationPlayOppositeDirection
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
True if the animation is played backwards.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
AnimationPreloaded
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
True if the animation is preloaded. If it is preloaded the value of AnimationActive defines if the animation is shown or just kept in memory.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
AnimationSize
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Scaling of animation in percent (100 means animation is played in original size, < 100: animation is shrinked, > 100: animation is enlarged).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| FrameCount
AnimationStartedByUser
+
| t_int
| valign="top" |
+
| Total number of frames already shown in the current animation loop.
t_bool
+
| 542
| valign="top" |
+
| class="cent" | <div class="cross"></div>
True if the animation was started by the user through an action part. Used internally to know which animations must be stored in savegames.
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| LastFrame
| valign="top" align="center" |
+
| t_int
S
+
| 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Loops
 +
| t_int
 +
| Number of animation loops remaining (the current animation loop is also counted). 0 means infinite animation loops.
 +
| 493
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| PlayOppositeDirection
 +
| t_bool
 +
| True if the animation is played backwards.
 +
| 541
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| valign="top" |
+
| SavedObject
AnimationWaiting
+
| t_link to [[#Animations|Animations]]
| valign="top" |
+
| Link to the original animation object.
t_bool
+
| 626
| valign="top" |
+
| class="cent" | <div class="cross"></div>
True if animation is currently waiting for next animation loop (e.g. if there is a random pause between animation loops).
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| Size
| valign="top" align="center" |
+
| t_int
S
+
| Scaling of animation in percent (100 means animation is played in original size).
|- class="scriptable"
+
| 499
| valign="top" |
+
| class="cent" | <div class="tick"></div>
AnimationWaitingTime
+
| class="cent" | S
| valign="top" |
+
|-
t_int
+
| StartedByUser
| valign="top" |
+
| t_bool
Total time (in msec) currently waiting between two animation loops. Only valid if AnimationWaiting is true.
+
| True if the animation was started by the user through an action part. Used internally to know which animations must be stored in savegames.
| valign="top" align="center" |
+
| 691
Yes
+
| class="cent" | <div class="cross"></div>
| valign="top" align="center" |
+
| class="cent" | S
S
+
|-
 +
| Waiting
 +
| t_bool
 +
| True if animation is currently waiting for next animation loop (e.&nbsp;g. if there is a random pause between animation loops).
 +
| 500
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-  
 +
| WaitingTime
 +
| t_int
 +
| Total time (in milliseconds) currently waiting between two animation loops. Only valid if "Waiting" is true.
 +
| 501
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|}
 
|}
  
== ActiveText ==
+
 
{| class="gruen" border="1"
+
== ActiveTexts ==
| valign="top" |
+
Table id: 24 <small>(eActiveTexts)</small>
'''Table'''
+
 
| valign="top" |
+
''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'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="10" valign="top" |
+
! style="width:15%" | Field
ActiveText
+
! style="width:15%" class="unsortable" | Type
| valign="top" class="scriptable" |
+
! class="unsortable" | Description
TextActive
+
! style="width:3%" | id
| valign="top" class="scriptable" |
+
! style="width:5%" class="unsortable" | Scriptable
t_bool
+
! style="width:5%" class="unsortable" | Storage
| valign="top" class="scriptable" |
 
True if the text is currently active.
 
| valign="top" align="center" class="scriptable" |
 
Yes
 
| valign="top" align="center" class="scriptable" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Alignment
TextBackground
+
| t_int
| valign="top" |
+
| Defines alignment of text. Possible values:
t_bool
+
* 0 (eAlignLeft): Align left.
| valign="top" |
+
* 1 (eAlignRight): Align right.
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).
+
* 2 (eAlignCentered): Centered.
| valign="top" align="center" |
+
* 3 (eAlignLeftWithCenterPos): Align left (use center position).
-
+
* 4 (eAlignRightWithCenterPos): Align right (use center position).
| valign="top" align="center" |
+
* 5 (eAlignCenteredWithLeftPos): Centered (use left position).
S
+
| 744
|- class="scriptable"
+
| class="cent" | <div class="tick"></div>
| valign="top" |
+
| class="cent" | S
TextCurrentText
 
| valign="top" |
 
t_string
 
| valign="top" |
 
Currently shown text. This is a part of the whole text between pause-tags or the whole text if there are no pause-tags.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
TextFont
 
| valign="top" |
 
t_link to [[#Font|Font]]
 
| valign="top" |
 
Font used for displaying this text.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Active
TextOwner
+
| t_bool
| valign="top" |
+
| True if the text is currently active.
t_link to [[#Character|Character]] or [[#Object|Object]] or [[#Button|Button]]
+
| 529
| valign="top" |
+
| class="cent" | <div class="tick"></div>
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.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
TextPosition
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Position on scene where the text is shown.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
TextRemainingText
 
| valign="top" |
 
t_string
 
| valign="top" |
 
Remaining text after TextCurrentText.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Background
TextTimeElapsed
+
| t_bool
| valign="top" |
+
| 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).
t_int
+
| 527
| valign="top" |
+
| class="cent" | <div class="cross"></div>
time (in msec) elapsed since showing current part (TextCurrentText) of text.
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| CurrentText
| valign="top" align="center" |
+
| t_string
S
+
| Currently shown text. This is a part of the whole text between pause-tags or the whole text if there are no pause-tags.
|- class="scriptable"
+
| 522
| valign="top" |
+
| class="cent" | <div class="tick"></div>
TextTimeToWait
+
| class="cent" | S
| valign="top" |
+
|-
t_int
+
| Font
| valign="top" |
+
| t_link to [[#Fonts|Fonts]]
Total time (in msec) for showing current part (TextCurrentText) of text.
+
| Font used for displaying this text.
| valign="top" align="center" |
+
| 526
Yes
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | S
S
 
 
|-
 
|-
| valign="top" |
+
| Owner
TextWaitForAudio
+
| t_link to [[#Characters|Characters]] or [[#Objects|Objects]] or [[#Buttons|Buttons]]
| valign="top" |
+
| 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.
t_bool
+
| 684
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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.
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| Position
| valign="top" align="center" |
+
| t_point
S
+
| Position on scene where the text is shown.
 +
| 523
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| RemainingText
 +
| t_string
 +
| Remaining text after TextCurrentText.
 +
| 521
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| SavedObject
 +
| t_link to [[#Texts|Texts]]
 +
| Link to the original text object.
 +
| 624
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| TimeElapsed
 +
| t_int
 +
| time (in msec) elapsed since showing current part (TextCurrentText) of text.
 +
| 525
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| TimeToWait
 +
| t_int
 +
| Total time (in msec) for showing current part (TextCurrentText) of text.
 +
| 524
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 
|}
 
|}
  
== Animation ==
+
 
{| class="gruen" border="1"
+
== Animations ==
| valign="top" |
+
Table id: 9 <small>(eAnimations)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| Action
'''Storage'''
+
| t_link to [[#Actions|Actions]]
 +
| Action which is started when the animation is finished.
 +
| 190
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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.&nbsp;g. used for hotspot of cursor or feet center of character animation).
 +
| 367
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Direction
 +
| t_int
 +
| Defines the direction in degrees (0-359) this animation should be used for (only for character animations).
 +
| 285
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| rowspan="15" valign="top" |
+
| EndDirection
Animation
+
| t_int
| valign="top" |
+
| Defines the end direction for turn animations in degrees (0-359).
AnimationAction
+
| 811
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_link to [[#Action|Action]]
+
| class="cent" | V
| valign="top" |
 
Action which is started when the animation is finished.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LoopRandom
AnimationCenter
+
| t_bool
| valign="top" |
+
| If true then there is a random pause between 2 loops of the animation. If false the next loop is shown immediately.
t_point
+
| 184
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Mirror
AnimationDirection
+
| t_link to [[#Animations|Animations]]
| valign="top" |
+
| 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).
t_int
+
| 284
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the direction in degress ('0' - '359') this animation should be used for (only for character animations).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ModelAnimIndex
AnimationLoopRandom
+
| t_int
| valign="top" |
+
| 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.
t_bool
+
| 726
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then there is a random pause between 2 loops of the animation. If false the next loop is shown immediately.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ModelAnimSpeed
AnimationMirror
+
| t_int
| valign="top" |
+
| 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.
t_link to [[#Animation|Animation]]
+
| 727
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Move
AnimationModelAnimIndex (3.6)
+
| t_bool
| valign="top" |
+
| 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).
t_int
+
| 338
| valign="top" |
+
| class="cent" | <div class="cross"></div>
TODO
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| NumberOfLoops
AnimationModelAnimSpeed (3.6)
+
| t_int
| valign="top" |
+
| Number of loops. Set to 0 if it is an endless animation.
t_int
+
| 187
| valign="top" |
+
| class="cent" | <div class="cross"></div>
TODO
+
| class="cent" |V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Pause
AnimationMove
+
| t_int
| valign="top" |
+
| Time (in milliseconds) between two frames of the animation. Is only used if "UseIndividualPause" is false (otherwise the pause is stored in each sprite).
t_bool
+
| 188
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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)
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Pauses
AnimationNumberOfLoops
+
| t_vint
| valign="top" |
+
|
t_int
+
| 849
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Number of loops. '0' if it is an endless animation.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Position
AnimationPause
+
| t_point
| valign="top" |
+
| Upper left corner of animation on scene (or interface).
t_int
+
| 189
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Time in milli seconds between two frames of the animation. Is only used if AnimationUseIndividualPause is false (otherwise the pause is stored in each sprite).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| PropertyFrames
AnimationPosition
+
| t_links to [[#AnimationFrames|AnimationFrames]] (parent)
| valign="top" |
+
| Frames with special properties which will be used when the frame of the animation (identified by "FrameIndex") is shown.
t_point
+
| 576
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Upper left corner of animation on scene (or interface).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Replay
AnimationPropertyFrames
+
| t_int
| valign="top" |
+
| Possible values:
t_links to [[#AnimationFrame|AnimationFrame]] (parent)
+
* 0 (eReplayNormal): animation loops are shown in normal order.
| valign="top" |
+
* 1 (eReplayReverse): each loop of the animation is shown in reverse order.
Frames with special properties which will be used when the frame of the animation (identified by AnimationFrameIndex) is shown.
+
* 2 (eReplayRandom): all frames of an animation loop are shown in random order.
| valign="top" align="center" |
+
| 656
-
+
| class="cent" | <div class="cross"></div>
| valign="top" align="center" |
+
| class="cent" | V
V
 
 
|-
 
|-
| valign="top" |
+
| Sprites
AnimationReplay
+
| t_vsprites
| valign="top" |
+
| All sprites of the animation.
t_int
+
| 235
| valign="top" |
+
| class="cent" | <div class="cross"></div>
eReplayNormal ('0'): animation loops are shown in normal order.<br/>
+
| class="cent" | V
eReplayReverse ('1'): each loop of the animation is shown in reverse order.<br/>
 
eReplayRandom ('2'): all frames of an animation loop are shown in random order.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| UseIndividualPause
AnimationSprites
+
| t_bool
| valign="top" |
+
| 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.
t_vsprites
+
| 344
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All sprites of the animation.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| WalkSteps
AnimationUseIndividualPause
+
| t_vfloat
| valign="top" |
+
| 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.
t_bool
+
| 760
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then the pause between two frames of the animation is stored in each sprite. If false then AnimationPause is used for the pause between two frames.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== AnimationFrame ==
+
 
{| class="gruen" border="1"
+
== AnimationFrames ==
| valign="top" |
+
Table id: 28 <small>(eAnimationFrames)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="5" valign="top" |
+
! style="width:15%" | Field
AnimationFrame
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
AnimationFrameAction
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_link to [[#Action|Action]]
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
An action which will be started when this frame is shown.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Action
AnimationFrameIndex
+
| t_link to [[#Actions|Actions]]
| valign="top" |
+
| An action which will be started when this frame is shown.
t_int
+
| 575
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 AnimationPropertyFrames.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Index
AnimationFrameSound
+
| t_int
| valign="top" |
+
| 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".
t_path
+
| 571
| valign="top" |
+
| class="cent" | <div class="cross"></div>
A sound which will be played when this frame is shown.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Sound
AnimationFrameSoundBalance
+
| t_path
| valign="top" |
+
| A sound which will be played when this frame is shown.
t_int
+
| 572
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Balance of the sound (AnimationFrameSound). Must be between '-100' (only left speaker) and '100' (only right speaker).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SoundBalance
AnimationFrameSoundVolume
+
| t_int
| valign="top" |
+
| Balance of the sound (as defined in "Sound"). Must be between -100 (only left speaker) and 100 (only right speaker).
t_int
+
| 574
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Volume of the sound (AnimationFrameSound). Must be between '0' (mute) and '100' (full volume).
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| SoundVolume
| valign="top" align="center" |
+
| t_int
V
+
| Volume of the sound (as defined in "Sound"). Must be between 0 (mute) and 100 (full volume).
 +
| 573
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|}
 
|}
  
== AreaAction ==
+
 
{| class="gruen" border="1"
+
== AreaActions ==
| valign="top" |
+
Table id: 33 <small>(eAreaActions)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="3" valign="top" |
+
! style="width:15%" | Field
AreaAction
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
AreaActionAction
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_link to [[#Action|Action]] (parent)
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
The action to execute if all conditions are fulfilled (see AreaActionCharacter and AreaActionExecuteAlways). The execution type of the action (ActionExecutionType) must also match the character either entering or leaving the area (type is either '29' (CharacterEntersArea) or '30' (CharacterLeavesArea)).
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Action
AreaActionCharacter
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| 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)).
t_link to [[#Character|Character]]
+
| 680
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If set the action is only executed if the specified character enters/leaves (see ActionExecutionType) the area. If not set then the action is executed for all characters.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Character
AreaActionExecuteAlways
+
| t_link to [[#Characters|Characters]]
| valign="top" |
+
| 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.
t_bool
+
| 678
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| ExecuteAlways
| valign="top" align="center" |
+
| t_bool
V
+
| 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|}
 
|}
  
== Button ==
+
 
{| class="gruen" border="1"
+
== AudioBusses ==
| valign="top" |
+
Table id: 37 <small>(eAudioBusses)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="18" valign="top" |
+
! style="width:15%" | Field
Button
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
ButtonActions
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_links to [[#Action|Action]] (parent)
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
All actions of this button.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Events
ButtonActiveSprite
+
| t_links to [[#Events|Events]]
| valign="top" |
+
|  
t_link to [[#Sprite|Sprite]] (parent)
+
| 837
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Sprite which is shown if the button is active. If ButtonType is '3' or '6' (command) and this button is currently selected then the button is active. If ButtonType 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.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LinkedObjects
ButtonAnimation
+
| t_links to [[#Objects|Objects]]
| valign="top" |
+
|  
t_link to [[#Animation|Animation]]
+
| 881
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Animation which will be played automatically if the button is shown (see ButtonCondition).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Links
ButtonAnimations
+
| t_links
| valign="top" |
+
|  
t_links to [[#Animation|Animation]] (parent)
+
| 830
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All animations of the button.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| OutputBus
ButtonCommandType
+
| t_link to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|  
t_int
+
| 850
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Only used if the button is a command (ButtonType = '3' or '6'). Defines the type of this command:<br>
+
| class="cent" | V
'0' (eButtonNormal): normal command (e.g. 'Look at', 'Push'). <br>
 
'1' (eButtonCombined): combined command (e.g. 'Use', 'Give').<br>
 
'2' (eButtonGive): give command (e.g. 'Give').<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Setings
ButtonCondition
+
| t_string
| valign="top" |
+
|  
t_link to [[#Condition|Condition]]
+
| 831
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If ButtonCondition is not empty then the button is only shown and detected by the cursor if the conidition is true (or the condition is false and ButtonConditionNegate is true).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Type
ButtonConditionNegate
+
| t_int
| valign="top" |
+
|
t_bool
+
| 829
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then the condition ButtonCondition is negated. (see ButtonCondition)
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Values
ButtonConjunction
+
| t_links to [[#Values|Values]]
| valign="top" |
+
|  
t_link to [[#Text|Text]]
+
| 837
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 (ButtonType = '3' or '6' and ButtonCommandType = '1' or '2').
+
| class="cent" | V
| valign="top" align="center" |
+
|}
-
+
 
| valign="top" align="center" |
+
 
V
+
== Blocks ==
 +
Table id: 41 <small>(eBlocks)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
ButtonCursor
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_link to [[#Cursor|Cursor]]
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
Only used if button is a command (ButtonType = '3' or '6'). The cursor which is shown if the command is active.
+
! style="width:5%" class="unsortable" | Storage
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Active
ButtonDraggable
+
| t_bool
| valign="top" |
+
|  
t_bool
+
| 878
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 GameDraggableItems is true and ButtonType of this button is '3').
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Config
ButtonGroup
+
| t_string
| valign="top" |
+
|  
t_links to [[#Button|Button]]
+
| 874
| valign="top" |
+
| class="cent" | <div class="cross"></div>
List of commands (ButtonType 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).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Links
ButtonInactiveSprite
+
| t_links
| valign="top" |
+
|  
t_link to [[#Sprite|Sprite]] (parent)
+
| 873
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Sprite which is shown if the button is inactive. (see ButtonActiveSprite)
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Position
ButtonName
+
| t_point
| valign="top" |
+
|  
t_link to [[#Text|Text]]
+
| 876
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Only used if button is a command (ButtonType = '3' or '6'). The name of the command which is shown in the action text.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Type
ButtonPolygon
+
| t_int
| valign="top" |
+
|
t_vpoint
+
| 889
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Polygon which defines the border of the button. The button is detected if the cursor is inside the polygon.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| TypeName
ButtonType
+
| t_string
| valign="top" |
+
|
t_int
+
| 875
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the type of this button:<br>
+
| class="cent" | V
'0' (eButtonPlaceholder): Placeholder for an item.<br>
+
|}
'1' (eButtonScrollUp): Scroll arrow to scroll items up. (number of items to scroll is defined by InterfaceScollStepSize)<br>
+
 
'2' (eButtonScrollDown): Scroll arrow to scroll items down. (number of items to scroll is defined by InterfaceScollStepSize)<br>
+
 
'3' (eButtonCommand): Command.<br>
+
== BlockContainers ==
'4' (eButtonActionArea): Action area. (only used to define individual actions for an area)<br>
+
Table id: 40 <small>(eBlockContainers)</small>
'5' (eButtonCommandGroup): Command group. (buttons in the group defined by ButtonGroup)<br>
+
{| class="ts sortable"
'6' (eButtonCommandInGroup): Command in a command group (group defined by ButtonGroup). 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).<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
ButtonUse
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_int
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
Only used if button is a command (ButtonType = '3' or '6'). Defines on what the command can be used on:<br>
+
! style="width:5%" class="unsortable" | Storage
'0' (eUseOnAll): on objects (scene objects and items) and characters.<br>
 
'1' (eUseOnCharacters): only on characters.<br>
 
'2' (eUseOnObjects): only on objects (scene objects and items).<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Blocks
ButtonUseOnCurrentCharacter
+
| t_links to [[#Blocks|Blocks]]
| valign="top" |
+
|
t_bool
+
| 870
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Only used if button is a command (ButtonType = '3' or '6') and ButtonUse 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.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== Character ==
+
 
{| class="gruen" border="1"
+
== Buttons ==
| valign="top" |
+
Table id: 2 <small>(eButtons)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="45" valign="top" |
+
! style="width:15%" | Field
Character
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
CharacterActions
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_links to [[#Action|Action]] (parent)
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
All actions of the character.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
CharacterActive
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
If true the character is shown and detected by the cursor. (default)
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterActiveCommand
 
| valign="top" |
 
t_link to [[#Button|Button]]
 
| valign="top" |
 
Currently active command for this character. The button must have ButtonType = '3'.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Actions
CharacterActiveDialogFont
+
| t_links to [[#Actions|Actions]] (parent)
| valign="top" |
+
| All actions of this button.
t_link to [[#Font|Font]]
+
| 455
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Font which is used for a currently selected dialog part.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
CharacterAnimIndex
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Index for character animations. If there is more than one animation for a direction (e.g. two talk animations for direction 90 degrees) this value decides which animation is used. The index starts with '0' (default, use first animation).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ActiveSprite
CharacterAnimState
+
| t_link to [[#Sprites|Sprites]] (parent)
| valign="top" |
+
| 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").
t_int
+
| 342
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Type of currently playing character animation:<br>
+
| class="cent" | V
'0': No animation.<br>
 
'1': Individual character animation.<br>
 
'2': Random animation.<br>
 
'3': Talk animation.<br>
 
'4': Standing animation.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Animation
CharacterCommentSets
+
| t_link to [[#Animations|Animations]]
| valign="top" |
+
| Animation which will be played automatically if the button is shown (see "Condition").
t_links to [[#CommentSet|CommentSet]] (parent)
+
| 545
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All comment sets of the character.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Animations
CharacterConditions
+
| t_links to [[#Animations|Animations]] (parent)
| valign="top" |
+
| All animations of the button.
t_links to [[#Condition|Condition]] (parent)
+
| 546
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All conditions of the character.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
CharacterCurrentCommentSet
 
| valign="top" |
 
t_link to [[#CommentSet|CommentSet]]
 
| valign="top" |
 
Currently used comment set.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterCurrentOutfit
 
| valign="top" |
 
t_link to [[#Outfit|Outfit]]
 
| valign="top" |
 
Currently used outfit.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterDestination
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Destination where the character is currently walking to.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterDestinationObject
 
| valign="top" |
 
t_point
 
| valign="top" |
 
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 GameDestinationCommand, GameDestinationItem and GameDestinationItemPicked).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterDestVisibility
 
| valign="top" |
 
t_int
 
| valign="top" |
 
The visibility of the character is fading to the visibility defined by this value. Must be between '0' and '100'. '0' means the character will not be visible at all (but is still recognized by the cursor), '100' means the character will be completely visible (default). The time to fade from the current visibility to CharacterDestVisibility is defined by CharacterTimeToDestVisibility.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| CommandType
CharacterDialogActiveScrollDown
+
| t_int
| valign="top" |
+
| Only used if the button is a command ("Type" = 3 or 6). Defines the type of this command. Possible values:
t_sprite
+
* 0 (eButtonNormal): normal command (e.&nbsp;g. "Look at", "Push").
| valign="top" |
+
* 1 (eButtonCombined): combined command (e.&nbsp;g. "Use", "Give").
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 (CharacterDialogArea). (makes only sense for characters which can be controlled by the user)
+
* 2 (eButtonGive): give command (e.&nbsp;g. "Give").
| valign="top" align="center" |
+
| 612
-
+
| class="cent" | <div class="cross"></div>
| valign="top" align="center" |
+
| class="cent" | V
V
 
 
|-
 
|-
| valign="top" |
+
| Condition
CharacterDialogActiveScrollUp
+
| t_link to [[#Conditions|Conditions]]
| valign="top" |
+
| 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.
t_sprite
+
| 543
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 (CharacterDialogArea).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ConditionNegate
CharacterDialogArea
+
| t_bool
| valign="top" |
+
| If true then the condition linked under "Condition" is negated.
t_rect
+
| 544
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the absolute position on the screen where the dialog is displayed.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Conjunction
CharacterDialogCursor
+
| t_link to [[#Texts|Texts]]
| valign="top" |
+
| 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).
t_link to [[#Cursor|Cursor]]
+
| 296
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Cursor which will be displayed if a dialog is currently active.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Cursor
CharacterDialogInactiveScrollUp
+
| t_link to [[#Cursors|Cursors]]
| valign="top" |
+
| Only used if button is a command ("Type" = 3 or 6). The cursor which is shown if the command is active.
t_sprite
+
| 229
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 (CharacterDialogArea).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Draggable
CharacterDialogInactiveScrollDown
+
| t_bool
| valign="top" |
+
| 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).
t_sprite
+
| 567
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 (CharacterDialogArea).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Group
CharacterDialogs
+
| t_links to [[#Buttons|Buttons]]
| valign="top" |
+
| 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).
t_links to [[#Dialog|Dialog]] (parent)
+
| 584
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All dialogs which can be spoken with this character.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| InactiveSprite
CharacterDialogSprite
+
| t_link to [[#Sprites|Sprites]] (parent)
| valign="top" |
+
| Sprite which is shown if the button is inactive (also see "ActiveSprite").
t_sprite
+
| 343
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Sprite which is used as a background for dialogs.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| MatrixId
CharacterDialogVerticalSpace
+
| t_int
| valign="top" |
+
|  
t_int
+
| 800
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Distance between two dialog part selections (in pixel).
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
CharacterDirection
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Direction (in degress from 0 to 360) the character is currently looking at. Always 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 CharacterDirection is set to 80 then the second animation is shown).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterFollowAction
 
| valign="top" |
 
t_link to [[#Action|Action]]
 
| valign="top" |
 
Action which is executed if this character is following another character (CharacterFollowCharacter) and the other character is within reach (less pixel than CharacterFollowReachDistance).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterFollowCharacter
 
| valign="top" |
 
t_link to [[#Character|Character]]
 
| valign="top" |
 
Character which this character is currently following.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterFollowReachDistance
 
| valign="top" |
 
t_link to [[#Action|Action]]
 
| valign="top" |
 
If this character is following another character (CharacterFollowCharacter) this value defines (in pixel) when the other character is within reach (see CharacterFollowAction).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Name
CharacterFont
+
| t_link to [[#Texts|Texts]]
| valign="top" |
+
| Only used if button is a command ("Type" = 3 or 6). The name of the command which is shown in the action text.
t_link to [[#Font|Font]]
+
| 295
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Font which is used for all texts which are spoken by this character.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Polygon
CharacterInactiveDialogFont
+
| t_vpoint
| valign="top" |
+
| Polygon which defines the border of the button. The button is detected if the cursor is inside the polygon.
t_link to [[#Font|Font]]
+
| 454
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Font which is used for all dialog parts except the selected one (see CharacterActiveDialogFont).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Rotation
CharacterInterfaces
+
| t_float
| valign="top" |
+
| Defines the rotation in degrees.
t_links to [[#Interface|Interface]]
+
| 796
| valign="top" |
+
| class="cent" | <div class="tick"></div>
All interfaces currently used for this character.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterItems
 
| valign="top" |
 
t_links to [[#Object|Object]]
 
| valign="top" |
 
All items which are picked up by this character.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| RotationCenter
CharacterItemsScrollPosition
+
| t_point
| valign="top" |
+
| Defines the center point of rotation.
t_int
+
| 797
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Current scroll position of the items in the interface/inventory.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Scale
CharacterName
+
| t_float
| valign="top" |
+
| Factor for scaling of the button (100 is original size).
t_link to [[#Text|Text]]
+
| 799
| valign="top" |
+
| class="cent" | <div class="tick"></div>
The name of the character (as shown in the action text).
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ScaleX
CharacterOutfits
+
| t_float
| valign="top" |
+
| Factor for horizontal scaling of the button (100 is original width).
t_links to [[#Outfit|Outfit]] (parent)
+
| 814
| valign="top" |
+
| class="cent" | <div class="tick"></div>
All outfits of the character.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
CharacterPosition
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Current position of character.
 
| valign="top" align="center" |
 
Yes (if field is set and character is walking it will stop walking)
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterScale
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
If false the character is not scaled and will always be drawn in the original size.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
CharacterScaleFactor
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Factor in % the character is scaled with. Must be > '0' (default '100').
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterScene
 
| valign="top" |
 
t_link to [[#Scene|Scene]]
 
| valign="top" |
 
Scene where the character is currently on.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ScaleY
CharacterStartObject
+
| t_float
| valign="top" |
+
| Factor for vertical scaling of the button (100 is original height).
t_link to [[#Object|Object]]
+
| 815
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Scene object where the character is standing (ObjectPosition) at the beginning of the game.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
CharacterState
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Current state of character:<br>
 
'2': standing.<br>
 
'3': walking.<br>
 
| valign="top" align="center" |
 
Yes (only set to '2' to stop walking, do not set '3')
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterTimeToDestVisibility
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines the time in milli seconds until the visibility CharacterDestVisibility is reached. This value is used the next time when CharacterDestVisibility is set.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
CharacterTint
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Color 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.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ShaderSet
CharacterValues
+
| t_int
| valign="top" |
+
| Sets shader configuration id for a button and all of its animations, see "shaderSetOptions()" command.
t_links to [[#Value|Value]] (parent)
+
| 798
| valign="top" |
+
| class="cent" | <div class="tick"></div>
All values of the character.
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| Type
| valign="top" align="center" |
+
| t_int
V
+
| Defines the type of this button. Possible values:
|- class="scriptable"
+
* 0 (eButtonPlaceholder): Placeholder for an item.
| valign="top" |
+
* 1 (eButtonScrollUp): Scroll arrow to scroll items up (number of items to scroll is defined by "Interface > ScollStepSize").
CharacterVisibility
+
* 2 (eButtonScrollDown): Scroll arrow to scroll items down (number of items to scroll is defined by "Interface > ScollStepSize").
| valign="top" |
+
* 3 (eButtonCommand): Command.
t_int
+
* 4 (eButtonActionArea): Action area (only used to define individual actions for an area).
| valign="top" |
+
* 5 (eButtonCommandGroup): Command group (buttons in the group defined by "Group").
Visibility of the character in %. Must be between '0' and '100'. '0' means the character is not visible at all (but is still recognized by the cursor), '100' means the character is completely visible (default).
+
* 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).
| valign="top" align="center" |
+
| 297
Yes
+
| class="cent" | <div class="cross"></div>
| valign="top" align="center" |
+
| class="cent" | V
S
+
|-
|- class="scriptable"
+
| Use
| valign="top" |
+
| t_int
CharacterWalkingSound
+
| Only used if button is a command ("Type" = 3 or 6). Defines on what the command can be used on. Possible values:
| valign="top" |
+
* 0 (eUseOnAll): on objects (scene objects and items) and characters.
t_path
+
* 1 (eUseOnCharacters): only on characters.
| valign="top" |
+
* 2 (eUseOnObjects): only on objects (scene objects and items).
Sound which is played if the character is walking.
+
| 336
| valign="top" align="center" |
+
| class="cent" | <div class="cross"></div>
Yes
+
| class="cent" | V
| valign="top" align="center" |
+
|-
V/S
+
| 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Value
 +
| t_link to [[#Values|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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ValueInt
 +
| t_int
 +
| Integer value for querying the value linked under "Value".
 +
| 884
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|}
 
|}
  
== CommentSet ==
+
 
{| class="gruen" border="1"
+
== Characters ==
| valign="top" |
+
Table id: 0 <small>(eCharacters)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| ActionCharacter
'''Storage'''
+
| t_link to [[#Characters|Characters]]
 +
|
 +
| 505
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| Actions
 +
| t_links to [[#Actions|Actions]] (parent)
 +
| All actions of the character.
 +
| 280
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| rowspan="1" valign="top" |
+
| Active
CommentSet
+
| t_bool
| valign="top" |
+
| If true (default) the character is shown and detected by the cursor.
CommentSetEntries
+
| 502
| valign="top" |
+
| class="cent" | <div class="tick"></div>
t_links to [[#CommentSetEntry|CommentSetEntry]]
+
| class="cent" | S
| valign="top" |
+
|-
All comment set entries of this comment set.
+
| ActiveCommand
| valign="top" align="center" |
+
| t_link to [[#Buttons|Buttons]]
-
+
| Currently active command for this character. The button must have "Type" = 3.
| valign="top" align="center" |
+
| 517
V
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| ActiveDialogFont
 +
| t_link to [[#Fonts|Fonts]]
 +
| Font which is used for a currently hovered dialog part.
 +
| 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" | V
 +
|-
 +
| AnimIndex
 +
| 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" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| AudioBus
 +
| t_link to [[#AudioBusses|AudioBusses]]
 +
|
 +
| 855
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| CommentSets
 +
| t_links to [[#CommentSets|CommentSets]] (parent)
 +
| All comment sets of the character.
 +
| 282
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Conditions
 +
| t_links to [[#Conditions|Conditions]]
 +
| All conditions of the character.
 +
| 331
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| CurrentCommentSet
 +
| t_link to [[#CommentSets|CommentSets]]
 +
| Currently used comment set.
 +
| 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" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| DialogArea
 +
| t_rect
 +
| Defines the absolutely positioned rectangle on the screen where the dialog is displayed.
 +
| 458
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| DialogCursor
 +
| t_link to [[#Cursors|Cursors]]
 +
| Cursor which will be displayed if a dialog is currently active.
 +
| 283
 +
| class="cent" | <div class="cross"></div>
 +
| 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
 +
|-
 +
| 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Dialogs
 +
| t_links to [[#Dialogs|Dialogs]]
 +
| All dialogs which can be spoken with this character.
 +
| 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" | 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.&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" | S
 +
|-
 +
| FollowAction
 +
| t_link to [[#Actions|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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| FollowCharacter
 +
| t_link to [[#Characters|Characters]]
 +
| Character which this character is currently following.
 +
| 504
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Font
 +
| t_link to [[#Fonts|Fonts]]
 +
| Font which is used for all texts which are spoken by this character.
 +
| 275
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| HarmonizeWalkAnimations
 +
| t_bool
 +
|
 +
| 839
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| InactiveDialogFont
 +
| t_link to [[#Fonts|Fonts]]
 +
| Font which is used for all dialog parts except the one currently hovered (see "ActiveDialogFont").
 +
| 581
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| InactiveUsedDialogFont
 +
| t_link to [[#Fonts|Fonts]]
 +
| Font which is used for all previously selected dialog parts except the one currently hovered (see "ActiveUsedDialogFont").
 +
| 919
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| Interfaces
 +
| t_links to [[#Interfaces|Interfaces]]
 +
| All interfaces currently used for this character.
 +
| 585
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V/S
 +
|-
 +
| Items
 +
| t_links to [[#Objects|Objects]]
 +
| All items which are picked up by this character.
 +
| 663
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| LightmapActive
 +
| t_bool
 +
|
 +
| 801
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| MatrixId
 +
| t_int
 +
|
 +
| 793
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Name
 +
| t_link to [[#Texts|Texts]]
 +
| The name of the character (as shown in the action text).
 +
| 271
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Outfits
 +
| t_links to [[#Outfits|Outfits]] (parent)
 +
| All outfits of the character.
 +
| 281
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Position
 +
| t_point
 +
| Current position of character (if field is set and character is walking, then it will stop walking).
 +
| 512
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| Scale
 +
| 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
 +
|-
 +
| ScaleFactor
 +
| 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
 +
| t_link to [[#Scenes|Scenes]]
 +
| Scene where the character is currently on.
 +
| 503
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| ShaderSet
 +
| t_int
 +
| Sets shader configuration id for a character, see "shaderSetOptions()" command.
 +
| 795
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | S
 +
|-
 +
| StartObject
 +
| t_link to [[#Objects|Objects]]
 +
| Scene object where the character is standing ("Object > Position") at the beginning of the game.
 +
| 311
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| 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
 
|}
 
|}
  
== CommentSetEntry ==
+
 
{| class="gruen" border="1"
+
== CommentSets ==
| valign="top" |
+
Table id: 16 <small>(eCommentSets)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="2" valign="top" |
+
! style="width:15%" | Field
CommentSetEntry
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
CommentSetEntryText
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_link to [[#Text|Text]]
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
Text for this comment.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Entries
CommentSetEntryCommand
+
| t_links to [[#CommentSetEntries|CommentSetEntries]]
| valign="top" |
+
| All comment set entries of this comment set.
t_link to [[#Button|Button]]
+
| 557
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If empty this comment set entry is a standard comment set entry (used for all comments). If this link is a command (ButtonType 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.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== Condition ==
+
 
{| class="gruen" border="1"
+
== CommentSetEntries ==
| valign="top" |
+
Table id: 27 <small>(eCommentSetEntries)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="8" valign="top" |
+
! style="width:15%" | Field
TCondition
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
ConditionCondition1
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_link to [[#Condition|Condition]]
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
First condition for a combined condition (only used if ConditionIsVariable is false).
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Command
ConditionCondition1Negate
+
| t_link to [[#Buttons|Buttons]]
| valign="top" |
+
| 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.
t_bool
+
| 560
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then ConditionCondition1 will be negated (only used if ConditionIsVariable is false).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Text
ConditionCondition2
+
| t_link to [[#Texts|Texts]]
| valign="top" |
+
| Text for this comment.
t_link to [[#Condition|Condition]]
+
| 559
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Second condition for a combined condition (only used if ConditionIsVariable is false).
+
| class="cent" | V
| valign="top" align="center" |
+
|}
-
+
 
| valign="top" align="center" |
+
 
V
+
== Conditions ==
 +
Table id: 10 <small>(eConditions)</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
 
|-
 
|-
| valign="top" |
+
| Conditions
ConditionCondition2Negate
+
| t_links to [[#Conditions|Conditions]]
| valign="top" |
+
| All conditions of a combined condition (only used if "IsVariable" is false).
t_bool
+
| 844
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then ConditionCondition2 will be negated (only used if ConditionIsVariable is false).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ConditionsNegate
ConditionIsVariable
+
|  
| valign="top" |
+
| Table of booleans corresponding to the conditions linked in "Conditions". If true the correspoding condition will be negated (only used if "IsVariable" is false).
t_bool
+
| 845
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true this condition only contains true or false. If false this condition is a combined condition (see ConditionCondition1, ConditionCondition2).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| IsVariable
ConditionOperator
+
| t_bool
| valign="top" |
+
| If true this condition only contains true or false. If false this condition is a combined condition (see "Conditions", "ConditionsNegate").
t_int
+
| 193
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines how ConditionCondition1 and ConditionCondition2 are combined (only used if ConditionIsVariable is false):<br>
+
| class="cent" | V
'0': logical AND.<br>
 
'1': logical OR.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Operator
ConditionReturnNegate
+
| t_int
| valign="top" |
+
| Defines how the conditions of a combined condition (linked in "Conditions") are combined (only used if "IsVariable" is false). Possible values:
t_bool
+
* 0: logical AND.
| valign="top" |
+
* 1: logical OR.
If true then the combined result of ConditionCondition1 and ConditionCondition2 will be negated (only used if ConditionIsVariable is false).
+
| 198
| valign="top" align="center" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
+
|-
V
+
| ReturnNegate
|- class="scriptable"
+
| t_bool
| valign="top" |
+
| If true then the combined result of "Conditions" will be negated (only used if "IsVariable" is false).
ConditionValue
+
| 195
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_bool
+
| class="cent" | V
| valign="top" |
+
|-  
Current value of condition. True or false. This is only used if ConditionIsVariable is true.
+
| Value
| valign="top" align="center" |
+
| t_bool
Yes
+
| Current value of the condition (true or false). This is only used if "IsVariable" is true.
| valign="top" align="center" |
+
| 194
V/S
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|}
 
|}
  
== Cursor ==
+
 
{| class="gruen" border="1"
+
== Cursors ==
| valign="top" |
+
Table id: 15 <small>(eCursors)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="3" valign="top" |
+
! style="width:15%" | Field
Cursor
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
CursorActiveAnimation
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_link to [[#Animation|Animation]]
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
Animation of the active cursor.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ActiveAnimation
CursorHotspot
+
| t_link to [[#Animations|Animations]]
| valign="top" |
+
| Animation of the active cursor.
t_point
+
| 647
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Point on the cursor which defines the 'center' of the cursor.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| InactiveAnimation
CursorInactiveAnimation
+
| t_link to [[#Animations|Animations]]
| valign="top" |
+
| Animation of the inactive cursor.
t_link to [[#Animation|Animation]]
+
| 648
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Animation of the inactive cursor.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== Dialog ==
+
 
{| class="gruen" border="1"
+
== Curves ==
| valign="top" |
+
Table id: 42 <small>(eCurves)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| Points
'''Storage'''
+
| t_vpoint
 +
|  
 +
| 895
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Type
 +
| t_int
 +
|
 +
| 896
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Dialogs ==
 +
Table id: 11 <small>(eDialogs)</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
 +
|-
 +
| DialogParts
 +
| t_links to [[#DialogParts|DialogParts]] (parent)
 +
| All dialog part selections of this dialog.
 +
| 202
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| rowspan="8" valign="top" |
+
| Character
Dialog
+
| t_link to [[#Characters|Characters]]
| valign="top" |
+
|  
DialogDialogParts
+
| 825
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_links to [[#DialogPart|DialogPart]] (parent)
+
| class="cent" | V
| valign="top" |
 
All dialog part selections of this dialog.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== DialogPart ==
+
 
{| class="gruen" border="1"
+
== DialogParts ==
| valign="top" |
+
Table id: 12 <small>(eDialogParts)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="12" valign="top" |
+
| Action
DialogPart
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| Action which is executed if this dialog part is selected. It is not allowed to start a dialog in this action.
DialogPartAction
+
| 206
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_link to [[#Action|Action]] (parent)
+
| class="cent" | V
| valign="top" |
 
Action which is executed if this dialog part is selected. It is not allowed to start a dialog in this action.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| AltText
DialogPartAltText
+
| t_link to [[#Texts|Texts]] (parent)
| valign="top" |
+
| Text which is spoken by the current character (only used if "UseAltText" is true, otherwise "Text" is spoken).
t_link to [[#Text|Text]] (parent)
+
| 465
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Text which is spoken by the current character (only used if DialogPartUseAltText is true, otherwise DialogPartText is spoken).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| AnswerText
DialogPartAnswerText
+
| t_link to [[#Texts|Texts]] (parent)
| valign="top" |
+
| Text which is spoken by the other character (character where the dialog belongs to) after the text is spoken by the current character.
t_link to [[#Text|Text]] (parent)
+
| 286
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Text which is spoken by the other character (character where the dialog belongs to) after the text is spoken by the current character.
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| Available
| valign="top" align="center" |
+
| t_bool
V
+
| If true then this dialog part is still available (see "Remove").
|- class="scriptable"
+
| 317
| valign="top" |
+
| class="cent" | <div class="tick"></div>
DialogPartAvailable
+
| class="cent" | S
| valign="top" |
 
t_bool
 
| valign="top" |
 
If true then this dialog part is still available (see DialogPartRemove).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Condition
DialogPartCondition
+
| t_link to [[#Conditions|Conditions]]
| valign="top" |
+
| 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.
t_link to [[#Condition|Condition]]
+
| 204
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The dialog part selection is only shown if the condition is true (or the condition is false and DialogPartConditionNegate is true).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ConditionNegate
DialogPartConditionNegate
+
| t_bool
| valign="top" |
+
| If true then the condition linked under "Condition" is negated.
t_bool
+
| 614
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then the condition DialogPartCondition is negated. (see DialogPartCondition)
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LinkedAction
DialogPartLinkedAction
+
| t_link to [[#Actions|Actions]]
| valign="top" |
+
| 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.
t_link to [[#Action|Action]]
+
| 655
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Action which is executed if this dialog part is selected and the link DialogPartAction is empty. It is not allowed to start a dialog in this action.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| NextDialog
DialogPartNextDialog
+
| t_link to [[#Dialogs|Dialogs]] (parent)
| valign="top" |
+
| Dialog which is shown when this dialog part is selected.
t_link to [[#Dialog|Dialog]] (parent)
+
| 289
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Dialog which is shown when this dialog part is selected.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| Remove
| valign="top" align="center" |
+
| t_bool
V
+
| If true then this dialog part can only be selected once ("Available" will be set to false after selection).
 +
| 288
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Text
 +
| t_link to [[#Texts|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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| UseAltText
 +
| t_bool
 +
| If true then "AltText" will be spoken by the current character, otherwise "Text".
 +
| 466
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Value
 +
| t_link to [[#Values|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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ValueInt
 +
| t_int
 +
| Integer value for querying the value linked under "Value".
 +
| 887
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Events ==
 +
Table id: 38 <small>(eEvents)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
DialogPartRemove
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_bool
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
If true then this dialog part can only be selected once (DialogPartAvailable will be set to false after selection).
+
! style="width:5%" class="unsortable" | Storage
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Action
DialogPartReturn
+
| t_link
| valign="top" |
+
|  
t_int
+
| 864
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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):<br />
+
| class="cent" | V
'0' (eDialogReturnToSame): the same dialog will be shown again.<br />
 
'1' (eDialogReturnToUpper): the 'upper' dialog (which linked to the current dialog) will be shown.<br />
 
'2' (eDialogReturnToEnd): no dialog will be shown.<br />
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| StartBus
DialogPartText
+
| t_link to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|  
t_link to [[#Text|Text]] (parent)
+
| 865
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Text which is shown as a selection in the dialog. Further it is spoken by the current character if DialogPartUseAltText is false.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| StopBus
DialogPartUseAltText
+
| t_link to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|
t_bool
+
| 866
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then DialogPartAltText will be spoken by the current character, otherwise DialogPartText.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== Font ==
+
 
{| class="gruen" border="1"
+
== Fonts ==
| valign="top" |
+
Table id: 3 <small>(eFonts)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| Alphabet
'''Storage'''
+
| 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| Border
 +
| t_bool
 +
| If true a font border will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true).
 +
| 774
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 +
|-
 +
| Kerning
 +
| t_string
 +
| Defines spacings for individual letters or pairs of letters. This value is only used for bitmap fonts ("TrueTypeFont" = false).
 +
| 703
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V
 
|-
 
|-
| rowspan="8" valign="top" |
+
| Letters
Font
+
| t_vrect
| valign="top" |
+
| 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).
FontAlphabet
+
| 143
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_string
+
| class="cent" | V
| valign="top" |
 
A string which contains all characters of the font. The characters have to be in the same order as they appear in the sprite FontSprite (from left to right and top to bottom).
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LetterSpacing
FontAutoLineBreak
+
| t_int
| valign="top" |
+
| Horizontal distance between two characters (in pixel). This value is only used for bitmap fonts ("TrueTypeFont" = false).
t_bool
+
| 250
| valign="top" |
+
| class="cent" | <div class="tick"></div>
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 FontLineWidth.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LineWidth
FontLetters
+
| t_int
| valign="top" |
+
| Maximum line width (in pixel) for automatic line break. This value is only used if "AutoLineBreak" is true.
t_vrect
+
| 635
| valign="top" |
+
| class="cent" | <div class="tick"></div>
List of rectangles where each rectangle contains the position of a single character on the sprite (FontSprite).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Shadow
FontLetterSpacing
+
| t_bool
| valign="top" |
+
| If true a font shadow will be drawn. This value is only used for TrueType fonts ("TrueTypeFont" = true).
t_int
+
| 777
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Horizontal distance between two characters (in pixel).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ShadowOffset
FontLineWidth
+
| t_point
| valign="top" |
+
| Offset in pixels for font shadow (see "Shadow").
t_int
+
| 778
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Maximum line width (in pixel) for automatic line break. This value is only used if FontAutoLineBreak is true.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Size
FontSpaceWidth
+
| t_float
| valign="top" |
+
| Font size in pixels. This value is only used for TrueType fonts ("TrueTypeFont" = true).
t_int
+
| 772
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Width of space (in pixel).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SpaceWidth
FontSprite
+
| t_int
| valign="top" |
+
| Width of space (in pixels). This value is only used for bitmap fonts ("TrueTypeFont" = false).
t_sprite
+
| 623
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Sprite with all characters of the font.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Sprite
FontVerticalLetterSpacing
+
| t_sprite
| valign="top" |
+
| Sprite with all characters of the font. This value is only used for bitmap fonts ("TrueTypeFont" = false).
t_int
+
| 248
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Vertical distance between two characters (in pixel).
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| TrueTypeFont
| valign="top" align="center" |
+
| t_bool
V
+
| 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
 
|}
 
|}
  
== Game ==
+
 
{| class="gruen" border="1"
+
== game ==
| valign="top" |
+
Table id: -1 <small>(eGame)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="101" valign="top" |
+
! style="width:15%" | Field
Game
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
GameAbout
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_string
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
Long description of game, authors can make additional comments here.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| About
GameActions
+
| t_string
| valign="top" |
+
| Long description of game, authors can make additional comments here.
t_links to [[#Action|Action]] (parent)
+
| 125
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All actions which can be started with a key. The key value is stored in ActionExecutionType.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Actions
GameActionTextFont
+
| t_links to [[#Actions|Actions]] (parent)
| valign="top" |
+
| All actions which can be started with a key. The key value is stored in "Action > ExecutionType".
t_link to [[#Font|Font]]
+
| 318
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Font which will be used for the action text - only used if GameDrawActionText is '1' or '2'.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ActionTextFont
GameActionTextRect
+
| t_link to [[#Fonts|Fonts]]
| valign="top" |
+
| Font which will be used for the action text (only used if "DrawActionText" is 1 or 2).
t_rect
+
| 589
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Rectangle in which the action text will be drawn horizontally and vertically centered - only used if GameDrawActionText is '2'.
+
| class="cent" | V/S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
GameActiveCommand
 
| valign="top" |
 
t_link to [[#Button|Button]]
 
| valign="top" |
 
The currently active command.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| ActionTextRect
GameAlignCharacterOnImExecution
+
| t_rect
| valign="top" |
+
| Rectangle in which the action text will be drawn horizontally and vertically centered (only used if "DrawActionText" is 2).
t_bool
+
| 590
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true the active character will be automatically aligned to the clicked object when an action with execution type 'immediate' is executed.
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| ActiveCommand
| valign="top" align="center" |
+
| t_link to [[#Buttons|Buttons]]
V
+
| The currently active command.
|- class="scriptable"
+
| 610
| valign="top" |
+
| class="cent" | <div class="tick"></div>
GameAlwaysAllowSkipText
+
| class="cent" | V/S
| valign="top" |
 
t_bool
 
| valign="top" |
 
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).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameAutoHideInterfacesInMenu
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
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.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| AlignCharacterOnImExecution
GameCharacterComposedFile
+
| t_bool
| valign="top" |
+
| If true the active character will be automatically aligned to the clicked object when an action with an "immediate" execution type is executed.
t_path
+
| 582
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the filename for composing the character when compiling the game.
+
| class="cent" | V/S
| valign="top" align="center" |
+
|-
-
+
| AlwaysAllowSkipText
| valign="top" align="center" |
+
| t_bool
V
+
| 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" | V/S
 
|-
 
|-
| valign="top" |
+
| AudioContainerLinks
GameCharacterComposedFiles
+
| t_links to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|  
t_int
+
| 835
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The number of composed character files:<br>
+
| class="cent" | V
'0' (eMainContainer): All characters are stored in the main container.<br>
 
'1' (eSingleContainer): All characters are stored in one file specified by GameCharacterComposedFile.<br>
 
'2' (eMultipleContainers): Each character is stored in an own container specified by GameCharacterComposedFile (filename extended by the character number).<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| AudioMixLinks
GameCharacterLinks
+
| t_links to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|  
t_links to [[#Character|Character]] (parent)
+
| 834
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All characters of the game.
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| AutoHideInterfacesInMenu
| valign="top" align="center" |
+
| t_bool
V
+
| 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.
|- class="scriptable"
+
| 628
| valign="top" |
+
| class="cent" | <div class="tick"></div>
GameCommandBehaviour
+
| class="cent" | V/S
| valign="top" |
 
t_int
 
| valign="top" |
 
Behavior for selecting the standard command.<br>
 
'0'(eStdCommandAlways): set standard command after executing an action.<br>
 
'1' (eSetStdCommandNever): never set standard command.<br>
 
'2' (eSetStdCommandOnSuccess): set standard command after successful execution of an action.<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Behaviours
GameCompanyName
+
| t_links
| valign="top" |
+
|
t_string
+
| 890
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The company name is used for the path where the savegames are stored. E.g. on an English Windows Vista the path could look like this: C:\Users\&lt;UserName&gt;\AppData\Local\&lt;CompanyName&gt;\&lt;GameName&gt;\Savegames. If no company name or game name is specified the savegames are stored in the directory below the ved-file directory.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| BlockContainers
GameComposedFile
+
| t_links
| valign="top" |
+
|
t_path
+
| 877
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the filename for composing the main output file (.vis file) when compiling the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
|- class="scriptable"
+
| BuildOptions
| valign="top" |
+
| t_string
GameCurrentCharacter
+
|  
| valign="top" |
+
| 819
t_link to [[#Character|Character]]
+
| class="cent" | <div class="cross"></div>
| valign="top" |
+
| class="cent" | V
Character which is currently controlled by the player (active character).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| BuildRules
GameCurrentObject
+
| t_vstring
| valign="top" |
+
|  
t_link to [[#Object|Object]] or [[#Character|Character]] or [[#Button|Button]]
+
| 804
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The object currently below the cursor.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameCurrentScene
 
| valign="top" |
 
t_link to [[#Scene|Scene]]
 
| valign="top" |
 
Scene which is currently shown.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameCursorHorizontalScrollDistance
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Distance of cursor to the left or right screen border where horizontal scrolling will be started.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameCursorVerticalScrollDistance
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Distance of cursor to the top or bottom screen border where vertical scrolling will be started.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| CharacterComposedFile
GameCursors
+
| t_path
| valign="top" |
+
| Defines the filename for composing the character when compiling the game.
t_links to [[#Cursor|Cursor]] (parent)
+
| 620
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All cursors of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| CharacterComposedFiles
GameCutsceneAction
+
| t_int
| valign="top" |
+
| The number of composed character files. Possible values:
t_link to [[#Action|Action]]
+
* 0 (eMainContainer): All characters are stored in the main container.
| valign="top" |
+
* 1 (eSingleContainer): All characters are stored in one file specified by "CharacterComposedFile".
If a cutscene is active this links to the action which started (and should stop) the cutscene.
+
* 2 (eMultipleContainers): Each character is stored in an own container specified by "CharacterComposedFile" (filename extended by the character number).
| valign="top" align="center" |
+
| 619
-
+
| class="cent" | <div class="cross"></div>
| valign="top" align="center" |
+
| class="cent" | V
S
 
 
|-
 
|-
| valign="top" |
+
| CharacterLinks
GameDescription
+
| t_links to [[#Characters|Characters]] (parent)
| valign="top" |
+
| All characters of the game.
t_string
+
| 118
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Short description of the game.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| CommandBehaviour
| valign="top" align="center" |
+
| t_int
V
+
| Behavior for selecting the standard command. Possible values:
|- class="scriptable"
+
* 0 (eStdCommandAlways): set standard command after executing an action.
| valign="top" |
+
* 1 (eSetStdCommandNever): never set standard command.
GameDestinationCommand
+
* 2 (eSetStdCommandOnSuccess): set standard command after successful execution of an action.
| valign="top" |
+
| 244
t_link to [[#Button|Button]]
+
| class="cent" | <div class="tick"></div>
| valign="top" |
+
| class="cent" | V/S
When the user clicked on an object and the character walks to this object, this command will be executed when the object is reached.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameDestinationEvent
 
| valign="top" |
 
t_int
 
| valign="top" |
 
When the user clicked on an object and the character walks to this object, this event will be executed when the object is reached:<br>
 
'0': no event.<br>
 
'1': left mousebutton click.<br>
 
'2': right mousebutton click.<br>
 
'3': left mousebutton double click.<br>
 
'4': left mousebutton hold.<br>
 
'5': mouse enters area.<br>
 
'6': mouse leaves area.<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameDestinationItem
 
| valign="top" |
 
t_link to [[#Object|Object]]
 
| valign="top" |
 
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.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameDestinationItemPicked
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
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 GameDragableObjects). Then the item in GameDestinationItem will be dropped on the object when it is reached.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| CompanyName
GameDialog
+
| t_string
| valign="top" |
+
| 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>.
t_link to [[#Dialog|Dialog]]
+
| 700
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Currently displayed dialog.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ComposedFile
GameDialogAction
+
| t_path
| valign="top" |
+
| Defines the filename for composing the main output file (.vis file) when compiling the game.
t_link to [[#Action|Action]]
+
| 616
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Running action which contains the text for the current dialog.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameDraggableItems
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
True if objects can be dragged from the interface.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameDrawActionText
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines if and where the action text is drawn:<br>
 
'0' (eDrawNoActionText): do not draw action text.<br>
 
'1' (eDrawActionTextAtCurrentPos): draw action text at current cursor position.<br>
 
'2' (eDrawActionTextAtRect): draw action text centered in the rectangle defined by GameActionTextRect.<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameExecuteActionsDuringDialog
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
If true the game actions GameActions (activated by a key) will also be executed if a dialog is currently displayed.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
|- class="scriptable"
+
| Containers
| valign="top" |
+
| t_vstring
GameFadeDelay
+
|  
| valign="top" |
+
| 803
t_int
+
| class="cent" | <div class="cross"></div>
| valign="top" |
+
| class="cent" | V
Delay in milli seconds for fade in/out of a scene.
+
|-  
| valign="top" align="center" |
+
| CurrentCharacter
Yes
+
| t_link to [[#Characters|Characters]]
| valign="top" align="center" |
+
| Character which is currently controlled by the player (active character).
V/S
+
| 468
|- class="scriptable"
+
| class="cent" | <div class="tick"></div>
| valign="top" |
+
| class="cent" | S
GameFadeEffect
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Effect for fade in/out of a scene.<br>
 
'0' (eFadeNo): no effect. display new scene immediately.<br>
 
'1' (eFadeIn): fade in. Only fade in new scene. No fade out of current scene.<br>
 
'2' (eFadeOut): fade out. Only fade out current scene. No fade in of new scene.<br>
 
'3' (eFadeInAndOut): fade in/out. Fade out current scene and fade in new scene.<br>
 
'4' (eFadeToNew): fade to new. Use alpha-blending to directly fade from current to new scene.<br>
 
'5' (eShiftLeft): shift left. Shift current scene to the left and show new scene.<br>
 
'6' (eShiftRight): shift right. Shift current scene to the right and show new scene.<br>
 
'7' (eTunnelEffect): tunnel effect. Use a tunnel effect for fade in/out.<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| CurrentObject
GameFirstCharacter
+
| t_link to [[#Objects|Objects]] or [[#Characters|Characters]] or [[#Buttons|Buttons]]
| valign="top" |
+
| The object currently below the cursor.
t_link to [[#Character|Character]]
+
| 687
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Character which is used for starting the game. This is the character which is controlled by the player.
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| CurrentScene
| valign="top" align="center" |
+
| t_link to [[#Scenes|Scenes]]
V
+
| 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
 
|-
 
|-
| valign="top" |
+
| Cursor
GameFirstScene
+
| t_link to [[#Cursors|Cursors]]
| valign="top" |
+
|  
t_link to [[#Scene|Scene]]
+
| 856
| valign="top" |
+
| class="cent" | <div class="tick"></div>
The first scene of the game (which is shown after the loading screen)
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| CursorHorizontalScrollDistance
| valign="top" align="center" |
+
| t_int
V
+
| 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
 
|-
 
|-
| valign="top" |
+
| Cursors
GameFontLinks
+
| t_links to [[#Cursors|Cursors]] (parent)
| valign="top" |
+
| All cursors of the game.
t_links to [[#Font|Font]] (parent)
+
| 215
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All fonts of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| CustomActionParts
GameFullScreenIntro
+
| t_vstring
| valign="top" |
+
| All custom action parts from installed action part plugins.
t_bool
+
| 857
| valign="top" |
+
| class="cent" | <div class="cross"></div>
True if the intro movie is scaled to fullscreen.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| CutsceneAction
GameGameComposedFile
+
| t_link to [[#Actions|Actions]]
| valign="top" |
+
| If a cutscene is active this links to the action which started (and should stop) the cutscene.
t_path
+
| 633
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| DefaultMusicBus
GameGameComposedFiles
+
| t_link to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|  
t_int
+
| 854
| valign="top" |
+
| class="cent" | <div class="tick"></div>
The number of composed game files:<br>
+
| class="cent" | S
'0' (eMainContainer): The game object is stored in the main container.<br>
 
'1' (eSingleContainer): The game object is stored in one file specified by GameGameComposedFile.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| DefaultSoundBus
GameGameName
+
| t_link to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|
t_string
+
| 852
| valign="top" |
+
| class="cent" | <div class="tick"></div>
The game name is used for the path where the savegames are stored. E.g. on an English Windows Vista the path could look like this: C:\Users\&lt;UserName&gt;\AppData\Local\&lt;CompanyName&gt;\&lt;GameName&gt;\Savegames. If no company name or game name is specified the savegames are stored in the directory below the ved-file directory.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| DefaultSpeechBus
GameHiddenDialog
+
| t_link to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|  
t_link to [[#Dialog|Dialog]]
+
| 851
| valign="top" |
+
| class="cent" | <div class="tick"></div>
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 GameExecuteActionsDuringDialog is true - then the dialog is saved in this field. The dialog is hidden until the user switches back to a playable scene.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameHoldTime
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Time in milli seconds until the event 'Mouse holding' (for GameLeftHoldAction and GameLeftHoldingAction) is fired.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameHorizontalScrollDistance
 
| valign="top" |
 
t_int
 
| valign="top" |
 
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.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Description
GameId
+
| t_string
| valign="top" |
+
| Short description of the game.
t_string
+
| 124
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Unique Identification number. Used for savegames in order to only load savegames for correct game.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| DestinationCommand
| valign="top" align="center" |
+
| t_link to [[#Buttons|Buttons]]
V
+
| 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| 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
 
|-
 
|-
| valign="top" |
+
| Dialog
GameInterfaces
+
| t_link to [[#Dialogs|Dialogs]]
| valign="top" |
+
| Currently displayed dialog.
t_links to [[#Interface|Interface]] (parent)
+
| 476
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All interfaces of the game.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| DialogAction
GameInterfaceClasses
+
| t_link to [[#Actions|Actions]]
| valign="top" |
+
| Running action which contains the text for the current dialog.
t_links to [[#InterfaceClass|InterfaceClass]] (parent)
+
| 481
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All interface classes of the game.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| DisableInteractionDuringAnim
GameInterfaceComposedFile
+
| t_int
| valign="top" |
+
|
t_path
+
| 643
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the filename for composing the interface when compiling the game.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| DraggableItems
| valign="top" align="center" |
+
| t_bool
V
+
| True if objects can be dragged from the interface.
 +
| 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" | V
 +
|-
 +
| FadeDelay
 +
| t_int
 +
| Delay for fade in/out of a scene in milliseconds.
 +
| 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
 
|-
 
|-
| valign="top" |
+
| FirstCharacter
GameInterfaceComposedFiles
+
| t_link to [[#Characters|Characters]]
| valign="top" |
+
| Character which is used for starting the game. This is the character which is controlled by the player.
t_int
+
| 303
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The number of composed interface files:<br>
+
| class="cent" | V
'0' (eMainContainer): All interfaces are stored in the main container.<br>
 
'1' (eSingleContainer): All interfaces are stored in one file specified by GameInterfaceComposedFile.<br>
 
'2' (eMultipleContainers): Each interface is stored in an own container specified by GameInterfaceComposedFile (filename extended by the interface number).<br>
 
| valign="top" align="center" |
 
 
|-
 
|-
| valign="top" |
+
| FirstScene
GameIntro
+
| t_link to [[#Scenes|Scenes]]
| valign="top" |
+
| The first scene of the game (which is shown after the loading screen)
t_path
+
| 121
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Intro movie which will be played at the beginning of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| FontLinks
GameItems
+
| t_links to [[#Fonts|Fonts]] (parent)
| valign="top" |
+
| All fonts of the game.
t_links to [[#Object|Object]] (parent)
+
| 120
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All items of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| FullScreenIntro
GameLanguages
+
| t_bool
| valign="top" |
+
| True if the intro movie is scaled to fullscreen.
t_links to [[#Language|Language]] (parent)
+
| 247
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All languages of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| GameComposedFile
GameLeftClickAction
+
| t_path
| valign="top" |
+
| 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.
t_link to [[#Action|Action]] (parent)
+
| 683
| valign="top" |
+
| class="cent" | <div class="cross"></div>
An action which will be started if the left mouse button is clicked.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| GameComposedFiles
GameLeftDblClickAction
+
| t_int
| valign="top" |
+
| The number of composed game files. Possible values:
t_link to [[#Action|Action]] (parent)
+
* 0 (eMainContainer): The game object is stored in the main container.
| valign="top" |
+
* 1 (eSingleContainer): The game object is stored in one file specified by "GameComposedFile".
An action which will be started if the left mouse button is double clicked.
+
| 682
| valign="top" align="center" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| GameName
GameLeftHoldAction
+
| t_string
| valign="top" |
+
| 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>
t_link to [[#Action|Action]] (parent)
+
| 701
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Action which is started if the left mouse button is pressed for a certain time (GameLeftHoltTime) and GameLeftMouseHold is set to '3' or '4'. The action is started when the mouse button is released.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| HiddenDialog
GameLeftHoldingAction
+
| t_link to [[#Dialogs|Dialogs]]
| valign="top" |
+
| 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.
t_link to [[#Action|Action]] (parent)
+
| 579
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Action which is started if the left mouse button is pressed for a certain time (GameLeftHoltTime) and GameLeftMouseHolding is set to '3'. The action is started when the mouse button is pressed.
+
| class="cent" | V/S
| valign="top" align="center" |
+
|-  
-
+
| HideCursor
| valign="top" align="center" |
+
| t_bool
V
+
| If true the cursor is hidden and no cursor interaction is possible.
|- class="scriptable"
+
| 480
| valign="top" |
+
| class="cent" | <div class="tick"></div>
GameLeftMouseClick
+
| class="cent" | S
| valign="top" |
+
|-  
t_int
+
| HideInterfaces
| valign="top" |
+
| t_bool
Defines what a left mouse click is used for:<br>
+
| If true all interfaces are hidden, independent of individual interface visibility.
'0' (eIndividualAction): used for individual actions.<br>
+
| 479
'4' (eStandardActionWithIndividual): used for standard action (GameLeftClickAction) and individual actions.<br>
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | S
Yes
+
|-  
| valign="top" align="center" |
+
| HoldTime
V/S
+
| t_int
|- class="scriptable"
+
| Time (in milliseconds) until the 'Mouse holding' event (for "LeftHoldAction" and "LeftHoldingAction") is fired.
| valign="top" |
+
| 377
GameLeftMouseDblClick
+
| class="cent" | <div class="tick"></div>
| valign="top" |
+
| class="cent" | V/S
t_int
+
|-  
| valign="top" |
+
| HorizontalScrollDistance
Defines what a left double click is used for:<br>
+
| t_int
'0' (eIndividualAction): used for individual actions.<br>
+
| 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.
'3' (eStandardAction): used for standard action (GameLeftDblClickAction).<br>
+
| 667
'4' (eStandardActionWithIndividual): used for standard action (GameLeftDlbClickAction) and individual actions.<br>
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | S
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameLeftMouseHold
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines what the event 'left mouse button hold' is used for when the button is released.<br>
 
'0' (eIndividualAction): used for individual actions.<br>
 
'3' (eStandardAction): used for standard action (GameLeftHoldAction).<br>
 
'4' (eSandardActionWithIndividual): used for standard action (GameLeftHoldAction) and individual actions.<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameLeftMouseHolding
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines what the event 'left mouse button hold' is used for when the button is pressed.<br>
 
'0' (eIndividualAction): used for individual actions.<br>
 
'3' (eStandardAction): used for standard action (GameLeftHoldingAction).<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| IconFile
GameLoading
+
| t_path
| valign="top" |
+
|  
t_link to [[#Loading|Loading]] (parent)
+
| 818
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The loading screen. (is shown on startup when the game is loaded)
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Id
GameMinificationFilter
+
| t_string
| valign="top" |
+
| Unique Identification number. Used for savegames in order to only load savegames for correct game.
t_int
+
| 370
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Filter for minification of textures (scaling of character images).<br>
+
| class="cent" | V
'0': Linear interpolation.<br>
 
'1': Nearest neighbor.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Interfaces
GameMagnificationFilter
+
| t_links to [[#Interfaces|Interfaces]] (parent)
| valign="top" |
+
| All interfaces of the game.
t_int
+
| 662
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Filter for magnification of textures (scaling of character images).<br>
+
| class="cent" | V
'0' (eLinearInterpolation): Linear interpolation.<br>
 
'1' (eNearestNeighborInterpolation): Nearest neighbor.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| InterfaceClasses
GameMovieComposedFile
+
| t_links to [[#InterfaceClasses|InterfaceClasses]] (parent)
| valign="top" |
+
| All interface classes of the game.
t_path
+
| 661
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the filename for composing the movies when compiling the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| InterfaceComposedFile
GameMovieComposedFiles
+
| t_path
| valign="top" |
+
| Defines the filename for composing the interface when compiling the game.
t_int
+
| 671
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The number of composed movie files:<br>
+
| class="cent" | V
'0' (eMainContainer): All movies are stored in the main container.<br>
 
'1' (eSingleContainer): All movies are stored in one file specified by GameMovieComposedFile.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
GameObjectFont
 
| valign="top" |
 
t_link to [[#Font|Font]]
 
| valign="top" |
 
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.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| InterfaceComposedFiles
GameParticleContainerLinks
+
| t_int
| valign="top" |
+
| The number of composed interface files. Possible values:
t_links to [[#ParticleContainer|ParticleContainer]] (parent)
+
* 0 (eMainContainer): All interfaces are stored in the main container.
| valign="top" |
+
* 1 (eSingleContainer): All interfaces are stored in one file specified by "InterfaceComposedFile".
All particle systems of the game.
+
* 2 (eMultipleContainers): Each interface is stored in an own container specified by "InterfaceComposedFile" (filename extended by the interface number).
| valign="top" align="center" |
+
| 670
-
+
| class="cent" | <div class="cross"></div>
| valign="top" align="center" |
+
| class="cent" | <div class="cross"></div>
V
 
 
|-
 
|-
| valign="top" |
+
| Intro
GamePicBufferSize
+
| t_path
| valign="top" |
+
| Intro movie which will be played at the beginning of the game.
t_int
+
| 224
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 GamePicBufferSize 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).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Items
GamePictureCacheSize
+
| t_links to [[#Objects|Objects]] (parent)
| valign="top" |
+
| All items of the game.
t_int
+
| 349
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Size in MB for cache which stores the recently loaded images.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| KeepCharacterSpritesDuringMenus
GamePreloadPicThreads
+
| t_bool
| valign="top" |
+
|
t_int
+
| 642
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Number of threads used for preloading animations. GamePreloadPicThreads number of buffers with size of GamePreloadedPicBufferSize will be preallocated.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Languages
GamePreloadedPicBufferSize
+
| t_links to [[#Languages|Languages]] (parent)
| valign="top" |
+
| All languages of the game.
t_int
+
| 259
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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 GamePreloadedPicBufferSize 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).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
GameQuake
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
If true a quake constantly moves the screen. The values GameQuakeForce and GameQuakeSpeed are used as parameters for the quake.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameQuakeForce
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Number of maximum pixels the screen is moved by a quake. Value is only used if GameQuake is true.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameQuakeSpeed
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines how long (in milli seconds) 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 GameQuake is true.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| LeftClickAction
GameReserved
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| An action which will be started if the left mouse button is clicked.
t_string
+
| 563
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Licence number.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LeftClickBehaviour
GameRightClickAction
+
| t_int
| valign="top" |
+
| Defines if the character will be sent to the current position when the left mouse button is clicked. Possible values:
t_link to [[#Action|Action]] (parent)
+
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
| valign="top" |
+
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
Action which is started if the right mouse button is pressed and GameRightMouseClick is set to '3' or '4'.
+
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
| valign="top" align="center" |
+
| 891
-
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | V/S
V
 
|- class="scriptable"
 
| valign="top" |
 
GameRightMouseClick
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines what the right mouse button is used for.<br>
 
'0' (eIndividualAction): used for individual actions.<br>
 
'1' (eActivateStandardCommand): activates standard command.<br>
 
'2' (eActivateNextCommand): activates next command.<br>
 
'3' (eStandardAction): used for standard action (GameRightClickAction).<br>
 
'4' (eSandardActionWithIndividual): used for standard action (GameRightClickAction) and individual actions.<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameSavedObject
 
| valign="top" |
 
t_link to [[#Object|Object]]
 
| valign="top" |
 
Saved object. An action can be executed on this saved object. (see actionpart 'Execute command on saved object')
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| LeftDblClickAction
GameSaveGameName
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| An action which will be started if the left mouse button is double clicked.
t_string
+
| 379
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Used to store name of current savegame.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| LeftHoldAction
GameSceneComposedFile
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| 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.
t_path
+
| 381
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the filename for composing the scenes when compiling the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LeftHoldingAction
GameSceneComposedFiles
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| 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.
t_int
+
| 386
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The number of composed scene files:<br>
+
| class="cent" | V
'0' (eMainContainer): All scenes are stored in the main container.<br>
 
'1' (eSingleContainer): All scenes are stored in one file specified by GameSceneComposedFile.<br>
 
'2' (eMultipleContainers): Each scene is stored in an own container specified by GameSceneComposedFile (filename extended by the scene number).<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| LeftHoldBehaviour
GameSceneLinks
+
| t_int
| valign="top" |
+
| Defines if the character will be sent to the current position when the left button is released. Possible values:
t_links to [[#Scene|Scene]] (parent)
+
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
| valign="top" |
+
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
All scenes of the game.
+
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
| valign="top" align="center" |
+
| 780
-
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | V/S
V
 
 
|-
 
|-
| valign="top" |
+
| Loading
GameScriptLinks
+
| t_link to [[#Loadings|Loadings]] (parent)
| valign="top" |
+
| The loading screen which is shown on startup when the game is loaded.
t_links to [[#Script|Script]] (parent)
+
| 358
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All scripts of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
GameScrollCenterCharacter
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
If true the scroll-character (see GameScrollCharacter) will be centered on the scene (if GameScrollTo is false). If false then no character will be centered.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameScrollCharacter
 
| valign="top" |
 
t_link to [[#Character|Character]]
 
| valign="top" |
 
Character which will be centered on the current scene (if GameScrollCenterCharacter is true and GameScrollTo is false).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ''MinificationFilter''
GameScrollDirectionHorizontal
+
| ''t_int''
| valign="top" |
+
| ''DEPRECATED, see "NearestNeighborInterpolation" instead''
t_int
+
|
| valign="top" |
+
| class="cent" |  
Horizontal direction the scene is currently scrolling.<br>
+
| class="cent" |  
'0': currently no horizontal scrolling.<br>
 
'1': currently scrolling to the left.<br>
 
'2': currently scrolling to the right.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| ''MagnificationFilter''
GameScrollDirectionVertical
+
| ''t_int''
| valign="top" |
+
| ''DEPRECATED, see "NearestNeighborInterpolation" instead''
t_int
+
|  
| valign="top" |
+
| class="cent" |  
Vertical direction the scene is currently scrolling.<br>
+
| class="cent" |  
'0': currently no vertical scrolling.<br>
 
'3': currently scrolling to the top.<br>
 
'4': currently scrolling to the bottom.<br>
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameScrollPosition
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Upper left corner of current scroll position (on current scene).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameScrollSpeed
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Number of pixels which will be scrolled in one second.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameScrollToPoint
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Upper left corner the current scene is scrolling to.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| MiddleClickAction
GameScrollTo
+
| t_link
| valign="top" |
+
| An action which will be started if the middle mouse button is clicked.
t_bool
+
| 766
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true the scene is currently scrolling to GameScrollToPoint.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
GameSpeakerTextAlignment
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines alignment of speaker text:<br>
 
'0' (eAlignLeft): Align left.<br>
 
'1' (eAlignRight): Align right.<br>
 
'2' (eAlignCentered): Centered.<br>
 
'3' (eAlignLeftWithCenterPos): Align left (use center position).<br>
 
'4' (eAlignRightWithCenterPos): Align right (use center position).<br>
 
'5' (eAlignCenteredWithLeftPos): Centered (use left position).<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameStandardLanguage
 
| valign="top" |
 
t_link to [[#Language|Language]]
 
| valign="top" |
 
Defines the currently used language.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| MiddleClickBehaviour
GameStartAction
+
| t_int
| valign="top" |
+
| Defines if the character will be sent to the current position when the middle mouse button is clicked. Possible values:
t_link to [[#Action|Action]] (parent)
+
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
| valign="top" |
+
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
This action will be executed once at the beginning of the game (after the game was loaded).
+
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
| valign="top" align="center" |
+
| 781
-
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | V/S
V
 
|- class="scriptable"
 
| valign="top" |
 
GameTextAlignment
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines alignment of spoken text:<br>
 
'0' (eAlignLeft): Align left.<br>
 
'1' (eAlignRight): Align right.<br>
 
'2' (eAlignCentered): Centered.<br>
 
'3' (eAlignLeftWithCenterPos): Align left (use center position).<br>
 
'4' (eAlignRightWithCenterPos): Align right (use center position).<br>
 
'5' (eAlignCenteredWithLeftPos): Centered (use left position).<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
GameTextOutput
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines if spoken texts should be printed and/or spoken:<br>
 
'0' (eTextAndSpeechOutput): Display text and play speech file.<br>
 
'1' (eOnlySpeechOutput): Only play speech file.<br>
 
'2' (eOnlyTextOutput): Only display text.<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
|- class="scriptable"
+
| MouseWheelDownAction
| valign="top" |
+
| t_link to [[#Actions|Actions]]
GameTextSpeed
+
| An action which will be started if the mouse wheel is moved down.
| valign="top" |
+
| 768
t_int
+
| class="cent" | <div class="cross"></div>
| valign="top" |
+
| class="cent" | V
Speed for displaying texts (in %). Default is 100.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| MouseWheelUpAction
GameUsedItem
+
| t_link to [[#Actions|Actions]]
| valign="top" |
+
| An action which will be started if the mouse wheel is moved up.
t_link to [[#Object|Object]]
+
| 767
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The currently picked up item. A picked up item is either dragged (shown instead of cursor) or displayed in the action text.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| MovieComposedFile
GameVersion
+
| t_path
| valign="top" |
+
| Defines the filename for composing the movies when compiling the game.
t_string
+
| 622
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Version number of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
GameVerticalScrollDistance
 
| valign="top" |
 
t_int
 
| valign="top" |
 
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.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| MovieComposedFiles
GameVideosEncrypted
+
| t_int
| valign="top" |
+
| The number of composed movie files. Possible values:
t_bool
+
* 0 (eMainContainer): All movies are stored in the main container.
| valign="top" |
+
* 1 (eSingleContainer): All movies are stored in one file specified by "MovieComposedFile".
If true the videos are stored in an encrypted container. This field is only relevant for compiled games.
+
| 621
| valign="top" align="center" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| NearestNeighborInterpolation
GameWindowResolution
+
| t_bool
| valign="top" |
+
| If true nearest neighbor interpolation is used scaling of character images (pixel effect).
t_point
+
| 745
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Screen resolution (e.g. 640x480).
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| ObjectFont
| valign="top" align="center" |
+
| t_link to [[#Fonts|Fonts]]
V
+
| 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>
== Interface ==
+
| class="cent" | V
{| class="gruen" border="1"
+
|-  
| valign="top" |
+
| ObjectTextOutput
'''Table'''
+
| t_int
| valign="top" |  
+
|
'''Field'''
+
| 702
| valign="top" |
+
| class="cent" | <div class="cross"></div>
'''Field Type'''
+
| class="cent" | V
| valign="top" |
+
|-
'''Description'''
+
| OverlayColor
| valign="top" align="center" |
+
| t_int
'''Scriptable'''
+
|
| valign="top" align="center" |
+
| 841
'''Storage'''
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| OverlayVisibility
 +
| t_int
 +
|
 +
| 840
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| ParticleContainerLinks
 +
| t_links to [[#ParticleContainers|ParticleContainers]] (parent)
 +
| All particle systems of the game.
 +
| 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" | V
 
|-
 
|-
| rowspan="20" valign="top" |
+
| PictureCacheSize
Interface
+
| t_int
| valign="top" |
+
| Size (in MB) for cache which stores the recently loaded images.
InterfaceActionTextFont
+
| 669
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_link to [[#Font|Font]]
+
| class="cent" | V
| valign="top" |
 
Font which will be used for the action text - only used if InterfaceDrawActionText is true.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Plugins
InterfaceActionTextRect
+
| t_links to [[#Plugins|Plugins]]
| valign="top" |
+
| Installed action part plugins.
t_rect
+
| 863
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Rectangle in which the action text will be drawn horizontally and vertically centered - only used if InterfaceDrawActionText is true.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| PreallocatedTextures
InterfaceBorder
+
| t_int
| valign="top" |
+
|
t_vpoint
+
| 743
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Polygon which defines the border of the interface. The interface is detected if the cursor is inside the polygon.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| PreloadPicThreads
InterfaceButtons
+
| t_int
| valign="top" |
+
| Number of threads used for preloading animations. "PreloadPicThreads" number of buffers with size of "PreloadedPicBufferSize" will be preallocated.
t_links to [[#Button|Button]] (parent)
+
| 731
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All buttons of the interface: commands, arrows to scroll items, action areas, placeholder for items
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| PreloadedPicBufferSize
InterfaceClass
+
| t_int
| valign="top" |
+
| 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).
t_link to [[#InterfaceClass|InterfaceClass]]
+
| 732
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The class this interface belongs to.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| Quake
| valign="top" align="center" |
+
| t_bool
V
+
| 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
 +
| Number of maximum pixels the screen is moved by a quake. Value is only used if "Quake" is true.
 +
| 630
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| valign="top" |
+
| RegisteredEventHandlers
InterfaceConditions
+
| t_string
| valign="top" |
+
| All registered event handlers.
t_links to [[#Condition|Condition]] (parent)
+
| 759
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The conditions of the interface.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
InterfaceDestVisibility
 
| valign="top" |
 
t_int
 
| valign="top" |
 
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'. '0' means the interface will not be visible at all (but is still recognized by the cursor), '100' means the interface will be completely visible (default). The time to fade from the current visibility to InterfaceDestVisibility is defined by InterfaceTimeToDestVisibility.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
InterfaceDisplacement
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines where the interface is shown:<br>
 
'0': top.<br>
 
'1': bottom.<br>
 
'2': left.<br>
 
'3': right.<br>
 
'4': absolute, position on screen defined by InterfaceOffset.<br>
 
'5': relative, position defined by current cursor position and offset to the cursor position (InterfaceOffset).<br>
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
InterfaceDrawActionText
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
Defines if the action text is drawn on this interface (if true than InterfaceActionTextFont and InterfaceActionTextRect must be set).
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Reserved
InterfaceLeaveAction
+
| t_string
| valign="top" |
+
| Licence number.
t_link to [[#Action|Action]] (parent)
+
| 369
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Action which will be executed if the cursor leaves the interface (outside of polygon InterfaceBorder).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
InterfaceOffset
 
| valign="top" |
 
t_point
 
| valign="top" |
 
Offset (or absolute position) for displaying the interface. (only used if InterfaceDisplacement is '4' or '5')
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| RightClickAction
InterfacePosition
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| Action which is started if the right mouse button is pressed and "RightMouseClick" is set to 3 or 4.
t_point
+
| 337
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Absolute position of upper left corner of interface.
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| RightClickBehaviour
| valign="top" align="center" |
+
| t_int
V/S
+
| Defines if the character will be sent to the current position when the right mouse button is clicked.Possible values:
|- class="scriptable"
+
* 0 (eMouseActionBehaviourDoNotSendCharacter): The character will not be sent to the current position.
| valign="top" |
+
* 1 (eMouseActionBehaviourSendCharacterToCursor): Character will be sent to current position.
InterfaceScrollStepSize
+
* 2 (eMouseActionBehaviourSendCharacterToObjects): Character will be sent to current position if it is a scene object.
| valign="top" |
+
| 782
t_int
+
| class="cent" | <div class="tick"></div>
| valign="top" |
+
| class="cent" | V/S
Defines how many item positions will be scrolled if a scroll arrow is pushed.
+
|-  
| valign="top" align="center" |
+
| SavedObject
Yes
+
| t_link to [[#Characters|Characters]] or [[#Objects|Objects]] or [[#Buttons|Buttons]]
| valign="top" align="center" |
+
| Object which is currently saved to execute an action on (usually through the "Save object" action part).
V
+
| 486
|- class="scriptable"
+
| class="cent" | <div class="tick"></div>
| valign="top" |
+
| class="cent" | S
InterfaceSize
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines the size of the interface (in pixel). 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 InterfaceDisplacement is '0', '1', '2' or '3'.  
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| SaveGameName
InterfaceSprite
+
| t_string
| valign="top" |
+
| Used to store name of current savegame.
t_sprite
+
| 537
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Background sprite of the interface.
+
| class="cent" | S
| valign="top" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SavegameScreenshot
InterfaceStandardCommand
+
| t_path
| valign="top" |
+
| Image used as savegame screenshot for all scenes when game is played on a mobile device.
t_link to [[#Button|Button]]
+
| 764
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Button which is the standard command (usually 'Walk to') for this interface.
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| SaveNameOffsetY
| valign="top" align="center" |
+
| t_int
V
+
|  
|- class="scriptable"
+
| 843
| valign="top" |
+
| class="cent" | <div class="cross"></div>
InterfaceTimeToDestVisibility
+
| class="cent" | V
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines the time in milli seconds until the visibility InterfaceDestVisibility is reached. This value is used the next time when InterfaceDestVisibility is set.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| SceneComposedFile
InterfaceValues
+
| t_path
| valign="top" |
+
| Defines the filename for composing the scenes when compiling the game.
t_links to [[#Values|Values]] (parent)
+
| 618
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The values of the interface.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
InterfaceVisibility
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Visibility of the interface (and all of its buttons) in %. Must be between '0' and '100'. '0' means the interface is not visible at all, '100' means the interface is completely visible (default). Note that the interface can only be visible if InterfaceActive and InterfaceVisible are true.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
|- class="scriptable"
 
| valign="top" |
 
InterfaceVisible
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
If true the interface is visible - supposed the visibility is > 0% (see InterfaceVisibility). This option can be used to toggle the interface on/off without changing InterfaceVisibility.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|}
 
 
 
== InterfaceClass ==
 
{| class="gruen" border="1"
 
| valign="top" |
 
'''Table'''
 
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| valign="top" |
+
| SceneComposedFiles
InterfaceClass
+
| t_int
| valign="top" |
+
| The number of composed scene files. Possible values:
InterfaceClassName
+
* 0 (eMainContainer): All scenes are stored in the main container.
| valign="top" |
+
* 1 (eSingleContainer): All scenes are stored in one file specified by "SceneComposedFile".
t_string
+
* 2 (eMultipleContainers): Each scene is stored in an own container specified by "SceneComposedFile" (filename extended by the scene number).
| valign="top" |
+
| 617
Interface class name. The name of the object itself will be set to the translated class name.
+
| class="cent" | <div class="cross"></div>
| valign="top" align="center" |
+
| class="cent" | V
-
 
| valign="top" align="center" |
 
V
 
|}
 
 
 
== Language ==
 
{| class="gruen" border="1"
 
| valign="top" |
 
'''Table'''
 
| valign="top" |  
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| valign="top" |
+
| SceneLinks
Language
+
| t_links to [[#Scenes|Scenes]] (parent)
| valign="top" |
+
| All scenes of the game.
-
+
| 117
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" |
 
Language name is defined by name of each language object.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
-
 
|}
 
 
 
== Loading ==
 
{| class="gruen" border="1"
 
| valign="top" |
 
'''Table'''
 
| valign="top" |  
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="4" valign="top" |
+
| ScriptLinks
Loading
+
| t_links to [[#Scripts|Scripts]] (parent)
| valign="top" |
+
| All scripts of the game.
LoadingMusic
+
| 651
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_path
+
| class="cent" | V
| valign="top" |
+
|-
Music which is played while the loading screen is shown.
+
| ScrollCenterCharacter
| valign="top" align="center" |
+
| 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.
| valign="top" align="center" |
+
| 561
V
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 +
|-
 +
| ScrollCharacter
 +
| t_link to [[#Characters|Characters]]
 +
| Character which will be centered on the current scene (if "ScrollCenterCharacter" is true and "ScrollTo" is false).
 +
| 611
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| valign="top" |
+
| ScrollDirectionHorizontal
LoadingSprite
+
| t_int
| valign="top" |
+
| ''DEPRECATED''
t_sprite
+
| 473
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Background sprite of the loading screen.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ScrollDirectionVertical
LoadingStatusCover
+
| t_int
| valign="top" |
+
| ''DEPRECATED''
t_bool
+
| 474
| valign="top" |
+
| class="cent" | <div class="cross"></div>
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).
+
| class="cent" | S
| valign="top" align="center" |
+
|-
-
+
| ScrollPosition
| valign="top" align="center" |
+
| t_point
V
+
| 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
 
|-
 
|-
| valign="top" |
+
| ScrollTo
LoadingStatusSprite
+
| t_bool
| valign="top" |
+
| If true the scene is currently scrolling to "ScrollToPoint".
t_sprite
+
| 472
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Sprite for progress bar.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|}
 
 
 
== Object ==
 
{| class="gruen" border="1"
 
| valign="top" |
 
'''Table'''
 
| valign="top" |  
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="23" valign="top" |
+
| ShaderExclude
Object
+
| t_int
| valign="top" |
+
| Defines which components (scene, interfaces, texts, cursor) will be excluded from shader programs. Possible values:
ObjectActions
+
* 0 (eShaderExcludeNothing): standard, exclude nothing.
| valign="top" |
+
* 1 (eShaderExcludeInterfaces): exclude interfaces, text on top, cursor.
t_links to [[#Action|Action]] (parent)
+
* 2 (eShaderExcludeTextsAndCursor): exclude text on top, cursor.
| valign="top" |
+
* 3 (eShaderExcludeCursor): exclude cursor
All actions of the object. ActionExecutionType defines when the action is started.
+
| 787
| valign="top" align="center" |
+
| class="cent" | <div class="tick"></div>
-
+
| class="cent" | S
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ShaderLinks
ObjectAnimation
+
| t_links to [[#Shaders|Shaders]]
| valign="top" |
+
|  
t_link to [[#Animation|Animation]]
+
| 820
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Animation which is automatically started if this object is active (see ObjectCondition).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ShowBlackScreenAfterVideo
ObjectAnimations
+
| t_bool
| valign="top" |
+
| 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.
t_links to [[#Animation|Animation]] (parent)
+
| 763
| valign="top" |
+
| class="cent" | <div class="tick"></div>
All animations of the object.
+
| class="cent" | V/S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SmoothScrolling
ObjectCenter
+
| t_bool
| valign="top" |
+
|
t_int
+
| 826
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines the line number (y coordinate) which decides if a character is in front or behind this object.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SpeakerSoundPanFactor
ObjectCondition
+
| t_int
| valign="top" |
+
| 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.
t_link to [[#Condition|Condition]]
+
| 758
| valign="top" |
+
| class="cent" | <div class="tick"></div>
If ObjectCondition is not empty then the object is only shown and detected by the cursor if the conidition is true (or the condition is false and ConditionConditionNegate is true).
+
| class="cent" | V/S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SpeakerTextAlignment
ObjectConditionNegate
+
| t_int
| valign="top" |
+
| Defines alignment of speaker text. Possible values:
t_bool
+
* 0 (eAlignLeft): Align left.
| valign="top" |
+
* 1 (eAlignRight): Align right.
falls dieser Wert wahr ist, wird VObjectCondition vor der Auswertung negiert; dadurch wird der unnötige Aufwand für eine zusammengesetzte Bedingung mit nur einem Ast vermieden
+
* 2 (eAlignCentered): Centered.
| valign="top" align="center" |
+
* 3 (eAlignLeftWithCenterPos): Align left (use center position).
-
+
* 4 (eAlignRightWithCenterPos): Align right (use center position).
| valign="top" align="center" |
+
* 5 (eAlignCenteredWithLeftPos): Centered (use left position).
V
+
| 592
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| SpeechLanguage
 +
| t_link to [[#Languages|Languages]]
 +
| Defines the language which is used for speech output. If empty the language from "StandardLanguage" will be used.
 +
| 755
 +
| class="cent" | <div class="tick"></div>
 +
| 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
 
|-
 
|-
| valign="top" |
+
| StartAction
ObjectConditions
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| This action will be executed once at the beginning of the game (after the game was loaded).
t_links to [[#Condition|Condition]] (parent)
+
| 368
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then the condition ButtonCondition is negated. (see ButtonCondition)
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| TextAlignment
| valign="top" align="center" |
+
| t_int
V
+
| Defines alignment of spoken text. Possible values:
|- class="scriptable"
+
* 0 (eAlignLeft): Align left.
| valign="top" |
+
* 1 (eAlignRight): Align right.
ObjectDestVisibility
+
* 2 (eAlignCentered): Centered.
| valign="top" |
+
* 3 (eAlignLeftWithCenterPos): Align left (use center position).
t_int
+
* 4 (eAlignRightWithCenterPos): Align right (use center position).
| valign="top" |
+
* 5 (eAlignCenteredWithLeftPos): Centered (use left position).
The visibility of the object is fading to the visibility defined by this value. Must be between '0' and '100'. '0' means the object will not be visible at all (but is still recognized by the cursor), '100' means the object will be completely visible (default). The time to fade from the current visibility to ObjectDestVisibility is defined by ObjectTimeToDestVisibility.
+
| 593
| valign="top" align="center" |
+
| class="cent" | <div class="tick"></div>
Yes
+
| class="cent" | V/S
| valign="top" align="center" |
+
|-
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
 
|-
 
|-
| valign="top" |
+
|-
ObjectDirection
+
| TextSpeed
| valign="top" |
+
| t_int
t_int
+
| Speed for displaying texts (in percent). Default is 100.
| valign="top" |
+
| 646
Direction in degrees which a character is aligned if it reaches this object (ObjectPosition).
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | S
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| UsedItem
ObjectIsItem
+
| t_link to [[#Objects|Objects]]
| valign="top" |
+
| The currently picked up item. A picked up item is either dragged (shown instead of cursor) or displayed in the action text.
t_bool
+
| 686
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then this object is an item, otherwise it is a scene object.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| UsedItemPicked
ObjectIsWalkable
+
| t_bool
| valign="top" |
+
| True if "UsedItem" = true and the used item is dragged (shown instead of cursor).
t_bool
+
| 730
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then then no action can be executed on this object with the standard command (see InterfaceStandardCommand).
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Version
ObjectName
+
| t_string
| valign="top" |
+
| Version number of the game.
t_link to [[#Text|Text]] (parent)
+
| 627
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The name of the object (as shown in the action text).
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| VerticalScrollDistance
| valign="top" align="center" |
+
| t_int
V
+
| 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
 
|-
 
|-
| valign="top" |
+
| VideoAudioLanguage
ObjectParticleSystem
+
| t_string
| valign="top" |
+
|  
t_link to [[#ParticleSystem|ParticleSystem]]
+
| 738
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Particle system which is shown if the object is active (see ObjectCondition).
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| VideosEncrypted
ObjectPolygon
+
| t_bool
| valign="top" |
+
| If true the videos are stored in an encrypted container. This field is only relevant for compiled games.
t_vpoint
+
| 699
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Polygon which defines the border of the object. The object is detected if the cursor is inside the polygon.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| VideoPauseScreen
ObjectPosition
+
| t_path
| valign="top" |
+
|
t_point
+
| 788
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Position of the object on the scene (only used if ObjectIsItem is false). If the user clicked on this object then the current character walks to this position.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| VideoSubtitleFont
ObjectScrollFactorX
+
| t_link to [[#Fonts|Fonts]]
| valign="top" |
+
|
t_int
+
| 735
| valign="top" |
+
| class="cent" | <div class="tick"></div>
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).
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| VideoSubtitleLanguage
ObjectScrollFactorY
+
| t_string
| valign="top" |
+
|
t_int
+
| 737
| valign="top" |
+
| class="cent" | <div class="tick"></div>
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).
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| VideoSubtitlePosition
ObjectSnoopAnimation
+
| t_point
| valign="top" |
+
|  
t_link to [[#Animation|Animation]]
+
| 736
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Animation which is shown when the snoop animation are active. The animation is only shown if the object is currently active (see ObjectCondition). The snoop animations can be activated with an action part.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| WalksoundBus
ObjectSnoopAnimationPos
+
| t_link to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|
t_point
+
| 853
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Absolute position of the snoop animation (seeObjectSnoopAnimation) on the scene.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| WaitCursor
ObjectSprite
+
| t_link to [[#Cursors|Cursors]]
| valign="top" |
+
|  
t_link to [[#Sprite|Sprite]] (parent)
+
| 880
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Sprite which is shown if the object is active (see ObjectCondition).
+
| class="cent" | V/S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
ObjectTimeToDestVisibility
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Defines the time in milli seconds until the visibility ObjectDestVisibility is reached. This value is used the next time when ObjectDestVisibility is set.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| WindowResolution
ObjectValues
+
| t_point
| valign="top" |
+
| Screen resolution.
t_links to [[#Value|Value]] (parent)
+
| 126
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All values of the object.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
ObjectVisibility
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Visibility of the object in %. Must be between '0' and '100'. '0' means the object is not visible at all (but is still recognized by the cursor), '100' means the object is completely visible (default).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|}
 
|}
  
== Outfit ==
+
 
{| class="gruen" border="1"
+
== Interfaces ==
| valign="top" |
+
Table id: 1 <small>(eInterfaces)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| ActionTextFont
'''Storage'''
+
| t_link to [[#Fonts|Fonts]]
 +
| Font which will be used for the action text - only used if "DrawActionText" is true.
 +
| 320
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| ActionTextRect
 +
| t_rect
 +
| Rectangle in which the action text will be drawn horizontally and vertically centered - only used if "DrawActionText" is true.
 +
| 319
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| rowspan="26" valign="top" |
+
| ActiveCommand
Outfit
+
| t_link to [[#Buttons|Buttons]]
| valign="top" class="scriptable" |
+
|  
OutfitAmbientLightColor (3.7)
+
| 607
| valign="top" class="scriptable" |
+
| class="cent" | <div class="tick"></div>
t_int
+
| class="cent" | S
| valign="top" class="scriptable" |
 
TODO
 
| valign="top" align="center" class="scriptable" |
 
Yes
 
| valign="top" align="center" class="scriptable" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitCameraAngle (3.7)
 
| valign="top" |
 
t_float
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitCameraHeight (3.7)
 
| valign="top" |
 
t_float
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Border
OutfitCharacterAnimations
+
| t_vpoint
| valign="top" |
+
| Polygon which defines the border of the interface. The interface is detected if the cursor is inside the polygon.
t_links to [[#Animation|Animation]] (parent)
+
| 325
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Person animations, must be started manually.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
OutfitCharacterSpeed
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Speed of character with this outfit (in pixel per second).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitLightPosX (3.7)
 
| valign="top" |
 
t_float
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitLightPosY (3.7)
 
| valign="top" |
 
t_float
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitLightPosZ (3.7)
 
| valign="top" |
 
t_float
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Buttons
OutfitModel (3.7)
+
| t_links to [[#Buttons|Buttons]] (parent)
| valign="top" |
+
| All buttons of the interface: commands, arrows to scroll items, action areas, placeholder for items.
t_path
+
| 140
| valign="top" |
+
| class="cent" | <div class="cross"></div>
TODO
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| InterfaceClass
OutfitModelAmbientOcclusion (3.7)
+
| t_link to [[#InterfaceClasses|InterfaceClasses]]
| valign="top" |
+
| The class this interface belongs to.
t_int
+
| 659
| valign="top" |
+
| class="cent" | <div class="cross"></div>
TODO
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
OutfitModelOutlineColor (3.7)
 
| valign="top" |
 
t_int
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitModelOutlineWidth (3.7)
 
| valign="top" |
 
t_int
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitModelScaleFactor (3.7)
 
| valign="top" |
 
t_int
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Conditions
OutfitModelShadow (3.7)
+
| t_links to [[#Conditions|Conditions]] (parent)
| valign="top" |
+
| The conditions of the interface.
t_int
+
| 452
| valign="top" |
+
| class="cent" | <div class="cross"></div>
TODO
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| DestVisibility
| valign="top" align="center" |
+
| t_int
V
+
| 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".
|- class="scriptable"
+
| 604
| valign="top" |
+
| class="cent" | <div class="tick"></div>
OutfitModelShadowTranslucency (3.7)
+
| class="cent" | S
| valign="top" |
+
|-
t_int
+
| Displacement
| valign="top" |
+
| t_int
TODO
+
| Defines where the interface is shown. Possible values:
| valign="top" align="center" |
+
* 0: top.
Yes
+
* 1: bottom.
| valign="top" align="center" |
+
* 2: left.
V/S
+
* 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" | 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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|-
 
|-
| valign="top" |
+
| ItemsScrollPosition
OutfitModelShadowVisibility (3.7)
+
| t_int
| valign="top" |
+
| Current scroll position of the items in the interface/inventory.
t_int
+
| 609
| valign="top" |
+
| class="cent" | <div class="cross"></div>
TODO
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
OutfitModelShowOutline (3.7)
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitModelShowShadow (3.7)
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| LeaveAction
OutfitModelTextures (3.7)
+
| t_link to [[#Actions|Actions]] (parent)
| valign="top" |
+
| Action which will be executed if the cursor leaves the interface (outside of polygon "Border").
t_vpath
+
| 388
| valign="top" |
+
| class="cent" | <div class="cross"></div>
TODO
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| MatrixId
| valign="top" align="center" |
+
| t_int
V
+
|  
|- class="scriptable"
+
| 802
| valign="top" |
+
| class="cent" | <div class="tick"></div>
OutfitModelToonNuances (3.7)
+
| class="cent" | S
| valign="top" |
+
|-  
t_int
+
| Offset
| valign="top" |
+
| t_point
TODO
+
| Offset (or absolute position) for displaying the interface (only used if "Displacement" is 4 or 5).
| valign="top" align="center" |
+
| 302
Yes
+
| class="cent" | <div class="tick"></div>
| valign="top" align="center" |
+
| class="cent" | V/S
V/S
 
|- class="scriptable"
 
| valign="top" |
 
OutfitModelUseToonShading (3.7)
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Position
OutfitRandomAnimations
+
| t_point
| valign="top" |
+
| Absolute position of upper left corner of interface.
t_links to [[#Animation|Animation]] (parent)
+
| 688
| valign="top" |
+
| class="cent" | <div class="cross"></div>
For playable characters: (characters with an interface):<br />
+
| class="cent" | V/S
Animations are shown if the user did not interact for a longer time span.<br />
+
|-
For non-playable characters (characters without an interface):<br />
+
| ScrollStepSize
Animations are shown after a random time span.<br />
+
| t_int
| valign="top" align="center" |
+
| Defines how many item positions will be scrolled if a scroll arrow is pushed.
-
+
| 138
| valign="top" align="center" |
+
| class="cent" | <div class="tick"></div>
V
+
| class="cent" | V
 +
|-  
 +
| ShowAlways
 +
| t_bool
 +
|
 +
| 789
 +
| 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
 
|-
 
|-
| valign="top" |
+
| Sprite
OutfitStandingAnimations
+
| t_sprite
| valign="top" |
+
| Background sprite of the interface.
t_links to [[#Animation|Animation]] (parent)
+
| 238
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Standing animations, shown when person is standing.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| StandardCommand
| valign="top" align="center" |
+
| t_link to [[#Buttons|Buttons]]
V
+
| Button which is the standard command (usually "Walk to") for this interface.
 +
| 298
 +
| class="cent" | <div class="cross"></div>
 +
| 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
 +
| t_links to [[#Values|Values]] (parent)
 +
| The values of the interface.
 +
| 453
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| 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"
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
OutfitTalkAnimations
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_links to [[#Animation|Animation]] (parent)
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
Talk animations.
+
! style="width:5%" class="unsortable" | Storage
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
OutfitUseLight (3.6)
 
| valign="top" |
 
t_bool
 
| valign="top" |
 
TODO
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Name
OutfitWalkAnimations
+
| t_string
| valign="top" |
+
| Interface class name. The name of the object itself will be set to the translated class name.
t_links to [[#Animation|Animation]] (parent)
+
| 660
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Walk animations.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== ParticleContainer ==
+
 
{| class="gruen" border="1"
+
== Languages ==
| valign="top" |
+
Table id: 18 <small>(eLanguages)</small>
'''Table'''
+
 
| valign="top" |
+
The language name is defined by the name of each language object.
'''Field'''
+
 
| valign="top" |
+
 
'''Field Type'''
+
== Loadings ==
| valign="top" |
+
Table id: 21 <small>(eLoadings)</small>
'''Description'''
+
{| class="ts sortable"
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| valign="top" rowspan="4" |
+
! style="width:15%" | Field
ParticleContainer
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
ParticleContainerCameraZoom
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_float
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
Zoom factor.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Music
ParticleContainerCameraZPosition
+
| t_path
| valign="top" |
+
| Music which is played while the loading screen is shown.
t_float
+
| 357
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Z-Position of 'camera' for showing particle system.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Sprite
ParticleContainerLeadTime
+
| t_sprite
| valign="top" |
+
| Background sprite of the loading screen.
t_links to [[#Particles|Particles]] (parent)
+
| 353
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All particle emitters of this particle system.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| StatusCover
ParticleContainerParticles
+
| t_bool
| valign="top" |
+
| 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).
t_links to [[#Particles|Particles]] (parent)
+
| 356
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All particle emitters of this particle system.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| StatusSprite
| valign="top" align="center" |
+
| t_sprite
V
+
| Sprite for progress bar.
 +
| 355
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|}
 
|}
  
== Particle ==
+
 
{| class="gruen" border="1"
+
== Models ==
| valign="top" |
+
Table id: 35 <small>(eModels)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="54" valign="top" |
+
! style="width:15%" | Field
Particle
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
ParticleActiveStages
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_int
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
-
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Model
ParticleBlendColor0
+
| t_path
| valign="top" |
+
|
t_int
+
| 706
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Textures
ParticleBlendColor1
+
| t_vpath
| valign="top" |
+
|  
t_int
+
| 707
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
+
|}
-
+
 
| valign="top" align="center" |
+
 
V
+
== Objects ==
 +
Table id: 6 <small>(eObjects)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
ParticleBlendColor2
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_int
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
-
+
! style="width:5%" class="unsortable" | Storage
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Actions
ParticleBlendColor3
+
| t_links to [[#Actions|Actions]] (parent)
| valign="top" |
+
| All actions of the object. "ExecutionType" defines when the action is started.
t_int
+
| 172
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Animation
ParticleBlendColorCurve0
+
| t_link to [[#Animations|Animations]]
| valign="top" |
+
| Animation which is automatically started if this object is active (see "Condition" and "Value").
t_vfloat
+
| 171
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Animations
ParticleBlendColorCurve1
+
| t_links to [[#Animations|Animations]] (parent)
| valign="top" |
+
| All animations of the object.
t_vfloat
+
| 176
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Center
ParticleBlendColorCurve2
+
| t_int
| valign="top" |
+
| Defines the line number (y coordinate) which decides if a character is in front or behind this object.
t_vfloat
+
| 329
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Condition
ParticleBlendColorCurve3
+
| t_link to [[#Conditions|Conditions]]
| valign="top" |
+
| 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.
t_vfloat
+
| 169
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ConditionNegate
ParticleBlendMaxTile
+
| t_bool
| valign="top" |
+
| If true then the condition linked under "Condition" is negated.
t_int
+
| 359
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Conditions
ParticleBlendSizeCurve
+
| t_links to [[#Condition|Condition]] (parent)
| valign="top" |
+
| All conditions of the object.
t_vfloat
+
| 175
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| DestVisibility
| valign="top" align="center" |
+
| t_int
V
+
| 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| valign="top" |
+
| Direction
ParticleBlendTilesControlPoints
+
| t_int
| valign="top" |
+
| Direction in degrees which a character is aligned if it reaches this object ("Position").
t_vint
+
| 222
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| IsItem
ParticleBlendTilesCurve
+
| t_bool
| valign="top" |
+
| If true then this object is an item, otherwise it is a scene object.
t_vfloat
+
| 350
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| IsWalkable
ParticleCameraZPos
+
| t_bool
| valign="top" |
+
| If true then then no action can be executed on this object with the standard command (see "Interface > StandardCommand").
t_float
+
| 384
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Distance of the 'camera' to the z-layer.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| MatrixId
ParticleCameraZoom
+
| t_int
| valign="top" |
+
|
t_float
+
| 792
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Focal width of 'camera'.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Model
ParticleColorControlPoints0
+
| t_path
| valign="top" |
+
|
t_vint
+
| 791
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Name
ParticleColorControlPoints1
+
| t_link to [[#Texts|Texts]] (parent)
| valign="top" |
+
| The name of the object (as shown in the action text).
t_vint
+
| 251
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Offset
ParticleColorControlPoints2
+
| t_point
| valign="top" |
+
| 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.
t_vint
+
| 779
| valign="top" |
+
| class="cent" | <div class="tick"></div>
-
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ''ParticleSystem''
ParticleColorControlPoints3
+
| ''t_link to [[#ParticleSystems|ParticleSystems]]''
| valign="top" |
+
| ''DEPRECATED''
t_vint
+
| 467
| valign="top" |
+
| class="cent" |  
-
+
| class="cent" |  
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Polygon
ParticleEmitterSizeX
+
| t_vpoint
| valign="top" |
+
| Polygon which defines the border of the object. The object is detected if the cursor is inside the polygon.
t_int
+
| 341
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Width of particle emitter space.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Position
ParticleEmitterSizeY
+
| t_point
| valign="top" |
+
| 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.
t_int
+
| 339
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Height of particle emitter space.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Rotation
ParticleEmitterSizeZ
+
| t_float
| valign="top" |
+
| 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.
t_int
+
| 783
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Depth of particle emitter space.
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| RotationCenter
ParticleEmitterType
+
| t_point
| valign="top" |
+
| 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.
t_int
+
| 784
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Defines where the particles emit.<br/>
+
| class="cent" | S
'1': particles emit from one point in space (see ParticleXPos and ParticleYPos).<br/>
 
'2': particles emit from somewhere within a region in space (see ParticleXPos/ParticleYPos and ParticleEmitterSizeX/ParticleEmitterSizeY/ParticleEmitterSizeZ).
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Scale
ParticleForceBlend
+
| t_float
| valign="top" |
+
| 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.
t_float
+
| 786
| valign="top" |
+
| class="cent" | <div class="tick"></div>
-
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ScaleX
ParticleForceRotationX
+
| t_float
| valign="top" |
+
| Factor for horizontal scaling of the button (100 is original width).
t_int
+
| 812
| valign="top" |
+
| class="cent" | <div class="tick"></div>
-
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ScaleY
ParticleForceRotationZ
+
| t_float
| valign="top" |
+
| Factor for vertical scaling of the button (100 is original height).
t_int
+
| 812
| valign="top" |
+
| class="cent" | <div class="tick"></div>
-
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ScrollFactorX
ParticleForceStrength
+
| t_int
| valign="top" |
+
| 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).
t_float
+
| 538
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Strength of force which affects all particles.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ScrollFactorY
ParticleForceType
+
| t_int
| valign="top" |
+
| 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).
t_int
+
| 539
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Type of force. Possible values are: <br/>
+
| class="cent" | V
'0': directional. <br/>
 
'1': directional from point. <br/>
 
'2': point. <br />
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ShaderSet
ParticleForceXPos
+
| t_int
| valign="top" |
+
| Sets shader configuration id for an object and all of its animations, see "shaderSetOptions()" command.
t_float
+
| 785
| valign="top" |
+
| class="cent" | <div class="tick"></div>
-
+
| class="cent" | S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SnoopAnimation
ParticleForceYPos
+
| t_link to [[#Animations|Animations]]
| valign="top" |
+
| 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.
t_float
+
| 665
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SnoopAnimationPos
ParticleForceZPos
+
| t_point
| valign="top" |
+
| Absolute position of the "hotspot" (formerly known as "snoop") animation (see "SnoopAnimation") on the scene.
t_float
+
| 666
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Sprite
ParticleLeadTime
+
| t_link to [[#Sprites|Sprites]] (parent)
| valign="top" |
+
| Sprite which is shown if the object is active.
t_int
+
| 170
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Number of seconds the particle system is preplayed before it is displayed for the first time.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| TimeToDestVisibility
| valign="top" align="center" |
+
| t_int
V
+
| 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| valign="top" |
+
| Values
ParticleMaterialMode
+
| t_links to [[#Values|Values]] (parent)
| valign="top" |
+
| All values of the object.
t_int
+
| 333
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Value
ParticleMaxColor
+
| t_link to [[#Values|Values]]
| valign="top" |
+
| 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.
t_int
+
| 846
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The color of a particle will be between the colors ParticleMinColor and ParticleMaxColor.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ValueInt
ParticleMaxLife
+
| t_int
| valign="top" |
+
| Integer value for querying the value linked under "Value".
t_int
+
| 848
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Maximum lifetime of a particle.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ValueOperator
ParticleMaxParticle
+
| t_int
| valign="top" |
+
| Operator for querying the value linked under "Value". Possible values:
t_int
+
* 0: equals (=)
| valign="top" |
+
* 1: doesn't equal (!=)
Maximum number of particles (there may be less particles visible depending on creation and lifetime parameters).
+
* 2: equal or greater than (>=)
| valign="top" align="center" |
+
* 3: greater than (>)
-
+
* 4: equal or less than (<=)
| valign="top" align="center" |
+
* 5: less than (<)
V
+
| 847
 +
| 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
 +
|}
 +
 
 +
 
 +
== Outfits ==
 +
Table id: 17 <small>(eOutfits)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
ParticleMaxSize
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_float
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
Maximum size of a particle.
+
! style="width:5%" class="unsortable" | Storage
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| AmbientLightColor
ParticleMaxVelocity
+
| t_int
| valign="top" |
+
| 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.
t_float
+
| 729
| valign="top" |
+
| class="cent" | <div class="tick"></div>
Maximum velocity of a particle.
+
| class="cent" | V/S
| valign="top" align="center" |
+
|-
-
+
| CameraAngle
| valign="top" align="center" |
+
| t_float
V
+
| 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
 
|-
 
|-
| valign="top" |
+
| CharacterAnimations
ParticleMinColor
+
| t_links to [[#Animations|Animations]] (parent)
| valign="top" |
+
| Person animations, must be started manually.
t_int
+
| 269
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The color of a particle will be between the colors ParticleMinColor and ParticleMaxColor.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| CharacterSpeed
| valign="top" align="center" |
+
| t_int
V
+
| Speed of character with this outfit (in pixel per second).
 +
| 270
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 +
|-
 +
| LightColor
 +
| t_int
 +
| The color (RGB, 1 byte per channel) of the direct light source used to shade a 3D model.
 +
| 716
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| 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
 +
|
 +
| 716
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| valign="top" |
+
| Model
ParticleMinLife
+
| t_path
| valign="top" |
+
| Path to the 3D model file used for the outfit.
t_int
+
| 708
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Minimum lifetime of a particle.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ModelAmbientOcclusion
ParticleMinSize
+
| t_int
| valign="top" |
+
| This field controls the intensity of self-shadowing of a 3D model in percent using ambient occlusion. A value of 0 deactivates ambient occlusion.
t_float
+
| 752
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Minimum size of a particle.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ModelFiles
ParticleMinVelocity
+
| t_vpath
| valign="top" |
+
|
t_float
+
| 807
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Minimum velocity of a particle.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| ModelOutlineColor
| valign="top" align="center" |
+
| t_int
V
+
| The color used for the contours of 3D models.
 +
| 724
 +
| class="cent" | <div class="tick"></div>
 +
| 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
 
|-
 
|-
| valign="top" |
+
| ModelShadow
ParticlePerTime
+
| t_int
| valign="top" |
+
| 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.
t_float
+
| 751
| valign="top" |
+
| class="cent" | <div class="cross"></div>
New particles per time (with ~66 time units per second).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ModelShadowVisibility
ParticlePhiX
+
| t_int
| valign="top" |
+
| This field controls the visibility of the shadow of a 3D model in percent. A value of 0 deactivates shadows.
t_int
+
| 750
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Opening angle about the X-axis.
+
| class="cent" | V
| valign="top" align="center" |
+
|-  
-
+
| ModelShowOutline
| valign="top" align="center" |
+
| t_bool
V
+
| This flag indicates whether outlines of a 3D model are drawn.
 +
| 723
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| valign="top" |
+
| ModelTextures
ParticlePhiY
+
| t_vpath
| valign="top" |
+
| 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.
t_int
+
| 728
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Opening angle about the Z-axis.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| ModelToonNuances
| valign="top" align="center" |
+
| t_int
V
+
| 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
 
|-
 
|-
| valign="top" |
+
| ModelTurnSpeed
ParticlePosX
+
| t_int
| valign="top" |
+
|
t_int
+
| 867
| valign="top" |
+
| class="cent" | <div class="cross"></div>
X Position of particle emitter (in pixel coordinates).
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| ModelUseToonShading
| valign="top" align="center" |
+
| t_bool
V
+
| This flag indicates whether toon shading is used for a 3D model. The alternative is realistic shading.
 +
| 721
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| valign="top" |
+
| RandomAnimations
ParticlePosY
+
| t_links to [[#Animation|Animation]] (parent)
| valign="top" |
+
|
t_int
+
* 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).
| valign="top" |
+
* For non-playable characters (characters without an interface): Animations are shown after a random time span (between "RandomMinTime" and "RandomMaxTime" milliseconds).
Y Position of particle emitter (in pixel coordinates).
+
| 321
| valign="top" align="center" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| RandomMinTime
ParticleRotationX
+
| t_int
| valign="top" |
+
| Minimum time (in milliseconds) until a random animation (see "RandomAnimations") is started.
t_int
+
| 756
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| RandomMaxTime
ParticleRotationZ
+
| t_int
| valign="top" |
+
| Maximum time (in milliseconds) until a random animation (see "RandomAnimations") is started.
t_int
+
| 757
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| SlideWalkAnimation
ParticleSizeControlPoints
+
| t_bool
| valign="top" |
+
| 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.
t_vint
+
| 762
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V/S
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| StandingAnimations
ParticleTexture
+
| t_links to [[#Animations|Animations]] (parent)
| valign="top" |
+
| Standing animations, shown when person is standing.
t_path
+
| 383
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Sprite used for all particles.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| TalkAnimations
ParticleTilesX
+
| t_links to [[#Animations|Animations]] (parent)
| valign="top" |
+
| Talk animations.
t_int
+
| 268
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| TurnAnimations
ParticleTilesY
+
| t_links to [[#Animations|Animations]] (parent)
| valign="top" |
+
| Turn animations.
t_int
+
| 810
| valign="top" |
+
| class="cent" | <div class="cross"></div>
-
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| UseLight
ParticleType
+
| t_bool
| valign="top" |
+
|  
t_int
+
| 712
| valign="top" |
+
| class="cent" | <div class="tick"></div>
-
+
| class="cent" | V/S
| valign="top" align="center" |
+
|-
-
+
| WalkAnimations
| valign="top" align="center" |
+
| t_links to [[#Animations|Animations]] (parent)
V
+
| Walk animations.
 +
| 267
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|}
 
|}
  
== Point ==
+
 
{| class="gruen" border="1"
+
== ParticleContainers ==
| valign="top" |
+
Table id: 23 <small>(eParticleContainers)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| ''CameraZoom''
'''Storage'''
+
| ''t_float''
 +
| ''DEPRECATED''
 +
|
 +
| class="cent" |
 +
| class="cent" |  
 +
|-
 +
| ''CameraZPosition''
 +
| ''t_float''
 +
| ''DEPRECATED''
 +
|
 +
| class="cent" |
 +
| class="cent" |  
 
|-
 
|-
| rowspan="3" valign="top" |
+
| ''LeadTime''
Point
+
| ''t_links to [[#Particles|Particles]] (parent)''
| valign="top" |
+
| ''DEPRECATED''
PointPosition
+
|
| valign="top" |
+
| class="cent" |  
t_point
+
| class="cent" |  
| valign="top" |
 
Position on the scene.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ''Particles''
PointRelations
+
| ''t_links to [[#Particles|Particles]] (parent)''
| valign="top" |
+
| ''DEPRECATED''
t_links to [[#Point|Point]]
+
|
| valign="top" |
+
| class="cent" |  
Links to connected points for way system.
+
| class="cent" |  
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| PreviewScene
PointSize
+
| t_link to [[#Scenes|Scenes]]
| valign="top" |
+
| Scene for particles preview.
t_int
+
| 824
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Size for character on this point (in %).
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| Settings
| valign="top" align="center" |
+
| t_string
V
+
| Particle system settings.
 +
| 806
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 
|}
 
|}
  
== Scene ==
+
 
{| class="gruen" border="1"
+
== Particles ==
| valign="top" |
+
Table id: 22 <small>(eParticles)</small>
'''Table'''
+
 
| valign="top" |  
+
''DEPRECATED''
'''Field'''
+
 
| valign="top" |
+
 
'''Field Type'''
+
== Plugins ==
| valign="top" |
+
Table id: 39 <small>(ePlugins)</small>
'''Description'''
+
{| class="ts sortable"
| valign="top" align="center" |
+
|-
'''Scriptable'''
+
! style="width:15%" | Field
| valign="top" align="center" |
+
! style="width:15%" class="unsortable" | Type
'''Storage'''
+
! class="unsortable" | Description
 +
! style="width:3%" | id
 +
! style="width:5%" class="unsortable" | Scriptable
 +
! style="width:5%" class="unsortable" | Storage
 +
|-
 +
| Active
 +
| t_bool
 +
|
 +
| 860
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Data
 +
| t_string
 +
|
 +
| 862
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|-
 +
| Directory
 +
| t_string
 +
|  
 +
| 861
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
 
 +
 
 +
== Points ==
 +
Table id: 5 <small>(ePoints)</small>
 +
{| class="ts sortable"
 
|-
 
|-
| rowspan="23" valign="top" |
+
! style="width:15%" | Field
Scene
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
SceneActions
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_links to [[#Actions|Actions]] (parent)
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
 
All actions of the scene. These actions can only be started by another action.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Position
SceneActionAreas
+
| t_point
| valign="top" |
+
| Position on the scene.
t_links to [[#ActionArea|ActionArea]] (parent)
+
| 146
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All action areas of the scene (areas which contain actions that are executed if a character enters or leaves the area).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
SceneBackgroundMusic
 
| valign="top" |
 
t_path
 
| valign="top" |
 
Background music which is played in a loop.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
SceneBrightness
 
| valign="top" |
 
t_int
 
| valign="top" |
 
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).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
S
 
 
|-
 
|-
| valign="top" |
+
| Relations
SceneConditions
+
| t_links to [[#Points|Points]]
| valign="top" |
+
| Links to connected points for way system.
t_links to [[#Condition|Condition]] (parent)
+
| 147
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All conditions of the scene.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Size
SceneContinueMusic
+
| t_int
| valign="top" |
+
| Size for character on this point (in percent).
t_bool
+
| 145
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then the background music from the last scene is continued instead of playing the background music of this scene (SceneBackgroundMusic).
+
| class="cent" | V
| valign="top" align="center" |
+
|}
-
+
 
| valign="top" align="center" |
+
 
V
+
== Scenes ==
|- class="scriptable"
+
Table id: 4 <small>(eScenes)</small>
| valign="top" |
+
{| class="ts sortable"
SceneCurrentWaySystem
 
| valign="top" |
 
t_link to [[#WaySystem|WaySystem]]
 
| valign="top" |
 
Currently used way system (only relevant if SceneIsMenu is false).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
SceneCursor
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_link to [[#Cursor|Cursor]]
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
Cursor which is displayed on this scene (only used if SceneIsMenu is true).
+
! style="width:5%" class="unsortable" | Storage
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
SceneLightMap
 
| valign="top" |
 
t_path
 
| valign="top" |
 
Sprite which is used as a lightmap for the scene. The lightmap defines how the characters are shaded on different positions on the scene.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Actions
SceneIsMenu
+
| t_links to [[#Actions|Actions]] (parent)
| valign="top" |
+
| All actions of the scene. These actions can only be started by another action.
t_bool
+
| 335
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then this scene is a menu (for savegames, options, etc.) otherwise it is a playable scene (where characters can move, etc.).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
SceneMusicBalance
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Balance of the background music (SceneBackgroundMusic). Must be between '-100' (only left speaker) and '100' (only right speaker).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
|- class="scriptable"
 
| valign="top" |
 
SceneMusicVolume
 
| valign="top" |
 
t_int
 
| valign="top" |
 
Volume of the background music (SceneBackgroundMusic). Must be between '0' (mute) and '100' (full volume).
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| ActionAreas
SceneName
+
| t_links to [[#ActionAreas|ActionAreas]] (parent)
| valign="top" |
+
| All action areas of the scene (areas which contain actions that are executed if a character enters or leaves the area).
t_link to [[#Text|Text]] (parent)
+
| 681
| valign="top" |
+
| class="cent" | <div class="cross"></div>
The name of the scene (used for name in savegames).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| AudioBusses
SceneObjects
+
| t_links to [[#AudioBusses|AudioBusses]]
| valign="top" |
+
|  
t_links to [[#Object|Object]] (parent)
+
| 838
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All objects of the scene.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| BackgroundMusic
| valign="top" align="center" |
+
| t_path
V
+
| Background music which is played in a loop.
 +
| 132
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | 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
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | S
 
|-
 
|-
| valign="top" |
+
| CDTrack
SceneParticleSystem
+
| t_int
| valign="top" |
+
|  
t_link to [[#ParticleContainer|ParticleContainer]]
+
| 133
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Particle system of the scene which is always shown.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Conditions
SceneSavegameAreas
+
| t_links to [[#Conditions|Conditions]] (parent)
| valign="top" |
+
| All conditions of the scene.
t_vrect
+
| 330
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All areas where savegame screenshots are shown. A savegame can be selected by clicking inside an area.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| ContinueMusic
SceneSavegameFont
+
| t_bool
| valign="top" |
+
| If true then the background music from the last scene is continued instead of playing the background music of this scene ("BackgroundMusic").
t_link to [[#Font|Font]]
+
| 365
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Font which is used for the name of the savegame.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| CurrentWaySystem
| valign="top" align="center" |
+
| t_link to [[#WaySystems|WaySystems]]
V
+
| Currently used way system (only relevant if "IsMenu" is false).
 +
| 641
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| valign="top" |
+
| Cursor
SceneSavegameScrollStep
+
| t_link to [[#Cursors|Cursors]]
| valign="top" |
+
| Cursor which is displayed on this scene (only used if "IsMenu" is true).
t_int
+
| 293
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Defines how many savegame positions will be scrolled if the savegames are scrolled with an actionpart.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
SceneScrollableArea
 
| valign="top" |
 
t_rect
 
| valign="top" |
 
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.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|-
 
|-
|- class="scriptable"
+
| Curves
| valign="top" |
+
| t_links to [[#Curves|Curves]]
SceneScrollOnEdges
+
|
| valign="top" |
+
| 892
t_bool
+
| class="cent" | <div class="cross"></div>
| valign="top" |
+
| class="cent" | V
If true then the scene will be scrolled if the cursor is on the screen edge.
+
|-
| valign="top" align="center" |
+
| LightMap
Yes
+
| t_path
| valign="top" align="center" |
+
| Sprite which is used as a lightmap for the scene. The lightmap defines how the characters are shaded on different positions on the scene.
V/S
+
| 550
 +
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| valign="top" |
+
| IsMenu
SceneSprite
+
| t_bool
| valign="top" |
+
| If true then this scene is a menu (for savegames, options, etc.), otherwise it is a playable scene (where characters can move, etc.).
t_sprite
+
| 292
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Background sprite of the scene.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| MusicBalance
| valign="top" align="center" |
+
| t_int
V
+
| 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
 
|-
 
|-
| valign="top" |
+
| Name
SceneValues
+
| t_link to [[#Texts|Texts]] (parent)
| valign="top" |
+
| The name of the scene (used for name in savegames).
t_links to [[#Value|Value]] (parent)
+
| 364
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All values of the scene.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Objects
SceneWaySystems
+
| t_links to [[#Objects|Objects]] (parent)
| valign="top" |
+
| All objects of the scene.
t_links to [[#WaySystem|WaySystem]] (parent)
+
| 136
| valign="top" |
+
| class="cent" | <div class="cross"></div>
All way systems of the scene.
+
| class="cent" | V
| valign="top" align="center" |
+
|-
-
+
| ParticleSystem
| valign="top" align="center" |
+
| t_link to [[#ParticleContainers|ParticleContainers]]
V
+
| 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
 
|}
 
|}
  
== Script ==
+
 
{| class="gruen" border="1"
+
== Scripts ==
| valign="top" |
+
Table id: 30 <small>(eScripts)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
Script
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
ScriptScript
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_string
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
+
|-
Script content.
+
| Script
| valign="top" align="center" |
+
| t_string
-
+
| Script content.
| valign="top" align="center" |
+
| 652
V
+
| 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
 
|}
 
|}
  
== Sprite ==
+
 
{| class="gruen" border="1"
+
== ScriptVariables ==
| valign="top" |
+
Table id: 34 <small>(eScriptVariables)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| valign="top" |
+
| IsGlobalVar
Sprite
+
| t_bool
| valign="top" |
+
|
SpriteSprite
+
| 697
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_sprite
+
| class="cent" | S
| valign="top" |
+
|-
-
+
| Items
| valign="top" align="center" |
+
| t_links
-
+
|
| valign="top" align="center" |
+
| 698
V
+
| 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
 
|}
 
|}
  
== Text ==
+
 
{| class="gruen" border="1"
+
== Shaders ==
| valign="top" |
+
Table id: 36 <small>(eShaders)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |  
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
+
|-
| valign="top" align="center" |
+
| Compiled
'''Storage'''
+
| 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
 
|-
 
|-
| valign="top" |
+
| VS
Text
+
| t_string
| valign="top" |
+
|  
TextAll
+
| 822
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_links to [[#TextLanguage|TextLanguage]] (parent)
+
| class="cent" | V
| valign="top" |
 
Language dependent texts for this text entry.
 
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== TextLanguage ==
+
 
{| class="gruen" border="1"
+
== Sprites ==
| valign="top" |
+
Table id: 13 <small>(eSprites)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
+
|-
'''Field'''
+
! style="width:15%" | Field
| valign="top" |
+
! style="width:15%" class="unsortable" | Type
'''Field Type'''
+
! class="unsortable" | Description
| valign="top" |
+
! style="width:3%" | id
'''Description'''
+
! style="width:5%" class="unsortable" | Scriptable
| valign="top" align="center" |
+
! style="width:5%" class="unsortable" | Storage
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="3" valign="top" |
+
| Sprite
TextLanguage
+
| t_sprite
| valign="top" |
+
|
TextLanguageLanguage
+
| 237
| valign="top" |
+
| class="cent" | <div class="cross"></div>
t_link to [[#Language|Language]]
+
| class="cent" | V
| valign="top" |
+
|}
Language of this text.
+
 
| valign="top" align="center" |
+
 
-
+
== Texts ==
| valign="top" align="center" |
+
Table id: 14 <small>(eTexts)</small>
V
+
{| class="ts sortable"
 
|-
 
|-
| valign="top" |
+
! style="width:15%" | Field
TextLanguageSound
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
t_path
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
Voice output file for this text.
+
! style="width:5%" class="unsortable" | Storage
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| TextLanguages
TextLanguageText
+
| t_vtext
| valign="top" |
+
| Language-dependent texts for this text entry.
t_string
+
| 761
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Language dependent text.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|}
 
|}
  
== Value ==
+
 
{| class="gruen" border="1"
+
== TextLanguages ==
| valign="top" |
+
Table id: 19 <small>(eTextLanguages)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="5" valign="top" |
+
! style="width:15%" | Field
Value
+
! style="width:15%" class="unsortable" | Type
| valign="top" class="scriptable" |
+
! class="unsortable" | Description
ValueInt
+
! style="width:3%" | id
| valign="top" class="scriptable" |
+
! style="width:5%" class="unsortable" | Scriptable
t_int
+
! style="width:5%" class="unsortable" | Storage
| valign="top" class="scriptable" |
 
The current integer value.
 
| valign="top" align="center" class="scriptable" |
 
Yes
 
| valign="top" align="center" class="scriptable" |
 
V/S
 
 
|-
 
|-
| valign="top" |
+
| Language
ValueRandom
+
| t_link to [[#Languages|Languages]]
| valign="top" |
+
|
t_bool
+
| 258
| valign="top" |
+
| class="cent" | <div class="cross"></div>
If true then the value (ValueInt) will be set to a random value (between ValueRandomMin and ValueRandomMax) at the beginning of the game.
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Sound
ValueRandomMax
+
| t_path
| valign="top" |
+
|
t_int
+
| 257
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Upper bound for random value (see ValueRandom).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
 
|-
 
|-
| valign="top" |
+
| Text
ValueRandomMin
+
| t_string
| valign="top" |
+
|  
t_int
+
| 256
| valign="top" |
+
| class="cent" | <div class="cross"></div>
Lower bound for random value (see ValueRandom).
+
| class="cent" | V
| valign="top" align="center" |
 
-
 
| valign="top" align="center" |
 
V
 
|- class="scriptable"
 
| valign="top" |
 
ValueString
 
| valign="top" |
 
t_string
 
| valign="top" |
 
The current string value.
 
| valign="top" align="center" |
 
Yes
 
| valign="top" align="center" |
 
V/S
 
 
|}
 
|}
  
== WaySystem ==
+
 
{| class="gruen" border="1"
+
== Values ==
| valign="top" |
+
Table id: 20 <small>(eValues)</small>
'''Table'''
+
{| class="ts sortable"
| valign="top" |
 
'''Field'''
 
| valign="top" |
 
'''Field Type'''
 
| valign="top" |
 
'''Description'''
 
| valign="top" align="center" |
 
'''Scriptable'''
 
| valign="top" align="center" |
 
'''Storage'''
 
 
|-
 
|-
| rowspan="2" valign="top" |
+
! style="width:15%" | Field
WaySystem
+
! style="width:15%" class="unsortable" | Type
| valign="top" |
+
! class="unsortable" | Description
WaySystemBorder
+
! style="width:3%" | id
| valign="top" |
+
! style="width:5%" class="unsortable" | Scriptable
t_vpoint
+
! style="width:5%" class="unsortable" | Storage
| valign="top" |
+
|-  
Polygon which defines the wayborders of the scene. A character is only allowed to walk inside the wayborders.
+
| Float
| valign="top" align="center" |
+
| t_float
-
+
| The current float value.
| valign="top" align="center" |
+
| 805
V
+
| class="cent" | <div class="tick"></div>
 +
| class="cent" | V/S
 
|-
 
|-
| valign="top" |
+
| Int
WaySystemPoints
+
| t_int
| valign="top" |
+
| The current integer value.
t_links to [[#Point|Point]] (parent)
+
| 328
| valign="top" |
+
| class="cent"  | <div class="tick"></div>
Waypoints of the scene which store the character size. The waypoints are connected to each other to define where a character can walk.
+
| class="cent"  | V/S
| valign="top" align="center" |
+
|-
-
+
| Random
| valign="top" align="center" |
+
| t_bool
V
+
| 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
 
|}
 
|}
  
----
+
 
{{i18n|Scripting}}
+
== 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
 +
| 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" | V
 +
|-
 +
| Points
 +
| t_links to [[#Points|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
 +
| class="cent" | <div class="cross"></div>
 +
| class="cent" | V
 +
|}
 +
{{toc}}

Latest revision as of 14:03, 16 January 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
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