User Tools

Site Tools


scripting_reference

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
scripting_reference [2024/02/22 11:56] justinscripting_reference [2024/03/11 11:25] justin
Line 18: Line 18:
 ^Variable^Description^Data Type^ ^Variable^Description^Data Type^
 |camera.direction|Direction in which the camera is currently facing (nearest [[cardinal direction]], either NORTH, SOUTH, WEST, or EAST).|[[Cardinal Direction]]| |camera.direction|Direction in which the camera is currently facing (nearest [[cardinal direction]], either NORTH, SOUTH, WEST, or EAST).|[[Cardinal Direction]]|
 +|camera.type|Current camera type (STANDARD, ISOMETRIC, or FIRST_PERSON).|Camera Type|
 +|camera.view_model|Current view model [[entity]] for the camera. Can be used to retrieve or modify the view model.|[[Entity]]|
  
 =====Party Variables===== =====Party Variables=====
 ^Variable^Description^Data Type^ ^Variable^Description^Data Type^
 |party.member["x"]|[[Character]] in the player's party, where "x" is the character's member ID as assigned via the [[Add Party Member]] function. The primary [[player character]] can be referenced using a member ID of "player".|[[Entity]]| |party.member["x"]|[[Character]] in the player's party, where "x" is the character's member ID as assigned via the [[Add Party Member]] function. The primary [[player character]] can be referenced using a member ID of "player".|[[Entity]]|
-|party|[[Codex]] containing all members of the player's party. It will contain a key for each member ID, with each corresponding value a reference to the [[character]]. This can also be used as shorthand for the "party.member" syntaxfor example party["member_id"] is equivalent to party.member["member_id"].|[[Codex]]|+|party|[[Codex]] containing all members of the player's party. It will contain a key for each member ID, with each corresponding value a reference to the [[character]]. This can also be used as shorthand for "party.member", e.g. **party["member_id"]** is equivalent to **party.member["member_id"]**.|[[Codex]]|
  
 =====System Variables===== =====System Variables=====
Line 82: Line 84:
 |[[detach_effect|Detach Effect]]|**detach_effect**(//entity//, //attach_id//)| |[[detach_effect|Detach Effect]]|**detach_effect**(//entity//, //attach_id//)|
 |[[detach_object|Detach Object]]|**detach_object**(//entity//, //attach_id//)| |[[detach_object|Detach Object]]|**detach_object**(//entity//, //attach_id//)|
 +|[[disable_action|Disable Action]]|**disable_action**(//action_id//)|
 |[[disable_container|Disable Container]]|**disable_container**(//entity_id//)| |[[disable_container|Disable Container]]|**disable_container**(//entity_id//)|
 |[[disable_conveyor|Disable Conveyor]]|**disable_conveyor**(//conveyor_group//)| |[[disable_conveyor|Disable Conveyor]]|**disable_conveyor**(//conveyor_group//)|
Line 91: Line 94:
 |[[display_image|Display Image]]|**display_image**(//image_name//, //*duration//, //*bg_color//, //*stretch_mode//)| |[[display_image|Display Image]]|**display_image**(//image_name//, //*duration//, //*bg_color//, //*stretch_mode//)|
 |[[display_message|Display Message]]|**display_message**(//message_text//, //*speaker//)| |[[display_message|Display Message]]|**display_message**(//message_text//, //*speaker//)|
 +|[[enable_action|Enable Action]]|**enable_action**(//action_id//)|
 |[[enable_container|Enable Container]]|**enable_container**(//entity_id//)| |[[enable_container|Enable Container]]|**enable_container**(//entity_id//)|
 |[[enable_conveyor|Enable Conveyor]]|**enable_conveyor**(//conveyor_group//)| |[[enable_conveyor|Enable Conveyor]]|**enable_conveyor**(//conveyor_group//)|
Line 207: Line 211:
 |[[set_vision_height|Set Vision Height]]|**set_vision_height**(//character//, //height//)| |[[set_vision_height|Set Vision Height]]|**set_vision_height**(//character//, //height//)|
 |[[set_zone_script|Set Zone Script]]|**set_zone_script**(//zone_name//, //script_name//, //script_trigger//)| |[[set_zone_script|Set Zone Script]]|**set_zone_script**(//zone_name//, //script_name//, //script_trigger//)|
 +|[[shake_screen|Shake Screen]]|**shake_screen**(//duration//)|
 |[[show_credits|Show Credits]]|**show_credits**()| |[[show_credits|Show Credits]]|**show_credits**()|
 |[[show_group|Show Group]]|**show_group**(//group_name//)| |[[show_group|Show Group]]|**show_group**(//group_name//)|
scripting_reference.txt · Last modified: 2024/04/04 20:38 by justin