Class Billboard

Hierarchy (View Summary)

Billboard

Index

Constructors

constructor

Accessors

Methods

createBody createMesh getDirection getFloorZ getRow getScreenPosition spawn update updateGroup updateTexture create

Constructors

constructor

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

Properties

`Protected`_z

_z: number = 0

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`invFrameDuration

invFrameDuration: number

`Protected`invRows

invRows: number

`Protected` `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

`Protected` `Static`tempVector

tempVector: Vector3 = ...

`Protected` `Static`tempVectorDivide

tempVectorDivide: Vector3 = ...

Accessors

z

get z(): number
Returns number
- Defined in src/view/billboard.ts:61
set z(z: number): void
Parameters
- z: number
Returns void
- Defined in src/view/billboard.ts:65

Methods

`Protected`createBody

createBody(x: number, y: number): StaticBody
Parameters
- x: number
- y: number
Returns StaticBody
- Defined in src/view/billboard.ts:143

`Protected`createMesh

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

`Protected`getDirection

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

`Protected`getFloorZ

getFloorZ(__namedParameters?: BaseBody): number
Parameters
- __namedParameters: BaseBody = ...
Returns number
- Defined in src/view/billboard.ts:198

`Protected`getRow

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

getScreenPosition

getScreenPosition(): { x: number; y: number }
Returns { x: number; y: number }
- Defined in src/view/billboard.ts:121

`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:147

update

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

`Protected`updateGroup

updateGroup(): void
Returns void
- Defined in src/view/billboard.ts:158

`Protected`updateTexture

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

`Static`create

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

Class Billboard

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Billboard

Properties

Protected_z

body

ProtectedcenterOffset

Protectedcols

Protecteddirection

ProtecteddirectionsToRows

Protectedframe

ProtectedframeDuration

ProtectedinvCols

ProtectedinvFrameDuration

ProtectedinvRows

Protected Optionallevel

mesh

Protectedrows

ProtectedscaleX

ProtectedscaleY

ProtectedtotalFrames

Protected StaticcompensateGroupZ

Protected StatictempVector

Protected StatictempVectorDivide

Accessors

z

Returns number

Parameters

Returns void

Methods

ProtectedcreateBody

Parameters

Returns StaticBody

ProtectedcreateMesh

Parameters

Returns Object3D<Object3DEventMap>

ProtectedgetDirection

Returns Direction

ProtectedgetFloorZ

Parameters

Returns number

ProtectedgetRow

Parameters

Returns number

getScreenPosition

Returns { x: number; y: number }

Protectedspawn

Parameters

Returns void

update

Parameters

Returns void

ProtectedupdateGroup

Returns void

ProtectedupdateTexture

Returns void

Staticcreate

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

`Protected`_z

`Protected`centerOffset

`Protected`cols

`Protected`direction

`Protected`directionsToRows

`Protected`frame

`Protected`frameDuration

`Protected`invCols

`Protected`invFrameDuration

`Protected`invRows

`Protected` `Optional`level

`Protected`rows

`Protected`scaleX

`Protected`scaleY

`Protected`totalFrames

`Protected` `Static`compensateGroupZ

`Protected` `Static`tempVector

`Protected` `Static`tempVectorDivide

`Protected`createBody

`Protected`createMesh

`Protected`getDirection

`Protected`getFloorZ

`Protected`getRow

`Protected`spawn

`Protected`updateGroup

`Protected`updateTexture

`Static`create