Class Entity

Hierarchy (view full)

Entity
- PlayerClass

Index

Constructors

Methods

decrement_value get_value increment_value run_function run_threaded_function set_array set_value

Constructors

constructor

new Entity(): Entity
Returns Entity
- Defined in entity.ts:2

Methods

decrement_value

decrement_value(field, amount): string[]
Parameters
- field: string
- amount: string | number
Returns string[]
- Defined in entity.ts:45

get_value

get_value(field): string
Parameters
- field: string
Returns string
Description
Returns the value of a player variable

Example
```
export const init_functions = [
    Core.log(Player.get_value("name"))
];
```
- Defined in entity.ts:11

increment_value

increment_value(field, amount): string[]
Parameters
- field: string
- amount: string | number
Returns string[]
- Defined in entity.ts:41

run_function

run_function(function_call): string[]
Parameters
- function_call: string
Returns string[]
Description
Run a function on the player

Example
```
export const init_functions = [
    Player.run_function('custom_function()')
]
```
- Defined in entity.ts:33

run_threaded_function

run_threaded_function(function_call): string[]
Parameters
- function_call: string
Returns string[]
- Defined in entity.ts:37

set_array

set_array(field, arr): string[]
Parameters
- field: string
- arr: any[]
Returns string[]
Description
Sets an array field on the player with the contents arr. If is_string = true then the items will be added to the array as strings.

Example
```
const items = [
    "test",
    "test2",
    "test3"
]

export const init = [
    player.setArray("test_items", items, true)
]
```
- Defined in entity.ts:62

set_value

set_value(field, value): string[]
Parameters
- field: string
- value: string | number
Returns string[]
Description
Sets a variable field on the player to value.

Example
```
export const init_functions = [
    Player.set_value("name", `"xXCool_NameXx"`)
];
```
- Defined in entity.ts:22

Generated using TypeDoc