Difference between revisions of "Action System"

From The Official Visionaire Studio: Adventure Game Engine Wiki
m
Line 4: Line 4:
 
== Action Types ==
 
== Action Types ==
 
Here is a list of available action types, a description & where they can be used.
 
Here is a list of available action types, a description & where they can be used.
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+
<div class="toccolours mw-collapsible mw-collapsed ts">
 
<span class="bold">Additional Info</span>
 
<span class="bold">Additional Info</span>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Line 13: Line 13:
  
 
=== Execution at destination ===
 
=== Execution at destination ===
{| class="tbl-ds"
+
{| class="ts"
 
|- align="left" style="background-color:#cccccc"
 
|- align="left" style="background-color:#cccccc"
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description !! style="border-bottom: 1px dashed grey" | Available Location(s)
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description !! style="border-bottom: 1px dashed grey" | Available Location(s)
Line 31: Line 31:
  
 
=== Immediate execution ===
 
=== Immediate execution ===
{| class="tbl-ds"
+
{| class="ts"
 
|- align="left" style="background-color:#cccccc"
 
|- align="left" style="background-color:#cccccc"
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description !! style="border-bottom: 1px dashed grey" | Available Location(s)
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description !! style="border-bottom: 1px dashed grey" | Available Location(s)
Line 61: Line 61:
  
  
{| class="tbl-ds"
+
{| class="ts"
 
|- align="left" style="background-color:#cccccc"
 
|- align="left" style="background-color:#cccccc"
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description
Line 79: Line 79:
  
  
{| class="tbl-ds"
+
{| class="ts"
 
|- align="left" style="background-color:#cccccc"
 
|- align="left" style="background-color:#cccccc"
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description
Line 100: Line 100:
  
  
{| class="tbl-ds"
+
{| class="ts"
 
|- align="left" style="background-color:#cccccc"
 
|- align="left" style="background-color:#cccccc"
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description
 
! style="border-bottom: 1px dashed grey" | Type !! style="border-bottom: 1px dashed grey" | Description
Line 119: Line 119:
 
|-
 
|-
 
| '''Called by other action''' || this action is not directly associated with the object & can be called at any time via the '''call/quit action''' action par
 
| '''Called by other action''' || this action is not directly associated with the object & can be called at any time via the '''call/quit action''' action par
|}
+
|}{{toc}}

Revision as of 12:27, 6 October 2015

The action system is what we use to create the various actions & events that will be performed during the game on characters, self, scene objects, & items. The available action parts may vary depending on where the action is created; scene, scene object, character, item, interface button, game etc.


Action Types

Here is a list of available action types, a description & where they can be used.

Additional Info

The Called by other action action is a special case as it is not directly tied to any object, scene, character, or interface button etc, as it can be called anywhere, at any time via the call/quit action action part.


Execution at destination

Type Description Available Location(s)
Executed command on object actions will only be performed if the current character reaches the object destination & if the executed command is listed inside of the object actions. scene objects, characters
Item dropped actions will only be executed if the current character reaches the object destination & the dropped item action is listed inside of the object actions. scene objects, characters
Double click actions will only be executed if the current character reaches the object destination & the double click action is listed inside of the object actions. scene objects, characters
Button hold actions will only be executed if the current character reaches the object destination & the button hold action is listed inside of the object actions; see mouse properties. scene objects, characters
Right click actions will only be executed if the current character reaches the object destination & the right click action is listed inside of the object actions. scene objects, characters


Immediate execution

Type Description Available Location(s)
Executed command on object actions will be executed immediately if the executed command (immediate) is listed inside of the objects actions. all action tabs
Item dropped actions will be executed immediately if the dropped item (immediate) action is listed inside of the object actions. all action tabs
Double click actions will only be executed if the current character reaches the object destination & the double click action is listed inside of the object actions. all action tabs
Button hold actions will only be executed if the current character reaches the object destination & the button hold action is listed inside of the object actions; see mouse properties. all action tabs
Right click actions will only be executed if the current character reaches the object destination & the right click action is listed inside of the object actions. all action tabs
Cursor enters object area actions will be executed when the mouse cursor enters the object area; providing the on cursor enters action is listed in the objects actions. all action tabs
Cursor leaves object area actions will be executed when the mouse cursor leaves the object area; providing the on cursor leaves action is listed in the objects actions. all action tabs
Called by other action this action is not directly associated with the object & can be called at any time via the call/quit action action part. all action tabs


Locations

These actions belong to specific sections of the Visionaire Studio editor.


Scene

The commands listed below are exclusive to the scene actions tab.


Type Description
At beginning of scene action parts listed here will be performed on scene load.
At end of scene action parts listed here will be performed on scene close.


Items

The items commands are very similar to the general execution at destination, & immediate execution commands. Because the current character already has the items in their inventory, the commands require no distinction between commands executed at destination, or commands executed immediately.


Execution at destination

to do... types & descriptions were copied from action types section (above).


Type Description
Executed command on object actions will only be performed if the current character reaches the object destination & if the executed command is listed inside of the object actions.
Item dropped actions will only be executed if the current character reaches the object destination & the dropped item action is listed inside of the object actions.
Double click actions will only be executed if the current character reaches the object destination & the double click action is listed inside of the object actions.
Button hold actions will only be executed if the current character reaches the object destination & the button hold action is listed inside of the object actions; see mouse properties.
Right click actions will only be executed if the current character reaches the object destination & the right click action is listed inside of the object actions.


Immediate execution

to do... types & descriptions were copied from action types section (above).


Type Description
Executed command on object actions will be executed immediately if the executed command (immediate) is listed inside of the objects actions.
Item dropped actions will be executed immediately if the dropped item (immediate) action is listed inside of the object actions.
Double click actions will only be executed if the current character reaches the object destination & the double click action is listed inside of the object actions.
Button hold actions will only be executed if the current character reaches the object destination & the button hold action is listed inside of the object actions; see mouse properties.
Right click actions will only be executed if the current character reaches the object destination & the right click action is listed inside of the object actions.
Cursor enters object area actions will be executed when the mouse cursor enters the object area; providing the on cursor enters action is listed in the objects actions.
Cursor leaves object area actions will be executed when the mouse cursor leaves the object area; providing the on cursor leaves action is listed in the objects actions.
Called by other action this action is not directly associated with the object & can be called at any time via the call/quit action action par