Class Billboard

Hierarchy (View Summary)

Billboard
- Sprite

Index

Constructors

constructor

new Billboard(__namedParameters: BillboardProps): Billboard
Parameters
- __namedParameters: BillboardProps
Returns Billboard
- Defined in src/view/billboard.ts:51

Properties

body

body: BaseBody

`Protected`centerOffset

centerOffset: number

`Protected`cols

cols: number

`Protected`direction

direction: Direction = 'up'

`Protected`directionsToRows

directionsToRows: DirectionsToRows

`Protected`frame

frame: number = 0

`Protected`frameDuration

frameDuration: number

`Protected`invCols

invCols: number

`Protected`invRows

invRows: number

`Optional`level

level?: Level

mesh

mesh:
    | Object3D<Object3DEventMap>
    | Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material | Material[],
        Object3DEventMap,
    >

`Protected`rows

rows: number

`Protected`scaleX

scaleX: number

`Protected`scaleY

scaleY: number

`Protected`totalFrames

totalFrames: number

`Protected` `Static`compensateGroupZ

compensateGroupZ: number = 0.2

`Static`DIRECTIONS

DIRECTIONS: Direction[] = ...

`Protected` `Static`tempVector

tempVector: Vector3 = ...

Methods

`Protected`createBody

createBody(x: number, y: number, level: Level): BaseBody
Parameters
- x: number
- y: number
- level: Level
Returns BaseBody
- Defined in src/view/billboard.ts:142

`Protected`createMesh

createMesh(textureName: string): Object3D<Object3DEventMap>
Parameters
- textureName: string
Returns Object3D<Object3DEventMap>
- Defined in src/view/billboard.ts:124

`Protected`getDirection

getDirection(): Direction
Returns Direction
- Defined in src/view/billboard.ts:174

`Protected`getProjection

getProjection(): Vector3 | undefined
Returns Vector3 | undefined
- Defined in src/view/billboard.ts:115

`Protected`getRow

getRow(direction: Direction): number
Parameters
- direction: Direction
Returns number
- Defined in src/view/billboard.ts:186

getWorldX

getWorldX(): number
Returns number
- Defined in src/view/billboard.ts:107

getWorldY

getWorldY(): number
Returns number
- Defined in src/view/billboard.ts:111

`Protected`spawn

spawn(level: Level, x?: number, y?: number): void
Parameters
- level: Level
- x: number = ...
- y: number = ...
Returns void
- Defined in src/view/billboard.ts:146

update

update(_: number): void
Parameters
- _: number
Returns void
- Defined in src/view/billboard.ts:82

`Protected`updateTexture

updateTexture(): void
Returns void
- Defined in src/view/billboard.ts:155

`Static`create

create<T = Billboard>(
    level: Level,
    __namedParameters: BillboardCreateProps,
    Class?: any,
): Promise<T>
Type Parameters
- T = Billboard
Parameters
- level: Level
- __namedParameters: BillboardCreateProps
- Class: any = Billboard
Returns Promise<T>
- Defined in src/view/billboard.ts:21

Class Billboard

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Billboard

Properties

body

ProtectedcenterOffset

Protectedcols

Protecteddirection

ProtecteddirectionsToRows

Protectedframe

ProtectedframeDuration

ProtectedinvCols

ProtectedinvRows

Optionallevel

mesh

Protectedrows

ProtectedscaleX

ProtectedscaleY

ProtectedtotalFrames

Protected StaticcompensateGroupZ

StaticDIRECTIONS

Protected StatictempVector

Methods

ProtectedcreateBody

Parameters

Returns BaseBody

ProtectedcreateMesh

Parameters

Returns Object3D<Object3DEventMap>

ProtectedgetDirection

Returns Direction

ProtectedgetProjection

Returns Vector3 | undefined

ProtectedgetRow

Parameters

Returns number

getWorldX

Returns number

getWorldY

Returns number

Protectedspawn

Parameters

Returns void

update

Parameters

Returns void

ProtectedupdateTexture

Returns void

Staticcreate

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

`Protected`centerOffset

`Protected`cols

`Protected`direction

`Protected`directionsToRows

`Protected`frame

`Protected`frameDuration

`Protected`invCols

`Protected`invRows

`Optional`level

`Protected`rows

`Protected`scaleX

`Protected`scaleY

`Protected`totalFrames

`Protected` `Static`compensateGroupZ

`Static`DIRECTIONS

`Protected` `Static`tempVector

`Protected`createBody

`Protected`createMesh

`Protected`getDirection

`Protected`getProjection

`Protected`getRow

`Protected`spawn

`Protected`updateTexture

`Static`create