Class: TextTag#

Hierarchy#

Handle<texttag>
↳ TextTag

Constructors#

constructor#

new TextTag(): TextTag

Returns: TextTag

_{Defined in: handles/texttag.ts:6}

Properties#

handle#

• Readonly handle: texttag

_{Inherited from: Handle.handle
Defined in: handles/handle.ts:6}

Accessors#

id#

id(): number

Get the unique ID of the handle. The ID is recycled once you destroy the object.

Returns: number

The unique ID of a handle object.

_{Defined in: handles/handle.ts:18}

Methods#

destroy#

destroy(): void

Returns: void

_{Defined in: handles/texttag.ts:16}

setAge#

setAge(age: number): void

Parameters:#

Name	Type
`age`	number

Returns: void

_{Defined in: handles/texttag.ts:20}

setColor#

setColor(red: number, green: number, blue: number, alpha: number): void

Parameters:#

Name	Type
`red`	number
`green`	number
`blue`	number
`alpha`	number

Returns: void

_{Defined in: handles/texttag.ts:24}

setFadepoint#

setFadepoint(fadepoint: number): void

Parameters:#

Name	Type
`fadepoint`	number

Returns: void

_{Defined in: handles/texttag.ts:28}

setLifespan#

setLifespan(lifespan: number): void

Parameters:#

Name	Type
`lifespan`	number

Returns: void

_{Defined in: handles/texttag.ts:32}

setPermanent#

setPermanent(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

_{Defined in: handles/texttag.ts:36}

setPos#

setPos(x: number, y: number, heightOffset: number): void

Parameters:#

Name	Type
`x`	number
`y`	number
`heightOffset`	number

Returns: void

_{Defined in: handles/texttag.ts:40}

setPosUnit#

setPosUnit(u: Unit, heightOffset: number): void

Parameters:#

Name	Type
`u`	Unit
`heightOffset`	number

Returns: void

_{Defined in: handles/texttag.ts:44}

setSuspended#

setSuspended(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

_{Defined in: handles/texttag.ts:48}

setText#

setText(s: string, height: number, adjustHeight?: boolean): void

Parameters:#

Name	Type	Default value
`s`	string	-
`height`	number	-
`adjustHeight`	boolean	false

Returns: void

_{Defined in: handles/texttag.ts:52}

setVelocity#

setVelocity(xvel: number, yvel: number): void

Parameters:#

Name	Type
`xvel`	number
`yvel`	number

Returns: void

_{Defined in: handles/texttag.ts:59}

setVelocityAngle#

setVelocityAngle(speed: number, angle: number): void

Parameters:#

Name	Type
`speed`	number
`angle`	number

Returns: void

_{Defined in: handles/texttag.ts:63}

setVisible#

setVisible(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

_{Defined in: handles/texttag.ts:68}

fromHandle#

static fromHandle(handle: texttag): TextTag

Parameters:#

Name	Type
`handle`	texttag

Returns: TextTag

_{Defined in: handles/texttag.ts:72}