Comment on page

entity

Functions for getting and setting entities and entity data.

Functions:

entity.get_all

entity.get_all([classname: string]): table (entindex)
Argument
Type
Description
classname
string (entity classname)
String that specifies the class name of entities that will be added to the list, for example "CCSPlayer".
Returns an array of entity indices. Pass no arguments for all entities.

entity.get_bounding_box

entity.get_bounding_box(player: number): number, number, number, number, number
Argument
Type
Description
player
number (entindex)
Entity index of the player.
Returns x1, y1, x2, y2, alpha_multiplier. The contents of x1, y1, x2, y2 must be ignored when alpha_multiplier is zero, which indicates that the bounding box is invalid and should not be drawn.

entity.get_classname

entity.get_classname(ent: number): string
Argument
Type
Description
ent
number (entindex)
Entity index.
Returns the name of the entity's class, or nil on failure.

entity.get_esp_data

entity.get_esp_data(player: number): table
Argument
Type
Description
player
number (entindex)
Entity index
Returns a table containing alpha, health, and weapon_id, or nil on failure.

entity.get_game_rules

entity.get_game_rules(): number (entindex)
Returns entity index of CCSGameRulesProxy instance, or nil if none exists.

entity.get_local_player

entity.get_local_player(): number (entindex)
Returns the entity index for the local player, or nil on failure.

entity.get_origin

entity.get_origin(ent: number): number, number, number
Argument
Type
Description
ent
number (entindex)
Entity index
Returns the x, y, z coordinates of the entity. Only works for non-dormant entities, except for players, where it will return the dormant esp origin

entity.get_player_name

entity.get_player_name(ent: number): string
Argument
Type
Description
ent
number (entindex)
Player entity index.
Returns the player's name, or the string "unknown" on failure.

entity.get_player_resource

entity.get_player_resource(): number (entindex)
Returns entity index of CCSPlayerResource instance, or nil if none exists.

entity.get_player_weapon

entity.get_player_weapon(ent: number): number (entindex)
Argument
Type
Description
ent
number (entindex)
Player entity index.
Returns the entity index of the player's active weapon, or nil if the player is not alive, dormant, etc.

entity.get_players

entity.get_players([enemies_only: boolean]): table (entindex)
Argument
Type
Description
enemies_only
boolean
If true then you and the players on your team will not be added to the list.
Returns an array of player entity indices. Dormant and dead players will not be added to the list.

entity.get_prop

entity.get_prop(ent: number, propname: string[, array_index: number]): any
Argument
Type
Description
ent
number (entindex)
Entity index.
propname
string (netprop)
Name of the networked property.
array_index
number
If propname is an array, the value at this array index will be returned.
Returns the value of the property, or nil on failure. For vectors or angles, this returns three values.

entity.get_steam64

entity.get_steam64(player: number): string
Argument
Type
Description
player
number (entindex)
Entity index of the player.
Returns steamID3, or nil on failure.

entity.hitbox_position

entity.hitbox_position(player: number, hitbox: number): number, number, number
Argument
Type
Description
player
number (entindex)
Entity index of the player.
hitbox
number (hitbox id)
Either a string of the hitbox name, or an integer index of the hitbox.
Returns world coordinates x, y, z, or nil on failure.

entity.is_alive

entity.is_alive(ent: number): boolean
Argument
Type
Description
ent
number (entindex)
Entity index.
Returns true if the player is not dead.

entity.is_dormant

entity.is_dormant(ent: number): boolean
Argument
Type
Description
ent
number (entindex)
Entity index.
Returns true if the entity is dormant.

entity.is_enemy

entity.is_enemy(ent: number): boolean
Argument
Type
Description
ent
number (entindex)
Entity index.
Returns true if the entity is on the other team.

entity.set_prop

entity.set_prop(ent: number, propname: string, value: any[, array_index: number])
Argument
Type
Description
ent
number (entindex)
Entity index.
propname
string (netprop)
Name of the networked property.
value
any
The property will be set to this value. For vectors or angles, separate the components by commas.
array_index
number
If propname is an array, the value at this array index will be set.
Sets the value of the property. For vectors or angles, pass three values.
Last modified 2yr ago