Differences

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

--- scripting_reference [2021/06/19 12:59] – justin
+++ scripting_reference [2024/03/04 21:18] – justin
@@ Line 1: / Line 1: @@
 ======Scripting Reference======
 ----
-=====Action Functions=====
+=====Global Variables=====
-Action functions are used to trigger certain actions or events in your game, such as loading a map, playing an animation, or healing a character. These functions allow you to control the flow of your game and help give life to its world! Click on a function name for more details around its usage.
+^Variable^Description^Data Type^
+|global.theme|Current UI [[theme_editor|theme]]. Can be used to retrieve or modify the [[theme_editor|theme]].|[[String]]|
+|global.gameplay|Gameplay settings. Can be used to retrieve the gameplay settings as defined in your [[Game Configuration]].|[[Codex]]|
+|global.time|Current game time (value will be between 0 and the configured day/night duration in seconds).|[[Number]]|
+|global.gravity|Current gravity used by free movement maps. Can be used to retrieve or modify the gravity.|[[Number]]|
+|global.random_seed|Seed value for random number generation (must be an integer).|[[Number]]|
+|global.noise_seed|Seed value for [[Get Noise 2D]] and [[Get Noise 3D]] scripting functions (must be an integer).|[[Number]]|
+=====Map Variables=====
+^Variable^Description^Data Type^
+|map.name|Name of the current [[map]].|[[String]]|
+|map.groups|List of [[groups]] defined for the current [[map]].|[[Array]]|
+=====Camera Variables=====
+^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.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=====
+^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|[[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=====
+^Variable^Description^Data Type^
+|system.time|Current system time as a [[codex]] containing key/value pairs for "hour", "minute", and "second".|[[Codex]]|
+=====Utility Functions=====
+Parameters marked with an asterisk (*) are optional. If an optional parameter is passed to a function, any preceding optional parameters must also be included.
+^Signature^Description^
+|random(//min//, //max//)|Returns a random number between the specified minimum and maximum value (inclusive). Both values should be integers. Random numbers can also be generated using D&D dice notation, e.g. 2d6 will roll two six-sided dice and add the resulting numbers together.|
+|str(//value//)|Converts the given value to a [[string]].|
+|num(//value//)|Converts the given value to a [[number]].|
+|len(//value//)|Returns the number of characters in a [[string]], the number of elements in an [[array]], or the number of keys in a [[codex]].|
+|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.|
+|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.|
+|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.|
+|round(//x//)|Rounds x to the nearest whole number.|
+|mod(//x//, //y//)|Gives the remainder of x divided by y.|
+|pow(//x//, //y//)|Gives the result of x raised to the power of y.|
+|sqrt(//x//)|Gives the square root of x.|
+|abs(//x//)|Gives the absolute value of x.|
+|floor(//x//)|Rounds x downwards to the nearest whole number.|
+|ceil(//x//)|Rounds x upwards to the nearest whole number.|
+=====Event Functions=====
+Event functions are used to trigger certain actions or events in your game, such as loading a map, playing an animation, or healing a character. These functions allow you to control the flow of your game and help give life to its world! Click on a function name for more details around its usage.
+Parameters marked with an asterisk (*) are optional. If an optional parameter is passed to a function, any preceding optional parameters must also be included.
 ^Name^Signature^
 |[[add_character|Add Character]]|**add_character**(//model_name//, //tile//, //*entity_id//)|
+|[[add_effect|Add Effect]]|**add_effect**(//effect_name//, //coordinate//, //*entity_id//)|
 |[[add_item_to_container|Add Item To Container]]|**add_item_to_container**(//entity//, //item_id//, //*count//)|
+|[[add_item_to_tile|Add Item To Tile]]|**add_item_to_tile**(//tile//, //item_id//, //*count//)|
 |[[add_object|Add Object]]|**add_object**(//model_name//, //tile//, //*entity_id//)|
 |[[add_party_member|Add Party Member]]|**add_party_member**(//model_name//, //member_id//)|
@@ Line 11: / Line 65: @@
 |[[add_to_group|Add To Group]]|**add_to_group**(//entity//, //group_name//)|
 |[[add_waypoint|Add Waypoint]]|**add_waypoint**(//tile//, //waypoint_name//, //waypoint_coordinate//)|
+|[[add_zone|Add Zone]]|**add_zone**(//zone_name//, //passable//, //position//, //size_x//, //size_y//, //size_z//)|
+|[[apply_camera_preset|Apply Camera Preset]]|**apply_camera_preset**(//preset_name//)|
+|[[apply_lighting_preset|Apply Lighting Preset]]|**apply_lighting_preset**(//preset_name//, //*duration//)|
+|[[apply_status_effect|Apply Status Effect]]|**apply_status_effect**(//status_effect_id//, //character//, //*duration//)|
 |[[assign_entity_id|Assign Entity ID]]|**assign_entity_id**(//entity//, //entity_id//)|
+|[[attach_effect|Attach Effect]]|**attach_effect**(//effect_name//, //target_entity//, //attach_id//)|
 |[[attach_object|Attach Object]]|**attach_object**(//model_name//, //target_entity//, //attach_id//, //*target_attach_id//)|
+|[[change_camera|Change Camera]]|**change_camera**(//camera_type//)|
+|[[change_player|Change Player]]|**change_player**(//character//)|
+|[[clear_log|Clear Log]]|**clear_log**()|
+|[[clear_status_effects|Clear Status Effects]]|**clear_status_effects**(//character//)|
+|[[complete_quest|Complete Quest]]|**complete_quest**(//quest_id//)|
 |[[create_platform|Create Platform]]|**create_platform**(//tile//, //speed//)|
 |[[damage_entity|Damage Entity]]|**damage_entity**(//entity//, //damage_amount//)|
-|[[detach_object|Detach Object]]|**detach_object**(//entity//, //attach_point_id//)|
+|[[decrease_stat|Decrease Stat]]|**decrease_stat**(//stat_id//, //amount//, //*character//)|
+|[[delete_data|Delete Data]]|**delete_data**(//filename//)|
+|[[delete_save|Delete Save]]|**delete_save**(//*filename//)|
+|[[detach_effect|Detach Effect]]|**detach_effect**(//entity//, //attach_id//)|
+|[[detach_object|Detach Object]]|**detach_object**(//entity//, //attach_id//)|
 |[[disable_container|Disable Container]]|**disable_container**(//entity_id//)|
-|[[display_message|Display Message]]|**display_message**(//message_text//)|
+|[[disable_conveyor|Disable Conveyor]]|**disable_conveyor**(//conveyor_group//)|
+|[[disable_effect|Disable Effect]]|**disable_effect**(//entity//)|
+|[[disable_screen_effect|Disable Screen Effect]]|**disable_screen_effect**(//*duration//)|
+|[[disable_turret|Disable Turret]]|**disable_turret**(//entity//)|
+|[[disable_zone|Disable Zone]]|**disable_zone**(//zone_name//)|
+|[[display_choices|Display Choices]]|**display_choices**(//message_text//, //choices//, //*speaker//)|
+|[[display_image|Display Image]]|**display_image**(//image_name//, //*duration//, //*bg_color//, //*stretch_mode//)|
+|[[display_message|Display Message]]|**display_message**(//message_text//, //*speaker//)|
 |[[enable_container|Enable Container]]|**enable_container**(//entity_id//)|
+|[[enable_conveyor|Enable Conveyor]]|**enable_conveyor**(//conveyor_group//)|
+|[[enable_effect|Enable Effect]]|**enable_effect**(//entity//)|
+|[[enable_screen_effect|Enable Screen Effect]]|**enable_screen_effect**(//*duration//)|
+|[[enable_turret|Enable Turret]]|**enable_turret**(//entity//)|
+|[[enable_zone|Enable Zone]]|**enable_zone**(//zone_name//)|
 |[[end_battle|End Battle]]|**end_battle**(//victory//)|
 |[[equip_item|Equip Item]]|**equip_item**(//character//, //slot_id//, //item_id//, //*count//)|
@@ Line 24: / Line 104: @@
 |[[fade_in|Fade In]]|**fade_in**(//duration//)|
 |[[fade_out|Fade Out]]|**fade_out**(//duration//)|
+|[[fail_quest|Fail Quest]]|**fail_quest**(//quest_id//)|
+|[[fire_projectile|Fire Projectile]]|**fire_projectile**(//item_id//, //source//, //*target//, //*entity_id//)|
+|[[get_noise_2d|Get Noise 2D]]|**get_noise_2d**(//x//, //y//)|
+|[[get_noise_3d|Get Noise 3D]]|**get_noise_3d**(//x//, //y//, //z//)|
 |[[give_item|Give Item]]|**give_item**(//item_id//, //*count//, //*character//)|
+|[[give_loot|Give Loot]]|**give_loot**(//loot_name//, //*count//, //*character//)|
+|[[give_quest|Give Quest]]|**give_quest**(//quest_id//)|
+|[[give_skill|Give Skill]]|**give_skill**(//skill_id//, //*character//)|
 |[[heal_entity|Heal Entity]]|**heal_entity**(//entity//, //heal_amount//)|
 |[[hide_group|Hide Group]]|**hide_group**(//group_name//)|
 |[[hide_inventory|Hide Inventory]]|**hide_inventory**()|
 |[[hide_toolbar|Hide Toolbar]]|**hide_toolbar**()|
-|[[hide_widget|Hide Widget]]|**hide_widget**(widget_id)|
+|[[hide_widget|Hide Widget]]|**hide_widget**(//widget_id//, //*fade_out_length//)|
+|[[increase_stat|Increase Stat]]|**increase_stat**(//stat_id//, //amount//, //*character//)|
+|[[load_data|Load Data]]|**load_data**(//filename//, //*password//)|
+|[[load_game|Load Game]]|**load_game**(//*filename//)|
 |[[load_map|Load Map]]|**load_map**(//map_name//, //player_coord//, //*player_direction//)|
 |[[lock_camera|Lock Camera]]|**lock_camera**()|
@@ Line 41: / Line 131: @@
 |[[move_camera_at_speed|Move Camera At Speed]]|**move_camera_at_speed**(//destination//, //speed//, //*look_at_target//)|
 |[[move_camera_over_time|Move Camera Over Time]]|**move_camera_over_time**(//destination//, //duration//, //*look_at_target//)|
-|[[move_character|Move Character]]|**move_character**(//character//, //tile//)|
+|[[move_character|Move Character]]|**move_character**(//character//, //tile//, //*pause//)|
-|[[move_player|Move Player]]|**move_player**(//tile//)|
 |[[move_platform|Move Platform]]|**move_platform**(//tile//, //waypoint_name//, //*pause//)|
+|[[move_player|Move Player]]|**move_player**(//tile//)|
+|[[open_container|Open Container]]|**open_container**(//entity//)|
+|[[override_action|Override Action]]|**override_action**(//action_id_to_override//, //override_with//)|
 |[[override_animation|Override Animation]]|**override_animation**(//entity//, //anim_to_override//, //override_with//)|
+|[[perform_action|Perform Action]]|**perform_action**(//action_id//, //*pressed//)|
 |[[play_animation|Play Animation]]|**play_animation**(//entity//, //animation_name//)|
 |[[play_group_animation|Play Group Animation]]|**play_group_animation**(//group_name//, //animation_name//)|
-|[[play_music|Play Music]]|**play_music**(//music_name//)|
+|[[play_music|Play Music]]|**play_music**(//music_name//, //*fade_in_length//, //*loop//)|
-|[[play_sound|Play Sound]]|**play_sound**(//sound_name//)|
+|[[play_sound|Play Sound]]|**play_sound**(//sound_name//, //*loop//, //*interval//)|
+|[[play_video|Play Video]]|**play_video**(//video_name//)|
 |[[print|Print]]|**print**(//data//)|
-|[[put_entity|Put Entity]]|**put_entity**(//entity//, //tile_id//)|
+|[[put_entity|Put Entity]]|**put_entity**(//entity//, //target_tile//)|
-|[[put_player|Put Player]]|**put_player**(//tile_id//, //*direction//)|
+|[[put_player|Put Player]]|**put_player**(//target_tile//, //*direction//)|
 |[[remove_entity|Remove Entity]]|**remove_entity**(//entity//)|
 |[[remove_from_group|Remove From Group]]|**remove_from_group**(//entity//, //group_name//)|
@@ Line 57: / Line 151: @@
 |[[remove_item_from_container|Remove Item From Container]]|**remove_item_from_container**(//entity//, //item_id//, //*count//)|
 |[[remove_party_member|Remove Party Member]]|**remove_party_member**(//member_id//)|
+|[[remove_skill|Remove Skill]]|**remove_skill**(//skill_id//, //*character//)|
+|[[remove_status_effect|Remove Status Effect]]|**remove_status_effect**(//status_effect_id//, //character//)|
+|[[remove_zone|Remove Zone]]|**remove_zone**(//zone_name//)|
 |[[replace_navigation|Replace Navigation]]|**replace_navigation**(//entity//, //navigation_type//, //new_navigation_type//)|
+|[[request_coordinate|Request Coordinate]]|**request_coordinate**(//start_z//, //min_z//, //max_z//, //step_z//, //*validation_func//)|
+|[[request_entity|Request Entity]]|**request_entity**(//*validation_func//)|
+|[[reset_action|Reset Action]]|**reset_action**(//action_id//)|
 |[[reset_camera|Reset Camera]]|**reset_camera**()|
 |[[reset_camera_at_speed|Reset Camera At Speed]]|**reset_camera_at_speed**(//speed//)|
@@ Line 70: / Line 170: @@
 |[[rotate_entity_towards|Rotate Entity Towards]]|**rotate_entity_towards**(//entity//, //target_entity//, //also_rotate_target//, //*duration//)|
 |[[rotate_player_to_direction|Rotate Player To Direction]]|**rotate_player_to_direction**(//direction//)|
+|[[save_data|Save Data]]|**save_data**(//data//, //filename//, //*password//)|
+|[[save_game|Save Game]]|**save_game**(//*filename//)|
 |[[set_ambient_light_color|Set Ambient Light Color]]|**set_ambient_light_color**(//color//, //*duration//)|
 |[[set_ambient_light_enabled|Set Ambient Light Enabled]]|**set_ambient_light_enabled**(//enabled//)|
+|[[set_ambient_light_intensity|Set Ambient Light Intensity]]|**set_ambient_light_intensity**(//intensity//, //*duration//)|
 |[[set_animation_speed|Set Animation Speed]]|**set_animation_speed**(//entity//, //animation_name//, //speed//)|
 |[[set_character_name|Set Character Name]]|**set_character_name**(//entity_id//, //name//)|
+|[[set_conveyor_reversed|Set Conveyor Reversed]]|**set_conveyor_reversed**(//conveyor_group//, //is_reversed//, //*reverse_anim_dir//)|
+|[[set_conveyor_speed|Set Conveyor Speed]]|**set_conveyor_speed**(//conveyor_group//, //speed//, //*change_anim_speed//)|
 |[[set_dialogue|Set Dialogue]]|**set_dialogue**(//entity_id//, //dialogue_name//)|
 |[[set_directional_light_color|Set Directional Light Color]]|**set_directional_light_color**(//color//, //*duration//)|
 |[[set_directional_light_enabled|Set Directional Light Enabled]]|**set_directional_light_enabled**(//enabled//)|
+|[[set_directional_light_intensity|Set Directional Light Intensity]]|**set_directional_light_intensity**(//intensity//, //*duration//)|
 |[[set_entity_blocks_sight|Set Entity Blocks Sight]]|**set_entity_blocks_sight**(//entity//, //blocks_sight//)|
+|[[set_entity_direction|Set Entity Direction]]|**set_entity_direction**(//entity//, //direction//)|
 |[[set_entity_light_attenuation|Set Entity Light Attenuation]]|**set_entity_light_attenuation**(//entity//, //attenuation//, //*duration//)|
 |[[set_entity_light_color|Set Entity Light Color]]|**set_entity_light_color**(//entity//, //color//, //*duration//)|
@@ Line 84: / Line 191: @@
 |[[set_entity_light_intensity|Set Entity Light Intensity]]|**set_entity_light_intensity**(//entity//, //intensity//, //*duration//)|
 |[[set_entity_model|Set Entity Model]]|**set_entity_model**(//entity//, //model_name//)|
+|[[set_entity_offset|Set Entity Offset]]|**set_entity_offset**(//entity//, //x//, //y//, //z//, //*duration//)|
 |[[set_entity_property|Set Entity Property]]|**set_entity_property**(//entity//, //property_name//, //property_value//)|
+|[[set_entity_rotation|Set Entity Rotation]]|**set_entity_rotation**(//entity//, //x//, //y//, //z//, //*duration//)|
+|[[set_entity_scale|Set Entity Scale]]|**set_entity_scale**(//entity//, //x_scale//, //y_scale//, //z_scale//, //*duration//)|
 |[[set_entity_script|Set Entity Script]]|**set_entity_script**(//entity//, //script_name//, //*script_trigger//, //*triggerable_by_npc//)|
+|[[set_entity_texture|Set Entity Texture]]|**set_entity_texture**(//entity//, //texture_name//)|
 |[[set_entity_tooltip|Set Entity Tooltip]]|**set_entity_tooltip**(//entity//, //tooltip_text//)|
+|[[set_gameplay_property|Set Gameplay Property]]|**set_gameplay_property**(//property_name//, //property_value//)|
 |[[set_global_property|Set Global Property]]|**set_global_property**(//property_name//, //property_value//)|
 |[[set_group_light_color|Set Group Light Color]]|**set_group_light_color**(//group_name//, //color//, //*duration//)|
@@ Line 92: / Line 204: @@
 |[[set_language|Set Language]]|**set_language**(//locale_code//)|
 |[[set_movement_speed|Set Movement Speed]]|**set_movement_speed**(//character//, //speed//)|
+|[[set_screen_effect_property|Set Screen Effect Property]]|**set_screen_effect_property**(//property_name//, //property_value//, //*duration//)|
+|[[set_stat|Set Stat]]|**set_stat**(//stat_id//, //value//, //*character//)|
+|[[set_terrain_types|Set Terrain Types]]|**set_terrain_types**(//entity//, //terrain_mode//, //*terrain_types//)|
 |[[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//)|
+|[[shake_screen|Shake Screen]]|**shake_screen**(//duration//)|
 |[[show_credits|Show Credits]]|**show_credits**()|
 |[[show_group|Show Group]]|**show_group**(//group_name//)|
 |[[show_inventory|Show Inventory]]|**show_inventory**()|
 |[[show_toolbar|Show Toolbar]]|**show_toolbar**()|
-|[[show_widget|Show Widget]]|**show_widget**(widget_id)|
+|[[show_widget|Show Widget]]|**show_widget**(//widget_id//, //*fade_in_length//)|
 |[[start_battle|Start Battle]]|**start_battle**(//battle_name//)|
 |[[start_dialogue|Start Dialogue]]|**start_dialogue**(//dialogue_name//)|
+|[[stop_animation|Stop Animation]]|**stop_animation**(//entity//)|
+|[[stop_music|Stop Music]]|**stop_music**(//*fade_out_length//)|
 |[[stop_player|Stop Player]]|**stop_player**()|
+|[[stop_sound|Stop Sound]]|**stop_sound**(//sound_id//, //*fade_out_length//)|
 |[[unequip_item|Unequip Item]]|**unequip_item**(//character//, //slot_id//, //*count//)|
+|[[use_item|Use Item]]|**use_item**(//item_id//, //*character//)|
+|[[use_skill|Use Skill]]|**use_skill**(//skill_id//, //*character//)|
 |[[wait|Wait]]|**wait**(//duration//)|
+~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Differences

Page Tools

RPG in a Box
Official Documentation