Class Sprite

Hierarchy (View Summary)

Billboard
- Sprite
  - Player
  - NPC

Constructors

constructor

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

Properties

`Protected`_z

_z: number = 0

body

body: DynamicBody

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

state: SpriteState

`Protected`totalFrames

totalFrames: number

`Protected`velocity

velocity: number = 0

`Protected` `Static`compensateGroupZ

compensateGroupZ: number = 0.2

`Protected` `Static` `Readonly`GRAVITY

GRAVITY: 0.005

`Protected` `Static` `Readonly`JUMP_SPEED

JUMP_SPEED: 0.075

`Protected` `Static` `Readonly`MOVE_SPEED

MOVE_SPEED: 0.05

`Protected` `Static` `Readonly`ROTATE_SPEED

ROTATE_SPEED: 3

`Protected` `Static`tempVector

tempVector: Vector3 = ...

`Protected` `Static`tempVectorDivide

tempVectorDivide: Vector3 = ...

Accessors

z

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

Methods

`Protected`createBody

createBody(x: number, y: number): DynamicBody
Parameters
- x: number
- y: number
Returns DynamicBody
Overrides Billboard.createBody
- Defined in src/view/sprite.ts:143

`Protected`createMesh

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

`Protected`getDirection

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

`Protected`getFloorZ

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

getMouseGear

getMouseGear(): number
Returns number
- Defined in src/view/sprite.ts:52

`Protected`getRow

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

getScreenPosition

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

`Protected`handleFrameUpdate

handleFrameUpdate(ms: number, mouseGear: number): void
Parameters
- ms: number
- mouseGear: number
Returns void
- Defined in src/view/sprite.ts:75

`Protected`processMovement

processMovement(deltaTime: number, moveSpeed: number): void
Parameters
- deltaTime: number
- moveSpeed: number
Returns void
- Defined in src/view/sprite.ts:64

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

update

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

`Protected`updateAngle

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

`Protected`updateFrame

updateFrame(ms: number): void
Parameters
- ms: number
Returns void
- Defined in src/view/sprite.ts:117

`Protected`updateGroup

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

`Protected`updateTexture

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

`Protected`updateZ

updateZ(timeScale: number): void
Parameters
- timeScale: number
Returns void
- Defined in src/view/sprite.ts:81

`Static`create

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

Class Sprite

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Sprite

Properties

Protected_z

body

ProtectedcenterOffset

Protectedcols

Protecteddirection

ProtecteddirectionsToRows

Protectedframe

ProtectedframeDuration

ProtectedinvCols

ProtectedinvFrameDuration

ProtectedinvRows

Protected Optionallevel

mesh

Protectedrows

ProtectedscaleX

ProtectedscaleY

Protectedstate

ProtectedtotalFrames

Protectedvelocity

Protected StaticcompensateGroupZ

Protected Static ReadonlyGRAVITY

Protected Static ReadonlyJUMP_SPEED

Protected Static ReadonlyMOVE_SPEED

Protected Static ReadonlyROTATE_SPEED

Protected StatictempVector

Protected StatictempVectorDivide

Accessors

z

Returns number

Parameters

Returns void

Methods

ProtectedcreateBody

Parameters

Returns DynamicBody

ProtectedcreateMesh

Parameters

Returns Object3D<Object3DEventMap>

ProtectedgetDirection

Returns Direction

ProtectedgetFloorZ

Parameters

Returns number

getMouseGear

Returns number

ProtectedgetRow

Parameters

Returns number

getScreenPosition

Returns { x: number; y: number }

ProtectedhandleFrameUpdate

Parameters

Returns void

ProtectedprocessMovement

Parameters

Returns void

Protectedspawn

Parameters

Returns void

update

Parameters

Returns void

ProtectedupdateAngle

Parameters

Returns void

ProtectedupdateFrame

Parameters

Returns void

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

`Protected`totalFrames

`Protected`velocity

`Protected` `Static`compensateGroupZ

`Protected` `Static` `Readonly`GRAVITY

`Protected` `Static` `Readonly`JUMP_SPEED

`Protected` `Static` `Readonly`MOVE_SPEED

`Protected` `Static` `Readonly`ROTATE_SPEED

`Protected` `Static`tempVector

`Protected` `Static`tempVectorDivide

`Protected`createBody

`Protected`createMesh

`Protected`getDirection

`Protected`getFloorZ

`Protected`getRow

`Protected`handleFrameUpdate

`Protected`processMovement

`Protected`spawn

`Protected`updateAngle

`Protected`updateFrame

`Protected`updateGroup

`Protected`updateTexture

`Protected`updateZ

`Static`create