Class TextureAtlas

Hierarchy

TextureBase<"image">
- TextureAtlas

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TextureAtlas(textureKey: string, jsonKey: string, w: number, h: number, game: Game, scene: Scene): TextureAtlas

Overrides TextureBase.constructor
- Defined in core/texture/textureAtlas.ts:16
Parameters
- textureKey: string
- jsonKey: string
- w: number
- h: number
- game: Game
- scene: Scene
Returns TextureAtlas

Properties

Readonly dataType

dataType: DataType

memberof: TextureBase
description: The data type of texture, 'sheet' | 'base' | 'atlas' | 'list'
since: 2.1.0

game

game: Game

Readonly id

id: string

memberof: TextureBase
description: The unique identifier for the texture
since: 2.1.0

json

json: JSONSchema

scale

scale: Vector2

memberof: Texture
description: The scale of the texture
since: 2.1.0

scene

scene: Scene

texture

texture: HTMLImageElement

memberof: TextureBase
description: The texture itself, can be an image or color
since: 2.1.0

type

type: Duck.Types.Texture.Type

memberof: TextureBase
description: The type of texture source, 'image' | 'color' | 'either'
since: 2.1.0

Methods

get

get(key: string): undefined | Texture<"image">

- Defined in core/texture/textureAtlas.ts:104
Parameters
- key: string
Returns undefined | Texture<"image">

Protected parseJSON

parseJSON(): void

- Defined in core/texture/textureAtlas.ts:72
Returns void

setFillColor

setFillColor(color: string | number): void

Inherited from TextureBase.setFillColor
- Defined in core/texture/textureBase.ts:169
memberof
Texture

description
Sets the Texture color if the type is color

since
2.1.0

Parameters
- color: string | number
  
  New color of the texture
Returns void

setImagePath

setImagePath(imagePath: string): void

Inherited from TextureBase.setImagePath
- Defined in core/texture/textureBase.ts:157
memberof
Texture

description
Sets the Texture Image Path if the type is image

since
2.1.0

Parameters
- imagePath: string
  
  New imagePath of the texture
Returns void

setScale

setScale(scale: Scale): Vector2

Inherited from TextureBase.setScale
- Defined in core/texture/textureBase.ts:140
memberof
Texture

description
Sets the Texture Scale

since
2.1.0

Parameters
- scale: Scale
  
  New scale of the texture
Returns Vector2

Protected validateJSON

validateJSON(): void

- Defined in core/texture/textureAtlas.ts:41
Returns void

Static fromColor

fromColor(color: string, w: number, h: number): TextureBase<"color">

Inherited from TextureBase.fromColor
- Defined in core/texture/textureBase.ts:185
memberof
TextureBase

description
Creates a new TextureBase instance from a color

static
since
2.1.0

Parameters
- color: string
  
  Color
- w: number
  
  Width
- h: number
  
  Height
Returns TextureBase<"color">

Static fromEither

fromEither(fillColorOrIMGPath: string, w: number, h: number): TextureBase<"either">

Inherited from TextureBase.fromEither
- Defined in core/texture/textureBase.ts:216
memberof
TextureBase

description
Creates a new TextureBase instance from a color or an image path

static
since
2.1.0

Parameters
- fillColorOrIMGPath: string
  
  Color or Image path
- w: number
  
  Width
- h: number
  
  Height
Returns TextureBase<"either">

Static fromTexture

fromTexture(imgpath: string, w: number, h: number): TextureBase<"image">

Inherited from TextureBase.fromTexture
- Defined in core/texture/textureBase.ts:199
memberof
TextureBase

description
Creates a new TextureBase instance from an image path

static
since
2.1.0

Parameters
- imgpath: string
  
  Image path
- w: number
  
  Width
- h: number
  
  Height
Returns TextureBase<"image">

Generated using TypeDoc