> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atlanta.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Entry

> The module for managing and interacting with game entries through dedicated functions for retrieval, validation, and accessing other information.

***

## Access

All entry C++ functions are exposed to your Lua script via a single global table named **`entry`**. You access individual values by using the dot (`.`) or bracket (`[]`) operator on this table.

```lua Entry Usage Example theme={null}
local entry_client_instance = entry.get_client_instance(); -- Dot Operator
local entry_client_object = entry["get"](entry_client_instance); -- Bracket Operator
```

***

## Functions

This section lists all available C++ functions exposed within the global **`entry`** table. These functions are used for retrieving, managing, and validating references to game entries and other in game instances.

***

### valid

Checks if the provided Entry object is currently valid and active (not in a removal state).

```lua theme={null}
valid(EntryObject*: entry, boolean?: model): boolean
```

<ParamField path="entry" type="EntryObject*" required> The **EntryObject** instance (shared pointer) to be validated.</ParamField>
<ParamField path="model" type="boolean"> If `true`, the function performs an additional check to ensure the entry has a valid **ModelObject**. Defaults to `false`.</ParamField>

### list

Retrieves a Lua table containing the currently active list of Entry objects. The list can be filtered based on the optional exclusion flags.

```lua theme={null}
list(EntryExclude?: exclude): table<EntryObject*>
```

<ParamField path="exclude" type="EntryExclude">A flag from the **EntryExclude** enumeration specifying which types of entries should be filtered out. Defaults to `EntryExclude.None` (no filtering).</ParamField>

### get

Retrieves a specific EntryObject instance based on its player object address.

```lua theme={null}
get(number: address): EntryObject*
```

<ParamField path="address" type="number" required>The player object number address of the EntryObject to retrieve.</ParamField>

### get\_root

Retrieves the root PartObject associated with a given entrie's player object address.

```lua theme={null}
get_root(number: address): PartObject*
```

<ParamField path="address" type="number" required>The player object number address of the entry whose root object is requested.</ParamField>

### get\_client\_instance

Returns the local client's player instance address.

```lua theme={null}
get_client_instance(): EntryObject*
```

***

### get\_client\_team

Returns the local client's team instance address.

```lua theme={null}
get_client_team(): number
```

***

### get\_tick\_count

Returns the current entry thread tick count.

```lua theme={null}
get_tick_count(): number
```

***

### get\_model\_tick\_count

Returns the current model thread tick count.

```lua theme={null}
get_model_tick_count(): number
```

***

### get\_entry\_count

Returns the total number of entries currently loaded in the game environment.

```lua theme={null}
get_entry_count(): number
```