Gfx2SpriteJAS
[
Front page
] [
New
|
Page list
|
Search
|
Recent changes
|
Help
|
Log in
]
Start:
* Class: Gfx2SpriteJAS
A 2D sprite with animations.~
It emit 'E_FINISHED'~
- inherit from: Gfx2Drawable~
** Constructors
- ''new Gfx2SpriteJAS''(): Gfx2SpriteJAS~
** Methods
- ''clone''(jas: Gfx2SpriteJAS): Gfx2SpriteJAS~
Clone the object.~
-- ''jas'': The copy object.~
~
- ''getAnimations''()~
Returns the list of animation descriptors.~
~
- ''getBoundingRect''(dynamicMode: boolean): Gfx2Bounding...
Returns the bounding rect.~
-- ''dynamicMode'': Determines if bounding rect fit the c...
~
- ''getCurrentAnimation''()~
Returns the current animation or null if there is no curr...
~
- ''getCurrentAnimationFrameIndex''(): number~
Returns the current animation frame index.~
~
- ''getTexture''()~
Returns the sprite texture.~
~
- ''getWorldBoundingRect''(dynamicMode: boolean): Gfx2Bou...
Returns the bounding rect in the world space coordinates.~
-- ''dynamicMode'': Determines if bounding rect fit the c...
~
- ''loadFromFile''(path: string): Promise~
Loads asynchronously sprite data from a json file (jas).~
-- ''path'': The file path.~
~
- ''onRender''(): void~
The draw function.~
~
- ''play''(animationName: string, looped: boolean, preven...
Play a specific animation.~
-- ''animationName'': The name of the animation to be pla...
-- ''looped'': Determines whether the animation should lo...
-- ''preventSameAnimation'': Determines whether the same ...
~
- ''setAnimations''(animations: JASAnimation[]): void~
Set the animation descriptors.~
-- ''animations'': The animations data.~
~
- ''setOffsetNormalized''(offsetXFactor: number, offsetYF...
Set the normalized offset value.~
Note: this offset is independant from the regular drawabl...
-- ''offsetXFactor'': The normalized x-coordinate offset ...
-- ''offsetYFactor'': The normalized y-coordinate offset ...
~
- ''setTexture''(texture: ImageBitmap): void~
Set the sprite texture.~
-- ''texture'': The sprite texture.~
~
- ''update''(ts: number): void~
The update function.~
-- ''ts'': The timestep.~
End:
* Class: Gfx2SpriteJAS
A 2D sprite with animations.~
It emit 'E_FINISHED'~
- inherit from: Gfx2Drawable~
** Constructors
- ''new Gfx2SpriteJAS''(): Gfx2SpriteJAS~
** Methods
- ''clone''(jas: Gfx2SpriteJAS): Gfx2SpriteJAS~
Clone the object.~
-- ''jas'': The copy object.~
~
- ''getAnimations''()~
Returns the list of animation descriptors.~
~
- ''getBoundingRect''(dynamicMode: boolean): Gfx2Bounding...
Returns the bounding rect.~
-- ''dynamicMode'': Determines if bounding rect fit the c...
~
- ''getCurrentAnimation''()~
Returns the current animation or null if there is no curr...
~
- ''getCurrentAnimationFrameIndex''(): number~
Returns the current animation frame index.~
~
- ''getTexture''()~
Returns the sprite texture.~
~
- ''getWorldBoundingRect''(dynamicMode: boolean): Gfx2Bou...
Returns the bounding rect in the world space coordinates.~
-- ''dynamicMode'': Determines if bounding rect fit the c...
~
- ''loadFromFile''(path: string): Promise~
Loads asynchronously sprite data from a json file (jas).~
-- ''path'': The file path.~
~
- ''onRender''(): void~
The draw function.~
~
- ''play''(animationName: string, looped: boolean, preven...
Play a specific animation.~
-- ''animationName'': The name of the animation to be pla...
-- ''looped'': Determines whether the animation should lo...
-- ''preventSameAnimation'': Determines whether the same ...
~
- ''setAnimations''(animations: JASAnimation[]): void~
Set the animation descriptors.~
-- ''animations'': The animations data.~
~
- ''setOffsetNormalized''(offsetXFactor: number, offsetYF...
Set the normalized offset value.~
Note: this offset is independant from the regular drawabl...
-- ''offsetXFactor'': The normalized x-coordinate offset ...
-- ''offsetYFactor'': The normalized y-coordinate offset ...
~
- ''setTexture''(texture: ImageBitmap): void~
Set the sprite texture.~
-- ''texture'': The sprite texture.~
~
- ''update''(ts: number): void~
The update function.~
-- ''ts'': The timestep.~
Page: