WorldObject
This type represents a generic object. It inherits all API functionality from Object. All members and functions are read-only.
Members
The following are members of WorldObject. All members are read-only. For example:
print("Enemy orientation: " .. enemy.orientation)
| Name | Description | Return Type | Tested? |
|---|---|---|---|
| orientation | the object's orientation | number |
Yes |
| name | the object's name | string |
Yes |
| zone_id | the object's Zone Id | number |
No |
| area_id | the object's Area Id | number |
No |
| position | the object's position | Position |
Yes |
Functions
The following are callable functions on any WorldObject. All functions are read-only.
print("Bot A angle to bot b: " .. bot_a:get_angle(bot_b))
| Function | Description | Parameters | Return Type | Tested? |
|---|---|---|---|---|
| get_nearby_game_objects | get an array of all game objects within given radius of world object | number radius |
array<GameObject> |
No |
| get_nearby_creatures | get an array of all units within given radius of world object | number radius |
array<Unit> |
No |
| get_angle | get the angle to a given object- angle in range 0..2*pi | WorldObject world_obj or Position pos or (number x, number y) |
number |
No |
| get_close_point | get a point close to the object | number bounding_radius, number distance, number angle |
Posiiton |
No |
| has_in_arc | whether or not the given target is in the object's arc | Unit target |
bool |
No |
| is_within_los | whether or not the given target is in the object's line of sight | Unit target |
bool |
No |
| is_in_range | whether or not the given target is in range of the given spell | Unit target, number spell_id |
bool |
No |
| gcd | global cooldown remaining for the given spell, 0 if ready | number spell_id |
number (remaining time) |
No |
| distance_to | get the distance between two objects | WorldObject world_object |
number |
No |