Class Sprite

Hierarchy (View Summary)

Billboard
- Sprite
  - NPC
  - Player

Constructors

constructor

new Sprite(props: BillboardProps, state?: SpriteState): Sprite
Parameters
- props: BillboardProps
- Optionalstate: SpriteState
Returns Sprite
Overrides Billboard.constructor
- Defined in src/view/sprite.ts:35

Properties

`Readonly`body

body: DynamicBody

`Protected`centerOffset

centerOffset: number

clickTime

clickTime: number = 0

`Protected`clickTimeout

clickTimeout: number = 0

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

state: SpriteState

`Protected`totalFrames

totalFrames: number

`Protected`velocity

velocity: number = 0

`Static` `Readonly`ANIM_SPEED

ANIM_SPEED: 0.002

`Static` `Readonly`CLICK_DURATION

CLICK_DURATION: 100

`Static` `Readonly`CLICK_PREVENT

CLICK_PREVENT: 400

`Protected` `Static`compensateGroupZ

compensateGroupZ: number = 0.2

`Static`DIRECTIONS

DIRECTIONS: Direction[] = ...

`Static` `Readonly`FALL_SPEED

FALL_SPEED: 0.13

`Static` `Readonly`JUMP_SPEED

JUMP_SPEED: 1.05

`Static` `Readonly`MOVE_SPEED

MOVE_SPEED: 0.1

`Static` `Readonly`SPIN_SPEED

SPIN_SPEED: 0.06

`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
Overrides Billboard.createBody
- Defined in src/view/sprite.ts:174

`Protected`createMesh

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

`Protected`getDirection

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

`Protected`getGear

getGear(): number
Returns number
- Defined in src/view/sprite.ts:89

`Protected`getProjection

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

`Protected`getRow

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

getWorldX

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

getWorldY

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

jump

jump(): void
Returns void
- Defined in src/view/sprite.ts:55

jumpEnd

jumpEnd(): void
Returns void
- Defined in src/view/sprite.ts:78

jumpStart

jumpStart(): Promise<void>
Returns Promise<void>
- Defined in src/view/sprite.ts:63

`Protected`onCollide

onCollide(): void
Returns void
- Defined in src/view/sprite.ts:82

`Protected`spawn

spawn(level: Level, x?: number, y?: number): void
Parameters
- level: Level
- Optionalx: number
- Optionaly: number
Returns void
Overrides Billboard.spawn
- Defined in src/view/sprite.ts:168

update

update(scale: number): void
Parameters
- scale: number
Returns void
Overrides Billboard.update
- Defined in src/view/sprite.ts:40

`Protected`updateAngle

updateAngle(scale: number): void
Parameters
- scale: number
Returns void
- Defined in src/view/sprite.ts:96

`Protected`updateAnimation

updateAnimation(scale: number): void
Parameters
- scale: number
Returns void
- Defined in src/view/sprite.ts:141

`Protected`updateFall

updateFall(scale: number): void
Parameters
- scale: number
Returns void
- Defined in src/view/sprite.ts:112

`Protected`updateMove

updateMove(scale: number): void
Parameters
- scale: number
Returns void
- Defined in src/view/sprite.ts:131

`Protected`updateTexture

updateTexture(): void
Returns void
Overrides Billboard.updateTexture
- Defined in src/view/sprite.ts:146

`Static`create

create<T = Sprite>(
    level: Level,
    props: BillboardCreateProps,
    Class?: any,
): Promise<T>
Type Parameters
- T = Sprite
Parameters
- level: Level
- props: BillboardCreateProps
- Class: any = Sprite
Returns Promise<T>
Overrides Billboard.create
- Defined in src/view/sprite.ts:11

Class Sprite

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Sprite

Properties

Readonlybody

ProtectedcenterOffset

clickTime

ProtectedclickTimeout

Protectedcols

Protecteddirection

ProtecteddirectionsToRows

Protectedframe

ProtectedframeDuration

ProtectedinvCols

ProtectedinvRows

Optionallevel

mesh

Protectedrows

ProtectedscaleX

ProtectedscaleY

Protectedstate

ProtectedtotalFrames

Protectedvelocity

Static ReadonlyANIM_SPEED

Static ReadonlyCLICK_DURATION

Static ReadonlyCLICK_PREVENT

Protected StaticcompensateGroupZ

StaticDIRECTIONS

Static ReadonlyFALL_SPEED

Static ReadonlyJUMP_SPEED

Static ReadonlyMOVE_SPEED

Static ReadonlySPIN_SPEED

Protected StatictempVector

Methods

ProtectedcreateBody

Parameters

Returns BaseBody

ProtectedcreateMesh

Parameters

Returns Object3D<Object3DEventMap>

ProtectedgetDirection

Returns Direction

ProtectedgetGear

Returns number

ProtectedgetProjection

Returns Vector3 | undefined

ProtectedgetRow

Parameters

Returns number

getWorldX

Returns number

getWorldY

Returns number

jump

Returns void

jumpEnd

Returns void

jumpStart

Returns Promise<void>

ProtectedonCollide

Returns void

Protectedspawn

Parameters

Returns void

update

Parameters

Returns void

ProtectedupdateAngle

Parameters

Returns void

ProtectedupdateAnimation

Parameters

Returns void

`Readonly`body

`Protected`centerOffset

`Protected`clickTimeout

`Protected`cols

`Protected`direction

`Protected`directionsToRows

`Protected`frame

`Protected`frameDuration

`Protected`invCols

`Protected`invRows

`Optional`level

`Protected`rows

`Protected`scaleX

`Protected`scaleY

`Protected`state

`Protected`totalFrames

`Protected`velocity

`Static` `Readonly`ANIM_SPEED

`Static` `Readonly`CLICK_DURATION

`Static` `Readonly`CLICK_PREVENT

`Protected` `Static`compensateGroupZ

`Static`DIRECTIONS

`Static` `Readonly`FALL_SPEED

`Static` `Readonly`JUMP_SPEED

`Static` `Readonly`MOVE_SPEED

`Static` `Readonly`SPIN_SPEED

`Protected` `Static`tempVector

`Protected`createBody

`Protected`createMesh

`Protected`getDirection

`Protected`getGear

`Protected`getProjection

`Protected`getRow

`Protected`onCollide

`Protected`spawn

`Protected`updateAngle

`Protected`updateAnimation

`Protected`updateFall

`Protected`updateMove

`Protected`updateTexture

`Static`create