> For the complete documentation index, see [llms.txt](https://golua.fatality.win/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://golua.fatality.win/documentation/datatypes/entity.md). # entity entity datatype ## Entity ### get\_index ```lua local ent = entities.get_entity(1) ent:get_index() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | entity index | number | ### is\_player ```lua local ent = entities.get_entity(1) ent:is_player() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | whether or not the entity is a player | boolean | ### get\_class ```lua ent:get_class() -- ex: CCSPlayer ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | entity's class name | string | ### get\_prop ```lua ent:get_prop("m_hMyWeapons", 1) ```


Parameter	Datatype	Description	Default value
name	string	prop name	❌
table index	number	index of prop if it is an array	0

#### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------------------------------: | | prop's value | number, string, boolean, [math.vec3](/documentation/datatypes/vec3.md) | ### set\_prop ```lua ent:set_prop("m_bSpotted", 0, true) ```


Parameter	Datatype	Description
name	string	prop name
table index	number	index of prop if it is an array
value	any	value to set prop to

#### Usage: Sets prop's value. {% file src="/files/TvE7Rw1QIRErzBxN4wrh" %} ### is\_alive ```lua ent:is_alive() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | whether or not the entity is alive | boolean | ### get\_esp\_alpha #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | esp alpha (0 - 255) | float | ## Player ### is\_valid ```lua local player = entities.get_entity(engine.get_local_player()) player:is_valid() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | true if the player is alive and not dormant | boolean | ### is\_enemy ```lua player:is_enemy() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | true if the player is an enemy | boolean | ### get\_player\_info ```lua player:get_player_info() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :-----------------------------------------------------: | | the player's info | [player\_info](/documentation/datatypes/player_info.md) | ### get\_bbox ```lua local x1, y1, x2, y2 = player:get_bbox() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | x1 | number | | y1 | number | | x2 | number | | y2 | number | {% hint style="warning" %} Only works on enemy players! {% endhint %} ### get\_weapon ```lua player:get_weapon() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | the player's active weapon | [entity](#entity) | ### get\_eye\_position ```lua player:get_eye_position() ``` #### Returns: | [Value](/documentation/datatypes/entity.md) | [Datatype](/documentation/datatypes/entity.md) | | :-----------------------------------------: | :--------------------------------------------: | | x | number | | y | number | | z | number | ### get\_hitbox\_position ```lua player:get_hitbox_position(1) ```


Parameter	Datatype	Description
hitbox_index	number	the hitbox id