Object

Object variables refer to objects that are currently present on the map. Objects that have not spawned do not count.

There are sixteen global object variables, numbered from 0 to 15, which can be accessed as global.object[n].

This type contains nested variables. There are 8 nested numbers, 4 nested objects, 4 nested players, 2 nested teams, and 4 nested timers available. Note that only 256 objects on the map can have variables at a time; if you try to set variables on objects past that limit, Megalo may fail to set variables on the new objects, or it may clear variables off of the old objects.

Properties

spawn_sequence: The object's Spawn Sequence value set in Forge.
team: The object's owner team.

Accessors

health: The object's current health.
max_health: The object's maximum health.
max_shields: The object's maximum shields.
shields: The object's current shields.

Member conditions

has_forge_label: Check whether this object has a given Forge label.
is_in_use: Check whether this object is an Armor Ability currently being used by a player.
is_of_type: Check whether this object is of a given type.
is_out_of_bounds: Check whether this object is out of bounds.
shape_contains: Check whether this object's shape boundary contains another object.

Member actions

add_weapon: Give a weapon to a biped, even if it isn't player-controlled.
animate_device_position: Animate a device machine's position over time.
apply_shape_color_from_player_member: Recolor an object's shape boundary based on a player variable.
attach_to: Attaches this object to another one.
copy_rotation_from: Rotate one object to match another.
delete: Delete this object from the game world.
detach: Detaches this object from anything it is attached to.
enable_spawn_zone: Sets whether a Respawn Zone is enabled and able to affect spawning.
face_toward: Rotate one object to face another.
get_carrier a.k.a. try_get_carrier: Identify the player carrying a weapon or Armor Ability.
get_device_position: Gets the current position level of a device machine.
get_device_power: Gets the current power level of a device machine.
get_distance_to: Returns the distance between this object and another.
get_orientation: Returns a number representing the object's overall rotation.
get_speed: Returns the object's speed in feet per second.
kill: Kill an object.
place_at_me a.k.a. create_object: Spawn a new object at this object.
place_between_me_and: Spawn a new object between this object and another.
push_upward a.k.a. apply_upward_impulse: Apply a random mostly-upward force to the object.
remove_weapon: Remove a weapon from a biped.
set_device_actual_position: No description available.
set_device_animation_position: Sets the current animation and position of a device machine.
set_device_position: Sets the current position level of a device machine.
set_device_power: Sets the current power level of a device machine.
set_garbage_collection_disabled: Disables garbage collection for objects.
set_hidden: MCC-exclusive: Make an object invisible.
set_invincibility: Make an object invincible.
set_pickup_permissions: Adjust which players can pick up a weapon.
set_progress_bar: Set whether an object displays a progress bar to certain players when they're inside of the object's shape volume, and sets which players are eligible to see it.
set_scale: Resize an object.
set_shape a.k.a. set_boundary: Change an object's shape boundary.
set_shape_visibility: Adjust which players can see an object's shape boundary.
set_spawn_location_fireteams a.k.a. set_fireteam_respawn_filter: Adjust which fireteam can spawn at a location.
set_spawn_location_permissions a.k.a. set_respawn_filter: Adjust which players can spawn at a location.
set_waypoint_icon: Change the icon that this waypoint displays.
set_waypoint_priority: Change the waypoint's visual priority.
set_waypoint_range: Change the distances at which waypoints are visible.
set_waypoint_text: Set the text of an object's waypoint.
set_waypoint_timer: Change the timer that a waypoint displays.
set_waypoint_visibility: Adjust who can see this object's waypoint.
set_weapon_pickup_priority: Set how a weapon is picked up.