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 [2021/06/19 12:56] – justinscripting_reference [2021/08/31 19:52] – justin
Line 3: Line 3:
 =====Action Functions===== =====Action Functions=====
 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.
 +
 +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^ ^Name^Signature^
 |[[add_character|Add Character]]|**add_character**(//model_name//, //tile//, //*entity_id//)| |[[add_character|Add Character]]|**add_character**(//model_name//, //tile//, //*entity_id//)|
Line 17: Line 20:
 |[[detach_object|Detach Object]]|**detach_object**(//entity//, //attach_point_id//)| |[[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_choices|Display Choices]]|**display_choices**(//message_text//, //choices//, //*speaker//)| 
 +|[[display_message|Display Message]]|**display_message**(//message_text//, //*speaker//)|
 |[[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//)|
Line 54: Line 58:
 |[[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_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//)|
Line 61: Line 65:
 |[[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//)| |[[reset_map|Reset Map]]|**reset_map**(//map_name//)|
 |[[restart_game|Restart Game]]|**restart_game**()| |[[restart_game|Restart Game]]|**restart_game**()|
Line 68: Line 72:
 |[[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_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_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_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_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 101: Line 107:
 |[[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//)|+|[[unequip_item|Unequip Item]]|**unequip_item**(//character//, //slot_id//, //*count//)|
 |[[wait|Wait]]|**wait**(//duration//)| |[[wait|Wait]]|**wait**(//duration//)|
  
scripting_reference.txt · Last modified: 2024/04/04 20:38 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki