> For the complete documentation index, see [llms.txt](https://fecality-api.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fecality-api.gitbook.io/docs/documentation/datatypes/entity.md).

# entity

entity datatype

### Entity <a href="#entity" id="entity"></a>

#### get\_index <a href="#get_index" id="get_index"></a>

local ent = entities.get\_entity(1)ent:get\_index()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| entity index                                                                    | number                                                                             |

#### is\_player <a href="#is_player" id="is_player"></a>

local ent = entities.get\_entity(1)ent:is\_player()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| whether or not the entity is a player                                           | boolean                                                                            |

#### get\_class <a href="#get_class" id="get_class"></a>

ent:get\_class() -- ex: CCSPlayer

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| entity's class name                                                             | string                                                                             |

#### get\_prop <a href="#get_prop" id="get_prop"></a>

ent:get\_prop("m\_hMyWeapons", 1)

| ​[Parameter](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Description](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​       | ​[Default value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| name                                                                                | string                                                                             | ​[prop name](https://github.com/Jewlsxxx/Fatality-Luas/blob/main/Libraries/NetvarDump.txt)​ | ❌                                                                                       |
| table index                                                                         | number                                                                             | index of prop if it is an array                                                             | 0                                                                                       |

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​                        |
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| prop's value                                                                    | number, string, boolean, [math.vec3](https://jewls.gitbook.io/fatality-api/documentation/datatypes/vec3)​ |

#### set\_prop <a href="#set_prop" id="set_prop"></a>

ent:set\_prop("m\_bSpotted", 0, true)

| ​[Parameter](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Description](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​       |
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| name                                                                                | string                                                                             | ​[prop name](https://github.com/Jewlsxxx/Fatality-Luas/blob/main/Libraries/NetvarDump.txt)​ |
| table index                                                                         | number                                                                             | index of prop if it is an array                                                             |
| value                                                                               | any                                                                                | value to set prop to                                                                        |

**Usage:**

Sets prop's value.

#### is\_alive <a href="#is_alive" id="is_alive"></a>

ent:is\_alive()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| whether or not the entity is alive                                              | boolean                                                                            |

#### get\_esp\_alpha <a href="#get_esp_alpha" id="get_esp_alpha"></a>

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| esp alpha (0 - 255)                                                             | float                                                                              |

### Player <a href="#player" id="player"></a>

#### is\_valid <a href="#is_valid" id="is_valid"></a>

local player = entities.get\_entity(engine.get\_local\_player())player:is\_valid()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| true if the player is alive and not dormant                                     | boolean                                                                            |

#### is\_enemy <a href="#is_enemy" id="is_enemy"></a>

player:is\_enemy()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| true if the player is an enemy                                                  | boolean                                                                            |

#### get\_player\_info <a href="#get_player_info" id="get_player_info"></a>

player:get\_player\_info()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​          |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| the player's info                                                               | ​[player\_info](https://jewls.gitbook.io/fatality-api/documentation/datatypes/player_info)​ |

#### get\_bbox <a href="#get_bbox" id="get_bbox"></a>

local x1, y1, x2, y2 = player:get\_bbox()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| x1                                                                              | number                                                                             |
| y1                                                                              | number                                                                             |
| x2                                                                              | number                                                                             |
| y2                                                                              | number                                                                             |

Only works on enemy players!

#### get\_weapon <a href="#get_weapon" id="get_weapon"></a>

player:get\_weapon()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​      |
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| the player's active weapon                                                      | ​[entity](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity#entity)​ |

#### get\_eye\_position <a href="#get_eye_position" id="get_eye_position"></a>

player:get\_eye\_position()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| x                                                                               | number                                                                             |
| y                                                                               | number                                                                             |
| z                                                                               | number                                                                             |

#### get\_hitbox\_position <a href="#get_hitbox_position" id="get_hitbox_position"></a>

player:get\_hitbox\_position(1)

| ​[Parameter](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Description](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| hitbox\_index                                                                       | number                                                                             | the hitbox id                                                                         |

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/datatypes/entity)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| x                                                                               | number                                                                             |
| y                                                                               | number                                                                             |
| z                                                                               | number                                                                             |