👦entity

get_local

entity.get_local(): entity

Returns a pointer to the local player.

get_player_by_index

entity.get_player_by_index(player_index: number): entity

Name	Type	Description
player_index	number	player_index

Returns a pointer to the specified player.

get_weapon_by_player

entity.get_weapon_by_player(player: entity): weapon

Name	Type	Description
player	entity	player

Returns a pointer to the player's weapon entity.

get_entity_from_handle

entity.get_entity_from_handle(c_base_handle: handle): entity

Name	Type	Description
handle	c_base_handle	entity handle

Returns entity from handle.

get_entities_by_classid

entity.get_entities_by_classid(integer: class_id): entity

Name	Type	Description
class_id	integer	entity class id

Returns all entities by class id.

get_players

entity.get_players(ignore_team: boolean): table

Name	Type	Description
ignore_team	boolean	ignore_team

Returns the table of pointers to entities.

classes:

:get_animstate

<entity>:get_animstate(): table

Field

m_flUpVelocity m_bInHitGroundAnimation m_bOnGround m_fDuckAmount m_fLandingDuckAdditiveSomething m_flCurrentFeetYaw m_flCurrentTorsoYaw m_flEyeYaw m_flFeetCycle m_flFeetSpeedForwardsOrSideWays m_flFeetSpeedUnknownForwardOrSideways m_flFeetYawRate m_flGoalFeetYaw m_flHeadHeightOrOffsetFromHittingGroundAnimation m_flLastClientSideAnimationUpdateTime m_flLastOriginZ m_flLeanAmount m_flMovingFraction m_flPitch m_flSpeedNormalized m_flStopToFullRunningFraction m_flTimeSinceStartedMoving m_flTimeSinceStoppedMoving m_iLastClientSideAnimationUpdateFramecount m_velocity m_vLastOrigin m_vOrigin m_vVelocityX m_vVelocityY

:max_desync_delta

<anim_state>:max_desync_delta(): number

Returns the player animstate.

:get_animlayer

<entity>:get_animlayer(index: number): table

Name	Type	Description
index	number	Animlayer index

Field

m_bClientBlend m_flBlendIn m_flCycle m_flPlaybackRate m_flPrevCycle m_flWeight m_flWeightDeltaRate m_nDispatchSequence m_nOrder m_nSequence

Returns the player animlayer.

:get_sequence_activity

<entity>:get_sequence_activity(sequence: number): number

Name	Type	Description
sequence	number	Sequence

Returns the player sequence activity.

:get_name

<entity>:get_name(): string

Returns the player name.

:get_weapons

<entity>:get_weapons(index: number): weapon

Returns a table containing pointers to every weapon entity the player is currently carrying.

Name	Type	Description
index	number	index

:get_index

<entity>:get_index(): number

Returns the index of the player.

:is_dormant

<entity>:is_dormant(): boolean

Returns true, if the player is dormant.

:get_team

<entity>:get_team(): number

Returns the player team number.

:is_alive

<entity>:is_alive(): boolean

Returns true, if the player is alive.

:get_velocity

<entity>:get_velocity(): vector

Returns the velocity vector of the player.

:get_absorigin

<entity>:get_absorigin(): vector

Returns the absolute position vector of the player.

:get_eye_angles

<entity>:get_eye_angles(): vector

Returns the angles of the player.

:get_hitbox_position

<entity>:get_hitbox_position(): vector

Returns the position of the specified hitbox.

:get_muzzle_position

<entity>:get_muzzle_position(): vector

Returns the position of the muzzle.

:get_bone_position

<entity>:get_bone_position(): vector

Returns the position of the specified bone.

:get_shoot_position

<entity>:get_shoot_position(): vector

Returns the position of the shoot.

:has_heavy_arm

<entity>:has_heavy_arm(): vector

Returns true, if the player has heavy armor

:is_scoped

<entity>:is_scoped(): vector

Returns true, if the player is scoped.

:get_health

<entity>:get_health(): vector

Returns the player health.

:get_bbox

<entity>:get_bbox(): table

Returns a table containing x, y, w, and h values.

:get_body_yaw

<entity>:get_body_yaw(): number

Returns the player body yaw.

:m_flposeparameter

<entity>:m_flposeparameter()[index: number]: number

Name	Type	Description
index	number	-

Returns the player pose parameters.

:set_render_pose

<entity>:set_render_pose(index: number, value: number)

Name	Type	Description
index	number	index
value	number	value

cheat.push_callback("on_frame_net", function(stage)
    if (stage == enum_frames.frame_start) then
        local player = entity.get_local()
        
        if (player == nil or not player:is_alive()) then
            return
        end
        
        local flags = player:get_prop_int("CBasePlayer", "m_fFlags")
        local on_ground = bit.band(flags, 1) == 1
        
        if (not on_ground) then
            player:set_render_pose(6, 1) --> Static legs
        end
    end
end)

sets the values of the pose parameters.

:draw_hitbox

<entity>:draw_hitbox(hitbox: number, col: color, duration: number, ignore_z: boolean)

Name	Type	Description
hitbox	number	hitbox
col	color	col
duration	number	duration
ignore_z	boolean	ignore_z

Draws a specific player hitbox.

:set_model_index

<entity>:set_model_index(index: number)

Name	Type	Description
index	number	index

Sets the index of the model to the player.

:get_avatar_texture

<entity>:get_avatar_texture(): image

Returns the texture of the player's avatar.

:get_model

<entity>:get_model(): model

Returns the player model.

getting prop values

int

<entity>:get_prop_int(class_name: string, prop_name: string): number

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name

float

<entity>:get_prop_float(class_name: string, prop_name: string): number

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name

bool

<entity>:get_prop_bool(class_name: string, prop_name: string): boolean

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name

string

<entity>:get_prop_string(class_name: string, prop_name: string): string

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name

entity

<entity>:get_prop_entity(class_name: string, prop_name: string): entity

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name

vector

<entity>:get_prop_vector(class_name: string, prop_name: string): vector

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name

setting prop values

int

<entity>:set_prop_int(class_name: string, prop_name: string, value: number)

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name
value	number	Prop value

float

<entity>:set_prop_float(class_name: string, prop_name: string, value: number)

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name
value	number	Prop value

bool

<entity>:set_prop_bool(class_name: string, prop_name: string, value: boolean)

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name
value	boolean	Prop value

string

<entity>:set_prop_string(class_name: string, prop_name: string, value: string)

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name
value	string	Prop value

entity

<entity>:set_prop_entity(class_name: string, prop_name: string, value: string)

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name
value	entity	Prop value

vector

<entity>:set_prop_vector(class_name: string, prop_name: string, value: vector)

Name	Type	Description
class_name	string	Class name
prop_name	string	Prop name
value	vector	Prop value

getting offset values

available examples: using offsets

:get_offset

<entity>:get_offset(offset: number): offset_class

Returns the offset class.

int

<entity>:get_offset(offset: number):get_int()

Returns the offset value in integer data type.

float

<entity>:get_offset(offset: number):get_float()

Returns the offset value in float data type.

bool

<entity>:get_offset(offset: number):get_bool()

Returns the offset value in boolean data type.

char

<entity>:get_offset(offset: number):get_char()

Returns the offset value in char data type.

vector

<entity>:get_offset(offset: number):get_vector()

Returns the offset value in vector data type.