C_BaseEntity

This type represents a base game entity.

This type may be returned for any other abstract entity class, but internally will point to the correct type.

__index

Function

Attemps to search for a field in this class.

Arguments

Name	Type	Description
name	string	Field name.

Returns

Type	Description
SchemaAccessor_t	Accessor instance or pointer accessor instance

Example

local health = player.m_iHealth;
local health = player['m_iHealth']; -- this also works

---

GetClassName

Function

Returns schema class name.

Returns

Type	Description
string	Name. Returns nil when failed.

Example

local name = entity:GetClassName()

---

GetHandle

Function

Returns handle for this entity.

Returns

Type	Description
CHandle	Entity handle

Example

local name = entity:GetHandle()

---

GetPointer

Function

Returns a memory address for this entity, useful with FFI.

Returns

Type	Description
userdata	Entity pointer

Example

local name = entity:GetPointer()

---

ToWeaponBaseGun

Function

Safe-casts the entity to C_CSWeaponBaseGun, returns nil if not a C_CSWeaponBaseGun .

Returns

Type	Description
C_CSWeaponBaseGun?	Casted entity. Returns nil if the cast failed.

Example

local gun = entity:ToWeaponBaseGun()

---

ToWeaponBase

Function

Safe-casts the entity to C_CSWeaponBase, returns nil if not a C_CSWeaponBase .

Returns

Type	Description
C_CSWeaponBase?	Casted entity. Returns nil if the cast failed.

Example

local wpn = entity:ToWeaponBase()

---

ToPlayerPawn

Function

Safe-casts the entity to C_CSPlayerPawn, returns nil if not a C_CSPlayerPawn .

Returns

Type	Description
C_CSPlayerPawn?	Casted entity. Returns nil if the cast failed.

Example

local pawn = entity:ToPlayerPawn()

---

ToPlayerController

Function

Safe-casts the entity to C_CSPlayerController, returns nil if not a C_CSPlayerController .

Returns

Type	Description
C_CSPlayerController?	Casted entity. Returns nil if the cast failed.

Example

local controller = entity:ToPlayerController()