API / UserData

Class: UserData

Defined in: model/UserData.ts:34

The user custom data.

Extends

• BaseObject

Constructors

Constructor

new UserData(): UserData;

Returns

UserData

Inherited from

BaseObject.constructor

Properties

floats

readonly floats: number[] = [];

Defined in: model/UserData.ts:53

The custom float numbers.

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BaseObject.hashCode

---

ints

readonly ints: number[] = [];

Defined in: model/UserData.ts:45

The custom int numbers.

---

strings

readonly strings: string[] = [];

Defined in: model/UserData.ts:61

The custom strings.

Methods

addFloat()

addFloat(value: number): void;

Defined in: model/UserData.ts:77

Internal

Parameters

Parameter	Type
value	number

Returns

void

---

addInt()

addInt(value: number): void;

Defined in: model/UserData.ts:71

Internal

Parameters

Parameter	Type
value	number

Returns

void

---

addString()

addString(value: string): void;

Defined in: model/UserData.ts:83

Internal

Parameters

Parameter	Type
value	string

Returns

void

---

getFloat()

getFloat(index: number): number;

Defined in: model/UserData.ts:103

Get the custom float number.

Parameters

Parameter	Type	Default value
index	number	0

Returns

number

---

getInt()

getInt(index: number): number;

Defined in: model/UserData.ts:93

Get the custom int number.

Parameters

Parameter	Type	Default value
index	number	0

Returns

number

---

getString()

getString(index: number): string;

Defined in: model/UserData.ts:113

Get the custom string.

Parameters

Parameter	Type	Default value
index	number	0

Returns

string

---

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

BaseObject.returnToPool

---

borrowObject()

static borrowObject<T>(objectConstructor: () => T): T;

Defined in: core/BaseObject.ts:136

Get an instance of the specify class from object pool.

Type Parameters

Type Parameter
T extends BaseObject

Parameters

Parameter	Type	Description
objectConstructor	() => T	The specify class.

Returns

T

Inherited from

BaseObject.borrowObject

---

clearPool()

static clearPool(objectConstructor: typeof BaseObject): void;

Defined in: core/BaseObject.ts:111

Clear the cached instances of a specify object pool.

Parameters

Parameter	Type	Default value	Description
objectConstructor	typeof BaseObject	null	Specify class. (Clear all cached instances if not set)

Returns

void

Inherited from

BaseObject.clearPool

---

setMaxCount()

static setMaxCount(objectConstructor: typeof BaseObject, maxCount: number): void;

Defined in: core/BaseObject.ts:72

Set the maximum cache count of the specify object pool.

Parameters

Parameter	Type	Description
objectConstructor	typeof BaseObject	The specify class. (Set all object pools max cache count if not set)
maxCount	number	Max count.

Returns

void

Inherited from

BaseObject.setMaxCount

---

toString()

static toString(): string;

Defined in: model/UserData.ts:35

Returns

string

Overrides

BaseObject.toString