Class Sprite

Hierarchy

Asset
- Sprite

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Sprite(): Sprite

Inherited from UniqueObject.constructor
- Defined in src/core/UniqueObject.ts:16
Returns Sprite

Properties

borderMode

borderMode: SpriteRenderMode = SpriteRenderMode.Stretch

borderSize

borderSize: Vector2 = new Vector2()

deleted

deleted: AsyncEvent<string> = new AsyncEvent<string>()

id

id: string

isPersistent

isPersistent: boolean = false

name

name: string

renderMode

renderMode: SpriteRenderMode = SpriteRenderMode.Stretch

Optional templatePath

templatePath: undefined | string

texture

texture: AssetReference<Texture2D> = new AssetReference(Texture2D)

Methods

copy

copy(): UniqueObject

Inherited from UniqueObject.copy

Overrides SerializableObject.copy
- Defined in src/core/UniqueObject.ts:24
Returns UniqueObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Overrides Asset.destroy
- Defined in src/ui/Sprite.ts:25
Returns void

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Overrides Asset.isLoaded
- Defined in src/ui/Sprite.ts:30
Returns boolean

save

save(folderPath?: undefined | string): void

Inherited from Asset.save
- Defined in src/assets/Asset.ts:33
Parameters
- Optional folderPath: undefined | string
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

tesselateInPixelsUnits

tesselateInPixelsUnits(vb: VertexBuffer, offsetX: number, offsetY: number, width: number, height: number): void

- Defined in src/ui/Sprite.ts:34
Parameters
- vb: VertexBuffer
- offsetX: number
- offsetY: number
- width: number
- height: number
Returns void

tesselateInWorldUnits

tesselateInWorldUnits(vb: VertexBuffer): void

- Defined in src/ui/Sprite.ts:51
Parameters
- vb: VertexBuffer
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Inherited from SerializableObject.upgrade
- Defined in src/core/SerializableObject.ts:50
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject