User Tools

Site Tools


scripting_reference

This is an old revision of the document!


Scripting Reference


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.

Parameters marked with an asterisk (*) are optional. If an optional parameter is passed to a function, any preceding optional parameters must also be included.

NameSignature
Add Characteradd_character(model_name, tile, *entity_id)
Add Item To Containeradd_item_to_container(entity, item_id, *count)
Add Objectadd_object(model_name, tile, *entity_id)
Add Party Memberadd_party_member(model_name, member_id)
Add Tileadd_tile(model_name, coordinate, *entity_id)
Add To Groupadd_to_group(entity, group_name)
Add Waypointadd_waypoint(tile, waypoint_name, waypoint_coordinate)
Apply Lighting Presetapply_lighting_preset(preset_name, *duration)
Assign Entity IDassign_entity_id(entity, entity_id)
Attach Objectattach_object(model_name, target_entity, attach_id, *target_attach_id)
Create Platformcreate_platform(tile, speed)
Damage Entitydamage_entity(entity, damage_amount)
Detach Objectdetach_object(entity, attach_point_id)
Disable Containerdisable_container(entity_id)
Display Choicesdisplay_choices(message_text, choices, *speaker)
Display Messagedisplay_message(message_text, *speaker)
Enable Containerenable_container(entity_id)
End Battleend_battle(victory)
Equip Itemequip_item(character, slot_id, item_id, *count)
Execute Scriptexecute_script(script_name, *pause)
Fade Infade_in(duration)
Fade Outfade_out(duration)
Give Itemgive_item(item_id, *count, *character)
Heal Entityheal_entity(entity, heal_amount)
Hide Grouphide_group(group_name)
Hide Inventoryhide_inventory()
Hide Toolbarhide_toolbar()
Hide Widgethide_widget(widget_id)
Load Mapload_map(map_name, player_coord, *player_direction)
Lock Cameralock_camera()
Lock/Unlock Player Interactionset_player_interaction_locked(is_locked)
Lock/Unlock Player Movementset_player_movement_locked(is_locked)
Log Messagelog_message(message)
Look At Targetlook_at_target(target)
Look At Target Over Timelook_at_target_over_time(target, duration)
Modify Navigationmodify_navigation(first_tile_id, second_tile_id, navigation_type)
Move Cameramove_camera(destination, *look_at_target)
Move Camera At Speedmove_camera_at_speed(destination, speed, *look_at_target)
Move Camera Over Timemove_camera_over_time(destination, duration, *look_at_target)
Move Charactermove_character(character, tile)
Move Playermove_player(tile)
Move Platformmove_platform(tile, waypoint_name, *pause)
Override Animationoverride_animation(entity, anim_to_override, override_with)
Play Animationplay_animation(entity, animation_name)
Play Group Animationplay_group_animation(group_name, animation_name)
Play Musicplay_music(music_name)
Play Soundplay_sound(sound_name)
Printprint(data)
Put Entityput_entity(entity, target_tile)
Put Playerput_player(target_tile, *direction)
Remove Entityremove_entity(entity)
Remove From Groupremove_from_group(entity, group_name)
Remove Itemremove_item(item_id, *count, *character)
Remove Item From Containerremove_item_from_container(entity, item_id, *count)
Remove Party Memberremove_party_member(member_id)
Replace Navigationreplace_navigation(entity, navigation_type, new_navigation_type)
Reset Camerareset_camera()
Reset Camera At Speedreset_camera_at_speed(speed)
Reset Camera Over Timereset_camera_over_time(duration)
Reset Entity Rotationreset_entity_rotation(entity, *duration)
Reset Mapreset_map(map_name)
Restart Gamerestart_game()
Restore Party Memberrestore_party_member(member_id)
Revive Characterrevive_character(character, heal_amount)
Rotate Camerarotate_camera(horizontal_angle, vertical_angle)
Rotate Camera Over Timerotate_camera_over_time(horizontal_angle, vertical_angle, duration)
Rotate Entity Towardsrotate_entity_towards(entity, target_entity, also_rotate_target, *duration)
Rotate Player To Directionrotate_player_to_direction(direction)
Set Ambient Light Colorset_ambient_light_color(color, *duration)
Set Ambient Light Enabledset_ambient_light_enabled(enabled)
Set Ambient Light Intensityset_ambient_light_intensity(intensity, *duration)
Set Animation Speedset_animation_speed(entity, animation_name, speed)
Set Character Nameset_character_name(entity_id, name)
Set Dialogueset_dialogue(entity_id, dialogue_name)
Set Directional Light Colorset_directional_light_color(color, *duration)
Set Directional Light Enabledset_directional_light_enabled(enabled)
Set Directional Light Intensityset_directional_light_intensity(intensity, *duration)
Set Entity Blocks Sightset_entity_blocks_sight(entity, blocks_sight)
Set Entity Light Attenuationset_entity_light_attenuation(entity, attenuation, *duration)
Set Entity Light Colorset_entity_light_color(entity, color, *duration)
Set Entity Light Diameterset_entity_light_diameter(entity, diameter, *duration)
Set Entity Light Enabledset_entity_light_enabled(entity, enabled)
Set Entity Light Intensityset_entity_light_intensity(entity, intensity, *duration)
Set Entity Modelset_entity_model(entity, model_name)
Set Entity Propertyset_entity_property(entity, property_name, property_value)
Set Entity Scriptset_entity_script(entity, script_name, *script_trigger, *triggerable_by_npc)
Set Entity Tooltipset_entity_tooltip(entity, tooltip_text)
Set Global Propertyset_global_property(property_name, property_value)
Set Group Light Colorset_group_light_color(group_name, color, *duration)
Set Group Light Enabledset_group_light_enabled(group_name, enabled)
Set Languageset_language(locale_code)
Set Movement Speedset_movement_speed(character, speed)
Set Vision Heightset_vision_height(character, height)
Show Creditsshow_credits()
Show Groupshow_group(group_name)
Show Inventoryshow_inventory()
Show Toolbarshow_toolbar()
Show Widgetshow_widget(widget_id)
Start Battlestart_battle(battle_name)
Start Dialoguestart_dialogue(dialogue_name)
Stop Playerstop_player()
Unequip Itemunequip_item(character, slot_id, *count)
Waitwait(duration)
scripting_reference.1636077424.txt.gz · Last modified: 2021/11/04 18:57 by justin