(Official) LUA Scripting Documentation
Pages
Functions to manipulate getters
get_action_count*
Get the number of actions the context actor has performed.
get_actor_name*
Get the name of the context actor.
get_block_info*
Get various world data of a block.
get_block_light*
Get the amount of block emitted light at a map point.
get_clan_name*
Get the clan name of the context actor.
get_cursor_point*
Get the world point of the players block cursor.
get_eye_pos*
Get the current world eye position of the context actor (camera position).
get_gamer_count*
Get the total number of valid gamers in the session.
get_gamer_count_in_radius*
Get the total number of enabled gamers currently positioned inside a spherical region.
get_gamer_count_in_region*
Get the total number of enabled gamers currently positioned inside a cubic region.
get_gamer_count_in_zone*
Get the total number of enabled gamers currently positioned inside a zone.
get_hash_code*
Get the hash code of a string.
get_health*
Get the current health of the context actor.
get_health_as_percent*
Get the current health of the context actor as a percentage (0-100%) of it’s maximum health.
get_hour*
Get the current game hour from the 24 hour day clock.
get_item*
Get an equipped or event raising item.
get_light*
Get full light data of a map point.
get_max_health*
Get the maximum health of the context actor.
get_max_oxygen*
Get the maximum oxygen of the context actor.
get_max_stamina*
Get the maximum stamina of the context actor.
get_npc_count*
Get the total number of NPCs in the world.
get_npc_count_in_radius*
Get the total number of NPCs currently positioned inside a spherical region.
get_npc_count_in_region*
Get the total number of NPCs currently positioned inside a cubic region.
get_npc_count_in_zone*
Get the total number of NPCs currently positioned inside a zone.
get_oxygen*
Get the current oxygen of the context actor.
get_oxygen_as_percent*
Get the current oxygen of the context actor as a percentage (0-100%) of it’s maximum oxygen.
get_permission*
Query if the context player has a particular permission.
get_point*
Get the current world point of the context actor.
get_pos*
Get the current world position of the context actor.
get_random_pos*
Get a random position within a circle.
get_random*
Get a random number.
get_reach*
Get the reach of the context actor.
get_script_offset*
Get the map point offset of the script block that executed the current script.
get_script_point*
Get the map point of the script block that executed the current script.
get_skill_level*
Get the current level of a specified skill of the context actor.
get_skill_xp*
Get the current xp of a specified skill of the context actor.
get_stamina*
Get the current stamina of the context actor.
get_stamina_as_percent*
Get the current stamina of the context actor as a percentage (0-100%) of it’s maximum stamina.
get_stat_bonus*
Get the stat bonus for a skill.
get_sun_light*
Get the amount of sunlight at a world point.
get_texture*
Get the currently assigned texture id for a block.
get_velocity*
Get the current world velocity of the context actor.
get_view_dir*
Get the current view direction of the context actor.
get_viewport_width*
Get the viewport width (in pixels).
get_viewport_height*
Get the viewport height (in pixels).