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
Next revisionBoth sides next revision
scripting_reference [2020/05/15 09:31] – justinscripting_reference [2021/06/19 12:59] – justin
Line 4: Line 4:
 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. 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.
 ^Name^Signature^ ^Name^Signature^
-|[[add_character|Add Character]]|**add_character**(//model_name//, //tile//, //entity_id//)| +|[[add_character|Add Character]]|**add_character**(//model_name//, //tile//, //*entity_id//)| 
-|[[add_item_to_container|Add Item To Container]]|**add_item_to_container**(//entity//, //item_id//, //count//)| +|[[add_item_to_container|Add Item To Container]]|**add_item_to_container**(//entity//, //item_id//, //*count//)| 
-|[[add_object|Add Object]]|**add_object**(//model_name//, //tile//, //entity_id//)|+|[[add_object|Add Object]]|**add_object**(//model_name//, //tile//, //*entity_id//)|
 |[[add_party_member|Add Party Member]]|**add_party_member**(//model_name//, //member_id//)| |[[add_party_member|Add Party Member]]|**add_party_member**(//model_name//, //member_id//)|
-|[[add_tile|Add Tile]]|**add_tile**(//model_name//, //coordinate//, //entity_id//)|+|[[add_tile|Add Tile]]|**add_tile**(//model_name//, //coordinate//, //*entity_id//)|
 |[[add_to_group|Add To Group]]|**add_to_group**(//entity//, //group_name//)| |[[add_to_group|Add To Group]]|**add_to_group**(//entity//, //group_name//)|
 +|[[add_waypoint|Add Waypoint]]|**add_waypoint**(//tile//, //waypoint_name//, //waypoint_coordinate//)|
 |[[assign_entity_id|Assign Entity ID]]|**assign_entity_id**(//entity//, //entity_id//)| |[[assign_entity_id|Assign Entity ID]]|**assign_entity_id**(//entity//, //entity_id//)|
 +|[[attach_object|Attach Object]]|**attach_object**(//model_name//, //target_entity//, //attach_id//, //*target_attach_id//)|
 +|[[create_platform|Create Platform]]|**create_platform**(//tile//, //speed//)|
 |[[damage_entity|Damage Entity]]|**damage_entity**(//entity//, //damage_amount//)| |[[damage_entity|Damage Entity]]|**damage_entity**(//entity//, //damage_amount//)|
 +|[[detach_object|Detach Object]]|**detach_object**(//entity//, //attach_point_id//)|
 |[[disable_container|Disable Container]]|**disable_container**(//entity_id//)| |[[disable_container|Disable Container]]|**disable_container**(//entity_id//)|
 |[[display_message|Display Message]]|**display_message**(//message_text//)| |[[display_message|Display Message]]|**display_message**(//message_text//)|
 |[[enable_container|Enable Container]]|**enable_container**(//entity_id//)| |[[enable_container|Enable Container]]|**enable_container**(//entity_id//)|
 |[[end_battle|End Battle]]|**end_battle**(//victory//)| |[[end_battle|End Battle]]|**end_battle**(//victory//)|
-|[[execute_script|Execute Script]]|**execute_script**(//script_name//)|+|[[equip_item|Equip Item]]|**equip_item**(//character//, //slot_id//, //item_id//, //*count//)| 
 +|[[execute_script|Execute Script]]|**execute_script**(//script_name//, //*pause//)|
 |[[fade_in|Fade In]]|**fade_in**(//duration//)| |[[fade_in|Fade In]]|**fade_in**(//duration//)|
 |[[fade_out|Fade Out]]|**fade_out**(//duration//)| |[[fade_out|Fade Out]]|**fade_out**(//duration//)|
-|[[give_item|Give Item]]|**give_item**(//item_id//, //count//)|+|[[give_item|Give Item]]|**give_item**(//item_id//, //*count//, //*character//)|
 |[[heal_entity|Heal Entity]]|**heal_entity**(//entity//, //heal_amount//)| |[[heal_entity|Heal Entity]]|**heal_entity**(//entity//, //heal_amount//)|
 |[[hide_group|Hide Group]]|**hide_group**(//group_name//)| |[[hide_group|Hide Group]]|**hide_group**(//group_name//)|
 |[[hide_inventory|Hide Inventory]]|**hide_inventory**()| |[[hide_inventory|Hide Inventory]]|**hide_inventory**()|
 |[[hide_toolbar|Hide Toolbar]]|**hide_toolbar**()| |[[hide_toolbar|Hide Toolbar]]|**hide_toolbar**()|
-|[[load_map|Load Map]]|**load_map**(//map_name//, //player_coord//, //player_direction//)|+|[[hide_widget|Hide Widget]]|**hide_widget**(widget_id)| 
 +|[[load_map|Load Map]]|**load_map**(//map_name//, //player_coord//, //*player_direction//)|
 |[[lock_camera|Lock Camera]]|**lock_camera**()| |[[lock_camera|Lock Camera]]|**lock_camera**()|
 |[[set_player_interaction_locked|Lock/Unlock Player Interaction]]|**set_player_interaction_locked**(//is_locked//)| |[[set_player_interaction_locked|Lock/Unlock Player Interaction]]|**set_player_interaction_locked**(//is_locked//)|
Line 32: Line 38:
 |[[look_at_target_over_time|Look At Target Over Time]]|**look_at_target_over_time**(//target//, //duration//)| |[[look_at_target_over_time|Look At Target Over Time]]|**look_at_target_over_time**(//target//, //duration//)|
 |[[modify_navigation|Modify Navigation]]|**modify_navigation**(//first_tile_id//, //second_tile_id//, //navigation_type//)| |[[modify_navigation|Modify Navigation]]|**modify_navigation**(//first_tile_id//, //second_tile_id//, //navigation_type//)|
-|[[move_camera|Move Camera]]|**move_camera**(//destination//, //look_at_target//)| +|[[move_camera|Move Camera]]|**move_camera**(//destination//, //*look_at_target//)| 
-|[[move_camera_at_speed|Move Camera At Speed]]|**move_camera_at_speed**(//destination//, //speed//, //look_at_target//)| +|[[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_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//)|
 |[[move_player|Move Player]]|**move_player**(//tile//)| |[[move_player|Move Player]]|**move_player**(//tile//)|
-|[[move_platform|Move Platform]]|**move_platform**(//tile//, //waypoint_name//, //pause//)|+|[[move_platform|Move Platform]]|**move_platform**(//tile//, //waypoint_name//, //*pause//)|
 |[[override_animation|Override Animation]]|**override_animation**(//entity//, //anim_to_override//, //override_with//)| |[[override_animation|Override Animation]]|**override_animation**(//entity//, //anim_to_override//, //override_with//)|
 |[[play_animation|Play Animation]]|**play_animation**(//entity//, //animation_name//)| |[[play_animation|Play Animation]]|**play_animation**(//entity//, //animation_name//)|
Line 45: Line 51:
 |[[print|Print]]|**print**(//data//)| |[[print|Print]]|**print**(//data//)|
 |[[put_entity|Put Entity]]|**put_entity**(//entity//, //tile_id//)| |[[put_entity|Put Entity]]|**put_entity**(//entity//, //tile_id//)|
-|[[put_player|Put Player]]|**put_player**(//tile_id//, //direction//)|+|[[put_player|Put Player]]|**put_player**(//tile_id//, //*direction//)|
 |[[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//)|
-|[[remove_item|Remove Item]]|**remove_item**(//item_id//, //count//)|+|[[remove_item|Remove Item]]|**remove_item**(//item_id//, //*count//, //*character//)| 
 +|[[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_party_member|Remove Party Member]]|**remove_party_member**(//member_id//)|
 |[[replace_navigation|Replace Navigation]]|**replace_navigation**(//entity//, //navigation_type//, //new_navigation_type//)| |[[replace_navigation|Replace Navigation]]|**replace_navigation**(//entity//, //navigation_type//, //new_navigation_type//)|
Line 54: Line 61:
 |[[reset_camera_at_speed|Reset Camera At Speed]]|**reset_camera_at_speed**(//speed//)| |[[reset_camera_at_speed|Reset Camera At Speed]]|**reset_camera_at_speed**(//speed//)|
 |[[reset_camera_over_time|Reset Camera Over Time]]|**reset_camera_over_time**(//duration//)| |[[reset_camera_over_time|Reset Camera Over Time]]|**reset_camera_over_time**(//duration//)|
-|[[reset_entity_rotation|Reset Entity Rotation]]|**reset_entity_rotation**(//entity//, //duration//)|+|[[reset_entity_rotation|Reset Entity Rotation]]|**reset_entity_rotation**(//entity//, //*duration//)| 
 +|[[reset_map|Reset Map]]|**reset_map**(//map_name//)|
 |[[restart_game|Restart Game]]|**restart_game**()| |[[restart_game|Restart Game]]|**restart_game**()|
 |[[restore_party_member|Restore Party Member]]|**restore_party_member**(//member_id//)| |[[restore_party_member|Restore Party Member]]|**restore_party_member**(//member_id//)|
Line 60: Line 68:
 |[[rotate_camera|Rotate Camera]]|**rotate_camera**(//horizontal_angle//, //vertical_angle//)| |[[rotate_camera|Rotate Camera]]|**rotate_camera**(//horizontal_angle//, //vertical_angle//)|
 |[[rotate_camera_over_time|Rotate Camera Over Time]]|**rotate_camera_over_time**(//horizontal_angle//, //vertical_angle//, //duration//)| |[[rotate_camera_over_time|Rotate Camera Over Time]]|**rotate_camera_over_time**(//horizontal_angle//, //vertical_angle//, //duration//)|
-|[[rotate_entity_towards|Rotate Entity Towards]]|**rotate_entity_towards**(//entity//, //target_entity//, //also_rotate_target//, //duration//)|+|[[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//)| |[[rotate_player_to_direction|Rotate Player To Direction]]|**rotate_player_to_direction**(//direction//)|
-|[[set_ambient_light_color|Set Ambient Light Color]]|**set_ambient_light_color**(//color//, //duration//)|+|[[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_enabled|Set Ambient Light Enabled]]|**set_ambient_light_enabled**(//enabled//)|
 |[[set_animation_speed|Set Animation Speed]]|**set_animation_speed**(//entity//, //animation_name//, //speed//)| |[[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_character_name|Set Character Name]]|**set_character_name**(//entity_id//, //name//)|
 |[[set_dialogue|Set Dialogue]]|**set_dialogue**(//entity_id//, //dialogue_name//)| |[[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_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_enabled|Set Directional Light Enabled]]|**set_directional_light_enabled**(//enabled//)|
 |[[set_entity_blocks_sight|Set Entity Blocks Sight]]|**set_entity_blocks_sight**(//entity//, //blocks_sight//)| |[[set_entity_blocks_sight|Set Entity Blocks Sight]]|**set_entity_blocks_sight**(//entity//, //blocks_sight//)|
-|[[set_entity_light_attenuation|Set Entity Light Attenuation]]|**set_entity_light_attenuation**(//entity//, //attenuation//, //duration//)| +|[[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//)| +|[[set_entity_light_color|Set Entity Light Color]]|**set_entity_light_color**(//entity//, //color//, //*duration//)| 
-|[[set_entity_light_diameter|Set Entity Light Diameter]]|**set_entity_light_diameter**(//entity//, //diameter//, //duration//)|+|[[set_entity_light_diameter|Set Entity Light Diameter]]|**set_entity_light_diameter**(//entity//, //diameter//, //*duration//)|
 |[[set_entity_light_enabled|Set Entity Light Enabled]]|**set_entity_light_enabled**(//entity//, //enabled//)| |[[set_entity_light_enabled|Set Entity Light Enabled]]|**set_entity_light_enabled**(//entity//, //enabled//)|
-|[[set_entity_light_intensity|Set Entity Light Intensity]]|**set_entity_light_intensity**(//entity//, //intensity//, //duration//)|+|[[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_model|Set Entity Model]]|**set_entity_model**(//entity//, //model_name//)|
 |[[set_entity_property|Set Entity Property]]|**set_entity_property**(//entity//, //property_name//, //property_value//)| |[[set_entity_property|Set Entity Property]]|**set_entity_property**(//entity//, //property_name//, //property_value//)|
-|[[set_entity_script|Set Entity Script]]|**set_entity_script**(//entity//, //script_name//)|+|[[set_entity_script|Set Entity Script]]|**set_entity_script**(//entity//, //script_name//, //*script_trigger//, //*triggerable_by_npc//)|
 |[[set_entity_tooltip|Set Entity Tooltip]]|**set_entity_tooltip**(//entity//, //tooltip_text//)| |[[set_entity_tooltip|Set Entity Tooltip]]|**set_entity_tooltip**(//entity//, //tooltip_text//)|
 |[[set_global_property|Set Global Property]]|**set_global_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//)|+|[[set_group_light_color|Set Group Light Color]]|**set_group_light_color**(//group_name//, //color//, //*duration//)|
 |[[set_group_light_enabled|Set Group Light Enabled]]|**set_group_light_enabled**(//group_name//, //enabled//)| |[[set_group_light_enabled|Set Group Light Enabled]]|**set_group_light_enabled**(//group_name//, //enabled//)|
 |[[set_language|Set Language]]|**set_language**(//locale_code//)| |[[set_language|Set Language]]|**set_language**(//locale_code//)|
Line 89: Line 97:
 |[[show_inventory|Show Inventory]]|**show_inventory**()| |[[show_inventory|Show Inventory]]|**show_inventory**()|
 |[[show_toolbar|Show Toolbar]]|**show_toolbar**()| |[[show_toolbar|Show Toolbar]]|**show_toolbar**()|
 +|[[show_widget|Show Widget]]|**show_widget**(widget_id)|
 |[[start_battle|Start Battle]]|**start_battle**(//battle_name//)| |[[start_battle|Start Battle]]|**start_battle**(//battle_name//)|
 |[[start_dialogue|Start Dialogue]]|**start_dialogue**(//dialogue_name//)| |[[start_dialogue|Start Dialogue]]|**start_dialogue**(//dialogue_name//)|
 |[[stop_player|Stop Player]]|**stop_player**()| |[[stop_player|Stop Player]]|**stop_player**()|
 +|[[unequip_item|Unequip Item]]|**unequip_item**(//character//, //slot_id//, //*count//)|
 |[[wait|Wait]]|**wait**(//duration//)| |[[wait|Wait]]|**wait**(//duration//)|
  
scripting_reference.txt · Last modified: 2024/06/26 18:57 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki