RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
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
scripting_reference [2024/02/28 10:34] – justinscripting_reference [2024/04/04 20:38] (current) – 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, either STANDARD, ISOMETRIC, or FIRST_PERSON|[[Camera Type]]|+|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 a shorthand for the "party.member" syntax, e.g. **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 38: Line 39:
 |substr(//string//, //start_position//, //*length//)|Returns a substring of a [[string]]. The "length" parameter can be omitted to include all characters from the start position until the end of the [[string]].| |substr(//string//, //start_position//, //*length//)|Returns a substring of a [[string]]. The "length" parameter can be omitted to include all characters from the start position until the end of the [[string]].|
 |range(//min//, //*max//, //*step//)|Returns an array of integers based on the supplied parameters. See "Range" section of [[Script Syntax]] for examples.| |range(//min//, //*max//, //*step//)|Returns an array of integers based on the supplied parameters. See "Range" section of [[Script Syntax]] for examples.|
-|inverse(//value//)|Returns the inverse of the specified value. Supported data types are [[number]], [[boolean]], [[coordinate]], [[color]], [[cardinal direction]], and [[navigation_and_interaction|navigation type]]. See "Inverse" section of [[Script Syntax]] for examples.|+|inverse(//value//)|Returns the inverse of the specified value. Supported data types are [[number]], [[boolean]], [[array]], [[coordinate]], [[color]], [[cardinal direction]], and [[navigation_and_interaction|navigation type]]. See "Inverse" section of [[Script Syntax]] for examples.|
 |duplicate(//value//)|Duplicates an [[array]] or [[codex]] to create a unique copy of the data.| |duplicate(//value//)|Duplicates an [[array]] or [[codex]] to create a unique copy of the data.|
 |clamp(//value//, //min//, //max//)|Returns a numeric value clamped to the specified range. The result will be no less than the minimum value and no more than the maximum value.| |clamp(//value//, //min//, //max//)|Returns a numeric value clamped to the specified range. The result will be no less than the minimum value and no more than the maximum value.|
Line 83: 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 92: 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 107: Line 110:
 |[[get_noise_2d|Get Noise 2D]]|**get_noise_2d**(//x//, //y//)| |[[get_noise_2d|Get Noise 2D]]|**get_noise_2d**(//x//, //y//)|
 |[[get_noise_3d|Get Noise 3D]]|**get_noise_3d**(//x//, //y//, //z//)| |[[get_noise_3d|Get Noise 3D]]|**get_noise_3d**(//x//, //y//, //z//)|
 +|[[give_currency|Give Currency]]|**give_currency**(//amount//, //*stat_id//, //*character//)|
 |[[give_item|Give Item]]|**give_item**(//item_id//, //*count//, //*character//)| |[[give_item|Give Item]]|**give_item**(//item_id//, //*count//, //*character//)|
 |[[give_loot|Give Loot]]|**give_loot**(//loot_name//, //*count//, //*character//)| |[[give_loot|Give Loot]]|**give_loot**(//loot_name//, //*count//, //*character//)|
Line 145: Line 149:
 |[[put_entity|Put Entity]]|**put_entity**(//entity//, //target_tile//)| |[[put_entity|Put Entity]]|**put_entity**(//entity//, //target_tile//)|
 |[[put_player|Put Player]]|**put_player**(//target_tile//, //*direction//)| |[[put_player|Put Player]]|**put_player**(//target_tile//, //*direction//)|
 +|[[remove_currency|Remove Currency]]|**remove_currency**(//amount//, //*stat_id//, //*character//)|
 |[[remove_entity|Remove Entity]]|**remove_entity**(//entity//)| |[[remove_entity|Remove Entity]]|**remove_entity**(//entity//)|
 |[[remove_from_group|Remove From Group]]|**remove_from_group**(//entity//, //group_name//)| |[[remove_from_group|Remove From Group]]|**remove_from_group**(//entity//, //group_name//)|
Line 208: Line 213:
 |[[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.1709145296.txt.gz · Last modified: 2024/02/28 10:34 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki