All pages
Powered by GitBook
1 of 7

base_entity

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

schema_accessor_t

Accessor instance or pointer accessor instance

Example

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

get_class_name

Function

Returns schema class name.

Returns

Type

Description

string

Name. Returns nil when failed.

Example

local name = entity:get_class_name()

to_weapon_base_gun

Function

Safe-casts the entity to cs2_weapon_base_gun, returns nil if not a weapon_base_gun

Returns

Type

Description

cs2_weapon_base_gun?

Casted entity. Returns nil if the cast failed.

Example

local gun = entity:to_weapon_base_gun()

to_weapon_base

Function

Safe-casts the entity to cs2_weapon_base, returns nil if not a weapon_base

Returns

Type

Description

cs2_weapon_base?

Casted entity. Returns nil if the cast failed.

Example

local wpn = entity:to_weapon_base()

to_player_pawn

Function

Safe-casts the entity to cs2_player_pawn, returns nil if not a player_pawn

Returns

Type

Description

cs2_player_pawn?

Casted entity. Returns nil if the cast failed.

Example

local pawn = entity:to_player_pawn()

to_player_controller

Function

Safe-casts the entity to cs2_player_controller, returns nil if not a player_controller

Returns

Type

Description

cs2_player_controller?

Casted entity. Returns nil if the cast failed.

Example

local controller = entity:to_player_controller()

schema_accessor_t

This type represents a special structure that references a certain field in the entity object.

You can check the returned type by using type() function.

Do not ever store an instance of this type anywhere but in a scope of an event because entity might be removed.

get

Returns the value.

Arguments

None.

Returns

Type

Description

<type>

Value.

Example

local health = player.m_iHealth:get();

set

Sets the value.

Arguments

Name

Type

Description

value

<type>

Value.

Returns

Nothing.

Example

player.m_iHealth:set(50); -- won't really do anything with the health

cs2_weapon_base_gun

This type represents a CCSWeaponBaseGun class.

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

get_abs_origin

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

Arguments

None.

Returns

Type

Description

vector

Origin.

Example

local org = wep:get_abs_origin();

get_max_speed

Returns the maximal player speed when holding this weapon.

Arguments

None.

Returns

Type

Description

float

Max speed, in UPS.

Example

local spd = wep:get_max_speed();

get_inaccuracy

Returns the current inaccuracy value.

Arguments

Name

Type

Description

mode

csweapon_mode

Weapon mode.

Returns

Type

Description

float

Inaccuracy value.

Example

local inacc = wep:get_inaccuracy(csweapon_mode.primary_mode);

get_spread

Returns the current spread value.

Arguments

Name

Type

Description

mode

csweapon_mode

Weapon mode.

Returns

Type

Description

float

Inaccuracy value.

Example

local spread = wep:get_spread(csweapon_mode.primary_mode);

get_id

Returns the weapon ID.

Arguments

None.

Returns

Type

Description

weapon_id

Weapon ID.

Example

local wep_id = wep:get_id();

get_type

Returns the weapon type.

Arguments

None.

Returns

Type

Description

csweapon_type

Weapon type.

Example

local type = wep:get_type();

get_data

Returns the weapon static data.

Arguments

None.

Returns

Type

Description

ccsweapon_base_vdata

Weapon data.

Example

local data = wep:get_data();

is_gun

Returns true if this weapon is a firearm.

Arguments

None.

Returns

Type

Description

bool

true if a firearm.

Example

if wep:is_gun() then
    -- ...
end

is_attackable

Returns true if you can attack with this weapon.

Arguments

None.

Returns

Type

Description

bool

true if can attack.

Example

if wep:is_attackable() then
    -- ...
end

has_secondary_attack

Returns true if this weapon has a secondary attack mode.

Arguments

None.

Returns

Type

Description

bool

true if has the secondary attack mode.

Example

if wep:has_secondary_attack() then
    -- ...
end

has_spread

Returns true if this weapon has spread (e.g. knives do not have any spread).

Arguments

None.

Returns

Type

Description

bool

true if has spread.

Example

if wep:has_spread() then
    -- ...
end

cs2_player_pawn

This type represents a C_CSPlayerPawn class.

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

should_draw

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

Arguments

None.

Returns

Type

Description

bool

true if will.

Example

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

is_left_handed

Returns true if left-hand mode is enabled.

Arguments

None.

Returns

Type

Description

bool

true if left-handed.

Example

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

get_abs_origin

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

Arguments

None.

Returns

Type

Description

vector

Origin.

Example

local org = player:get_abs_origin();

get_abs_angles

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

Arguments

None.

Returns

Type

Description

vector

Angles.

Example

local ang = player:get_abs_angles();

get_abs_velocity

Method

Returns the absolute velocity.

Arguments

None.

Returns

Type

Description

vector

Velocity.

Example

local vel = player:get_abs_velocity();

set_abs_origin

Sets the new absolute origin.

Arguments

Name

Type

Description

vec

vector

New origin.

Returns

Nothing.

Example

player:set_abs_origin(my_vec);

set_abs_angles

Sets new absolute angles.

Arguments

Name

Type

Description

ang

vector

New angles.

Returns

Nothing.

Example

player:set_abs_angles(my_ang);

set_abs_velocity

Method

Sets new absolute velocity.

Arguments

Name

Type

Description

vel

vector

New velocity.

Returns

Nothing.

Example

player:set_abs_velocity(my_vel);

is_alive

Returns true if the player is alive.

Arguments

None.

Returns

Type

Description

bool

true if alive.

Example

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

is_enemy

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:is_enemy() then
    -- ...
end

is_enemy_to

Returns whether this player is an enemy to another entity.

Arguments

Name

Type

Description

ent

base_entity

Other entity.

Returns

Type

Description

bool

true if an enemy.

Example

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

get_active_weapon

Returns the active weapon.

Arguments

None.

Returns

Type

Description

cs2_weapon_base_gun

Weapon instance.

Example

local wep = player:get_active_weapon();

get_name

Returns the sanitized player name.

Arguments

None.

Returns

Type

Description

string

Player's name.

Example

local name = player:get_name();

get_view_offset

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:get_view_offset();

get_eye_pos

Returns the player's eye position.

Arguments

None.

Returns

Type

Description

vector

Eye position.

Example

local eyes = player:get_eye_pos();

cs2_player_controller

This type represents a CCSPlayerController class.

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

is_enemy

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:is_enemy() then
    -- ...
end

get_name

Returns the sanitized player name.

Arguments

None.

Returns

Type

Description

string

Player's name.

Example

local name = player:get_name();

get_pawn

Returns the pawn attached to this controller.

Arguments

None.

Returns

Type

Description

cs2_player_pawn

Pawn instance.

Example

local pawn = ctrl:get_pawn();

get_active_weapon

Returns the active weapon.

Arguments

None.

Returns

Type

Description

cs2_weapon_base_gun

Weapon instance.

Example

local wep = player:get_active_weapon();

get_observer_pawn

Returns the observer pawn used for this controller.

Arguments

None.

Returns

Type

Description

base_entity

Entity.

Example

local obs_pawn = ctrl:get_observer_pawn();

get_observer_target

Returns the pawn this controller is currently observing.

Arguments

None.

Returns

Type

Description

base_entity

Entity.

Example

local obs = ctrl:get_observer_target();

get_observer_mode

Returns the current observer mode.

Arguments

None.

Returns

Type

Description

observer_mode_t

Observer mode.

Example

local mode = ctrl:get_observer_mode();

cs2_weapon_base

This type represents a CCSWeaponBase entity.

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

get_abs_origin

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

Arguments

None.

Returns

Type

Description

vector

Origin.

Example

local org = wep:get_abs_origin();

get_id

Returns the weapon ID.

Arguments

None.

Returns

Type

Description

weapon_id

Weapon ID.

Example

local wep_id = wep:get_id();

get_type

Returns the weapon type.

Arguments

None.

Returns

Type

Description

csweapon_type

Weapon type.

Example

local type = wep:get_type();

get_data

Returns the weapon static data.

Arguments

None.

Returns

Type

Description

ccsweapon_base_vdata

Weapon data.

Example

local data = wep:get_data();

cs2_grenade_projectile

This type represents a grenade projectile.

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

get_abs_origin

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

Arguments

None.

Returns

Type

Description

vector

Origin.

Example

local org = wep:get_abs_origin();

get_grenade_type

Returns the grenade type.

Arguments

None.

Returns

Type

Description

int

Grenade type.

Example

local type = gren:get_grenade_type();