Difference between revisions of "Actionparts Documentation"

From VisionaireWiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 987: Line 987:
 
| -
 
| -
 
| -
 
| -
 +
|-
 
| '155': [http://wiki.visionaire2d.net/index.php?title=Actionparts#Show_object_text SHOW_OBJECT_TEXT]
 
| '155': [http://wiki.visionaire2d.net/index.php?title=Actionparts#Show_object_text SHOW_OBJECT_TEXT]
 
| text
 
| text
 
| object
 
| object
 
| -
 
| -
| x-coordinate of point
+
| x-coordinate
| y-coordinate of point
+
| y-coordinate
 
|
 
|
 
'0': align text left<br/>
 
'0': align text left<br/>
Line 999: Line 1,000:
 
| -
 
| -
 
|-
 
|-
| '156': [http://wiki.visionaire2d.net/index.php?title=Actionparts#Show_hide_snoop_animations SHOW_HIDE_SNOOP_ANIMATIONS]
+
| '156': [http://wiki.visionaire2d.net/index.php?title=Actionparts#Hide_object_text HIDE_OBJECT_TEXT]
 
| object
 
| object
 
| -
 
| -

Latest revision as of 15:26, 2 April 2013

All available actionparts are listed here. Each actionpart is stored as one object in the ActionPart table of the Visionaire Data Structure. The 'constant number' is the number which is stored in the field ActionPartCommand and defines the actionpart. Each actionpart can have a maximum of two links, three numbers and one file path. This document shows which fields are used for which actionpart. If there is a link to a scene or a character (in ActionPartLink or ActionPartAltLink) and the link is empty then the current scene/character is used.

Constant number/name
ActionPartLink
ActionPartAltLink
ActionPartPath
ActionPartInt
ActionPartAltInt
ActionPartAltInt2
ActionPartString
'5': ELSE - - - - - -
'6': ENDIF - - - - - -
'10': CHANGE_SCENE object character -

'1': fade into new scene
'0' no fade effect

direction (degrees) the character is looking on the new scene
'-1': character is looking in opposite direction of object

'12': CHANGE_CHARACTER character - - '1': fade into new scene, '0' no fade effect (if character is on another scene) - -
'13': START_DIALOG dialog - - - - -
'14': STOP_DIALOG - - - - - -
'16': EXIT_ACTION action - - - - - -
'19': SHOW_HIDE_ANIMATION animation - -

'0': show animation
'1': hide animation

'1': play animation in reverse direction
else play in normal direction

'0': proceed immediately with next action part.
'1': wait until animation is finished before processing next action part.

-
'22': WAITON_ANIMATION animation - - - - -
'23': SHOW_TEXT text character -

'0': foreground text
'1': background text

- - -
'24': PLAY_SOUND - - sound file volume (between '0' and '100') balance (between '-100' and '100')

'0': sound must be stopped manually
'1': sound will be stopped automatically if scene is changed

-
'30': MAKE_PAUSE value - - delay (msec) unit:

'0': milliseconds
'1': seconds
'2': minutes

-
'31': CHARACTER_GOTO character object - '0': proceed immediately with next action part.

'1': wait until character reaches object before processing next action part.

- -
'32': WAITON_CHARACTER character - - - - -
'45': SET_COMMAND button (command) - - - - -
'46': SHOW_SCENE scene - -

'1': fade into new scene
'0' no fade effect

- -
'47': CHARACTER_GOTO_XY character - - x-coordinate of point y-coordinate of point '0': proceed immediately with next action part.

'1': wait until character reaches position before processing next action part.

'48': SCROLL_SCENE object - - - - - -
'49': SCROLL_SCENE_XY - - - x-coordinate of point y-coordinate of point - -
'50': SET_CHARACTER_TO_OBJECT character object - direction (degrees) the character is looking

'-1': character looks in direction of object

- -
'51': CHANGE_OUTFIT outfit - - '0': unload animations of old outfit

'1': do not unload animations of old outfit

- -
'52': CHANGE_COMMENTSET commentset - - - - -
'53': CHANGE_LANGUAGE language - - - - -
'54': SHOW_CHARACTER character - -

'1': fade into new scene
'0' no fade effect

- -
'55': QUIT_GAME - - - - - -
'56': SHOW_HIDE_INTERFACE interfaceclass - -

'0': show
'1': hide
'2': change

- - -
DEPRECATED - '56': SHOW_HIDE_INTERFACE interface - - number of active interface of current character which is shown/hidden (only used if ActionPartLink is not set)

'0': show
'1': hide
'2': change

- -
'58': ALIGN_CHARACTER character - - direction (degrees) - -
'59': SET_MUSIC scene - music file volume (between '0' and '100') balance (between '-100' and '100') -
'60': SET_SCROLLCHARCTER character - -

'0': center character
'1': do not center character

- -
'66': PLAY_VIDEO - - movie file

'0': play movie centered
'1': scale movie to fullscreen

'0': all sounds are paused and only continued after the action which started the video is interupted (finished or paused, etc.) -> if a new scene is shown immediately after the video the active sounds started before the video are removed.
'1': pause all active sounds and continue them after video
'2': stop all active sounds

-
'69': IF_VALUE value value (optional) -

'0': ==
'1': !=
'2': <=
'3': <
'4': >=
'5': >

number (only used if ActionPartAltLink is empty) -
'70': SET_VALUE value value (optional) -

'0': =
'1': +=
'2': -=
'3': *=
'4': /=

number (only used if ActionPartAltLink is empty) -
'71': SHOW_TEXT_XY text font - x-coordinate y-coordinate

'0': foreground text
'1': background text

-
'72': PLAY_LOOPED_SOUND - - sound file volume (between '0' and '100') balance (between '-100' and '100')

'0': sound must be stopped manually
'1': sound will be stopped automatically if scene is changed

-
'73': STOP_SOUND - - sound file - - -
'77': CHANGE_SOUND_SETTINGS - - sound file volume (between '0' and '100') balance (between '-100' and '100') -
'78': GOTO - - -

'0': jump relative
else jump absolute

jump to -
'79': IF_CHARACTER character - - - - -
'80': REMOVE_ALL_ITEMS_FROM_CHARACTER character - - - - -
'81': GIVE_ALL_ITEMS_TO character (from) character (to) - - - -
'82': SET_CHARACTERSPEED character - - speed - -
'83': SET_RANDOM_VALUE value - - from to -
'84': IF_CHARACTER_ON_SCENE character scene - - - -
'85': FOLLOW_CHARACTER character action -

'0': chase current character
'1': current character is chasing

reach distance -
'86': STOP_FOLLOW character - - - - -
'87': STOP_CHARACTER character - - - - -
'88': CHANGE_WALKINGSOUND character - sound file - - -
'89': CHANGE_FONT font character - - - -
'90': CHANGE_INTERFACE interface to set - - - - -
DEPRECATED - '90': CHANGE_INTERFACE interface to set interface to replace - number of active interface of current character which is replaced (only used if ActionPartAltLink is not set) - -
'92': IF_LANGUAGE language - - - - -
'94': SET_CURSOR cursor - - - - -
'95': IF_COMMAND button (command) - - - - -
'98': HIDE_CHARACTER character - -

'1': hide
'0': show

- -
'99': SAVE_OBJECT - - - - - -
'100': EXEC_SAVEDOBJECT - - - - - -
'103': IF_CURRENT_OBJECT - - -

'0': exists
'1': not exists
'2': scene object
'3': item
'4': character

- -
'105': SET_ACTIVE_SPRITE button - -

'0': inactive sprite
'1': active sprite

- -
'106': CLEAR_SAVEDOBJECT - - - - - -
'107': SKIP_CURRENT_TEXT - - - - - -
'110': SET_FADE_EFFECT - - -

'0': no effect
'1': fade in
'2': fade out
'3': fade in/out
'4': fade to new
'5': shift left
'6': shift right
'7': tunnel effect

delay (in msec) -
'111': FADE_OBJECT object value - visibility: must be between '0' and '100' (only used if value is empty) delay (in msec) -
'112': FADE_INTERFACE interfaceclass - - visibility: must be between '0' and '100' delay (in msec) - -
DEPRECATED - '112': FADE_INTERFACE interface - - number of active interface of current character (only used if ActionPartLink is not set) visibility: must be between '0' and '100' delay (in msec) -
'114': SET_LIGHTMAP scene - image file - - - -
'115': SET_BRIGHTNESS scene - - brightness: must be between '0' and '100' - - -
'116': FADE_CHARACTER character value - visibility: must be between '0' and '100' (only used if value is empty) delay (in msec) - -
'117': SET_PICKUP_ITEM object (item) - -

'1': picked up item
'0': item for combined command

- - -
'121': DELETE_SAVEGAME - - -

'0': delete savegame
'1': delete autosave

number of autosave (only used if ActionPartInt = 1) - -
'123': IF_SAVEGAME_EXISTS - - - -

'0': test selected savegame
'1': test any savegame
'2': test autosave

number of autosave (only used if ActionPartInt = 2) - -
'124': SET_CHARACTERANIM_INDEX character - - index - - -
'125': WAITON_SOUND - - sound file - - - -
'126': SET_HORIZONTAL_SCROLLABLE_AREA scene - - left border right border - -
'127': SET_VERTICAL_SCROLLABLE_AREA scene - - upper border lower border - -
'130': KEEP_SCENE_IN_MEM - - -

'0': keep scene objects and characters
'1': keep scene objects
'2': keep characters

max. number of scene changes to keep sprites - -
'131': SET_TEXT_OUTPUT - - -

'0': text and speech output
'1': only speech output
'2': only text output

- - -
'132': SET_CHARACTER_TO_POSITION character scene - x-coordinate of point y-coordinate of point - -
'133': CHANGE_WAYSYSTEM way system - - - - - -
'134': SET_FIRST_ANIMATION_FRAME animation - - first animation frame - - -
'135': SET_LAST_ANIMATION_FRAME animation - - last animation frame - - -
'136': SET_TEXT_SPEED value - - speed in % - - -
'137': CALL_SCRIPT script - - - - - function name to call
'138': EXECUTE_SCRIPT - - - - - - script content
'139': SET_CONDITION condition - -

'0': true
'1': false

- - -
'140': IF_CONDITION condition - -

'0': true
'1': false

- - -
'141': SHOW_HIDE_CURSOR cursor - -

'0': show
'1': hide

- - -
'142': SHOW_HIDE_INTERFACES - - -

'0': show
'1': hide

- - -
'143': START_STOP_EARTHQUAKE - - -

'0': start earthquake
'1': stop earthquake

force (in pixel) speed -
'144': BEGIN_END_CUTSCENE - - - '0': start earthquake

'1': stop earthquake

- - -
'145': LOAD_SAVE_BOOKMARK - - -

'0': load bookmark
'1': save bookmark

number of savegame: '0' - '99'

'0': do not save action where this action part is defined.
'1': also save action where this action part is defined.

-
'146': LOAD_SAVE_GAME - - -

'0': load game
'1': save game

'0': do not save action where this action part is defined.
'1': also save action where this action part is defined.

- -
'147': SET_VOLUME - - -

'0': sound volume
'1': music volume
'2': speech volume
'3': movie volume
'4': global volume

'0': =
'1': +=
'2': -=

volume (between '0' and '100') -
'148': CALL_EXIT_ACTION action - -

'0': call action
'1': exit action

- - -
'149': PRELOAD_UNLOAD_ANIMATION animation - -

'0': preload animation
'1': unload animation

- - -
'150': ADD_REMOVE_ITEM object (item) character -

'0': add item
'1': remove item

'0': do not scroll items
'1': scroll items so that added item is visible (i.e. scroll to end of items because added item is at the end of item list)

- -
'151': SCROLL_SAVEGAMES - - -

'0': next savegames
'1': previous savegames

- - -
'152': SET_ANIMATION_POSITION animation - - x-coordinate y-coordinate

'0': =
'1': +=
'2': -=

-
'153': SHOW_HIDE_SNOOP_ANIMATIONS - - -

'0': show
'1': hide

- - -
'154': PRELOAD_UNLOAD_CHARACTER character - -

'0': preload character
'1': unload character

- - -
'155': SHOW_OBJECT_TEXT text object - x-coordinate y-coordinate

'0': align text left
'1': align text centered
'2': align text right

-
'156': HIDE_OBJECT_TEXT object - - - - - -