C_CSPlayerPawn

This type represents a C_CSPlayerPawn class.

This type inherits C_BaseEntity type. All of its base methods and fields are also available in this type.

ShouldDraw

Method

Returns true if the game will draw this player on screen.

Arguments

None.

Returns

Type	Description
bool	true if will.

Example

if player:ShouldDraw() then
    -- ...
end

---

IsLeftHanded

Method

Returns true if left-hand mode is enabled.

Arguments

None.

Returns

Type	Description
bool	true if left-handed.

Example

if player:IsLeftHanded() then
    -- ...
end

---

GetAbsOrigin

Method

Returns the absolute origin (the one that is used for rendering).

Arguments

None.

Returns

Type	Description
Vector	Origin.

Example

local org = player:GetAbsOrigin();

---

GetAbsAngles

Method

Returns the absolute angles (the one that is used for rendering).

Arguments

None.

Returns

Type	Description
Vector	Angles.

Example

local ang = player:GetAbsAngles();

---

GetAbsVelocity

Method

Returns the absolute velocity.

Arguments

None.

Returns

Type	Description
Vector	Velocity.

Example

local vel = player:GetAbsVelocity();

---

SetAbsOrigin

Method

Sets the new absolute origin.

Arguments

Name	Type	Description
vec	Vector	New origin.

Returns

Nothing.

Example

player:SetAbsOrigin(my_vec);

---

SetAbsAngles

Method

Sets new absolute angles.

Arguments

Name	Type	Description
ang	Vector	New angles.

Returns

Nothing.

Example

player:SetAbsAngles(my_ang);

---

SetAbsVelocity

Method

Sets new absolute velocity.

Arguments

Name	Type	Description
vel	Vector	New velocity.

Returns

Nothing.

Example

player:SetAbsVelocity(my_vel);

---

IsAlive

Method

Returns true if the player is alive.

Arguments

None.

Returns

Type	Description
bool	true if alive.

Example

if player:IsAlive() then
    -- ...
end

---

IsEnemy

Method

Returns true if this player is an enemy to the local player.

Arguments

None.

Returns

Type	Description
bool	true if an enemy.

Example

if player:IsEnemy() then
    -- ...
end

---

IsEnemyTo

Method

Returns whether this player is an enemy to another entity.

Arguments

Name	Type	Description
ent	C_BaseEntity	Other entity.

Returns

Type	Description
bool	true if an enemy.

Example

if player:IsEnemyTo(other_player) then
    -- ...
end

---

GetActiveWeapon

Method

Returns the active weapon.

Arguments

None.

Returns

Type	Description
C_CSWeaponBaseGun	Weapon instance.

Example

local wep = player:GetActiveWeapon();

---

GetWeapons

Method

Returns all weapons in this player's inventory.

Arguments

None.

Returns

Type	Description
table<C_CSWeaponBaseGun>	Weapon list

Example

local weapons = player:GetWeapons();
for i, v in ipairs(weapons) do
    print(v:get_id())
end

---

GetName

Method

Returns the sanitized player name.

Arguments

None.

Returns

Type	Description
string	Player's name.

Example

local name = player:GetName();

---

GetViewOffset

Method

Returns the player's view offset (eye location relative to the player's origin).

Arguments

None.

Returns

Type	Description
Vector	View offset.

Example

local vo = player:GetViewOffset();

---

GetEyePos

Method

Returns the player's eye position.

Arguments

None.

Returns

Type	Description
Vector	Eye position.

Example

local eyes = player:GetEyePos();

---

GetHitbox

Method

Returns hitbox information for a specific hitbox. Not to be confused with GetHitboxCenter.

Arguments

Name	Type	Description
index	EHitBox	The hitbox ID

Returns

Type	Description
CHitboxInfo	Hitbox info

Example

local hbox_info = player:GetHitbox(EHitBox.HEAD);

---

GetHitboxCenter

Method

Returns hitbox position for a specific hitbox.

Arguments

Name	Type	Description
index	EHitBox	The hitbox ID

Returns

Type	Description
Vector	The position

Example

local pelvis = player:GetHitboxCenter(EHitBox.PELVIS);

---

GetBoundingBox

Method

Returns the bounding box rectangle for this player. Returns nil if the player is not on screen.

If you wish to add new items to the built-in visuals, look at the playerInfo callback.

Arguments

None.

Returns

Type	Description
Rect	Player's bounding box, nil if invalid.

Example

local bbox = player:GetBoundingBox();