Class AnimationElement

Hierarchy

RenderElement
- AnimationElement

Index

Constructors

constructor

new AnimationElement(): AnimationElement
Returns AnimationElement
Overrides RenderElement.constructor
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:660

Properties

`Private` _anim

_anim: string = ""

_children

_children: RenderElement[]

`Private` _loopCount

_loopCount: number = 0

`Private` _noLoop

_noLoop: boolean = true

animSpeed

animSpeed: number = 1

animTime

animTime: number = 0

color1

color1: Color = ...

TOP-LEFT

color2

color2: Color = ...

BOTTOM-LEFT

color3

color3: Color = ...

TOP-RIGHT

color4

color4: Color = ...

BOTTOM-RIGHT

frame

frame: SpriteSheetFrame

name

name: string = ""

`Private` player

player: FrameAnimationPlayer

regX

regX: number = 0

regY

regY: number = 0

visible

visible: boolean = true

Accessors

animation

get animation(): string
Returns string
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:669

blendMode

get blendMode(): BlendMode
Returns BlendMode
Inherited from RenderElement.blendMode
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:118
set blendMode(value: BlendMode): void
Parameters
- value: BlendMode
Returns void
Inherited from RenderElement.blendMode
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:114

height

get height(): number
Returns number
Inherited from RenderElement.height
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:69
set height(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.height
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:157

isLastFrame

get isLastFrame(): boolean
True if the last frame we rendered was the "last" in the animation

Returns boolean
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:712

loopCount

get loopCount(): number
Returns number
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:664

matrix

get matrix(): AffineMatrix
Returns a matrix representing x,y,rotation, scale.

It is also possible to have a manual matrix which ignores those values.

Returns AffineMatrix
Inherited from RenderElement.matrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:182
set matrix(v: AffineMatrix): void
Setting a matrix will disable the usage of: x, y, scaleX, etc. and instead the given matrix will be used.

To get back to the usage of the standard behavior use useStandardMatrix().
Parameters
- v: AffineMatrix
Returns void
Inherited from RenderElement.matrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:206

numChildren

get numChildren(): number
Returns number
Inherited from RenderElement.numChildren
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:279

parent

get parent(): RenderElement
Returns RenderElement
Inherited from RenderElement.parent
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:220

rotation

get rotation(): number
Returns number
Inherited from RenderElement.rotation
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:81
set rotation(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.rotation
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:130

scale

get scale(): number
Returns number
Inherited from RenderElement.scale
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:150
set scale(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.scale
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:143

scaleX

get scaleX(): number
Returns number
Inherited from RenderElement.scaleX
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:84
set scaleX(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.scaleX
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:134

scaleY

get scaleY(): number
Returns number
Inherited from RenderElement.scaleY
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:87
set scaleY(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.scaleY
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:138

width

get width(): number
Returns number
Inherited from RenderElement.width
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:72
set width(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.width
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:154

worldMatrix

get worldMatrix(): AffineMatrix
Creates a full world matrix meaning all parent matrices.

This is not cached. Use with care.

Returns AffineMatrix
Inherited from RenderElement.worldMatrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:166

x

get x(): number
Returns number
Inherited from RenderElement.x
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:75
set x(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.x
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:122

y

get y(): number
Returns number
Inherited from RenderElement.y
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:78
set y(v: number): void
Parameters
- v: number
Returns void
Inherited from RenderElement.y
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:126

Methods

setHorizontalFade

setHorizontalFade(r1: number, g1: number, b1: number, a1: number, r2: number, g2: number, b2: number, a2: number): void
<-------------> ^ ^ | (r2,g2,b2,a2) (r1,g1,b1,a1)
Parameters
- r1: number
- g1: number
- b1: number
- a1: number
- r2: number
- g2: number
- b2: number
- a2: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:763

setSolidColor

setSolidColor(r: number, g: number, b: number, a: number): void
Parameters
- r: number
- g: number
- b: number
- a: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:733

setVerticalFade

setVerticalFade(r1: number, g1: number, b1: number, a1: number, r2: number, g2: number, b2: number, a2: number): void
^ <-- (r1,g1,b1,a1) | | | | | v <-- (r2,g2,b2,a2)
Parameters
- r1: number
- g1: number
- b1: number
- a1: number
- r2: number
- g2: number
- b2: number
- a2: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:796

sortChildren

sortChildren(sorter: ((a: RenderElement, b: RenderElement) => number)): void
Parameters
- sorter: ((a: RenderElement, b: RenderElement) => number)
  - - (a: RenderElement, b: RenderElement): number
    - Parameters
      
      a: RenderElement
      
      b: RenderElement
      
      Returns number
Returns void
Inherited from RenderElement.sortChildren
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:283

update

update(elapsed: number): void
Parameters
- elapsed: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:702

useStandardMatrix

useStandardMatrix(): void
Switch back from manual mode to standard mode.

Returns void
Inherited from RenderElement.useStandardMatrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:214

Class AnimationElement

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AnimationElement

Properties

Private _anim

_children

Private _loopCount

Private _noLoop

animSpeed

animTime

color1

color2

color3

color4

frame

name

Private player

regX

regY

visible

Accessors

animation

Returns string

blendMode

Returns BlendMode

Parameters

value: BlendMode

Returns void

height

Returns number

Parameters

v: number

Returns void

isLastFrame

Returns boolean

loopCount

Returns number

matrix

Returns AffineMatrix

Parameters

v: AffineMatrix

Returns void

numChildren

Returns number

parent

Returns RenderElement

rotation

Returns number

Parameters

v: number

Returns void

scale

Returns number

Parameters

v: number

Returns void

scaleX

Returns number

Parameters

v: number

Returns void

scaleY

Returns number

Parameters

v: number

Returns void

width

Returns number

Parameters

v: number

Returns void

worldMatrix

Returns AffineMatrix

`Private` _anim

`Private` _loopCount

`Private` _noLoop

`Private` player