TiledSprite

A Graphic is the base Excalibur primitive for something that can be drawn to the ExcaliburGraphicsContext. Sprite, Animation, GraphicsGroup, Canvas, Rectangle, Circle, and Polygon all derive from the Graphic abstract class.

Implementors of a Graphic must override the abstract Graphic._drawImage method to render an image to the graphics context. Graphic handles all the position, rotation, and scale transformations in Graphic._preDraw and Graphic._postDraw

Hierarchy

• Sprite
  • TiledSprite

Index

Constructors

• constructor

Properties

• destSize
• id
• image
• opacity
• ready
• showDebug
• sourceView
• tint
• transform

Accessors

• flipHorizontal
• flipVertical
• height
• localBounds
• origin
• rotation
• scale
• width

Methods

• _drawImage
• clone
• cloneGraphicOptions
• draw
• isStale
• from
• fromSprite

Constructors

constructor

• TiledSprite(options: TiledSpriteOptions & GraphicOptions): TiledSprite

• Overrides Sprite.constructor

  Parameters

  • options: TiledSpriteOptions & GraphicOptions

  Returns TiledSprite

Properties

publicinheriteddestSize

destSize: DestinationSize

Inherited from Sprite.destSize

readonlyinheritedid

id: number = ...

Inherited from Sprite.id

publicinheritedimage

image: ImageSource

Inherited from Sprite.image

publicinheritedopacity

opacity: number = 1

Inherited from Sprite.opacity

Gets or sets the opacity of the graphic, 0 is transparent, 1 is solid (opaque).

publicready

ready: Promise<void> = ...

publicinheritedshowDebug

showDebug: boolean = false

Inherited from Sprite.showDebug

Gets or sets wether to show debug information about the graphic

publicinheritedsourceView

sourceView: SourceView

Inherited from Sprite.sourceView

publicoptionalinheritedtint

tint?: Color

Inherited from Sprite.tint

publicinheritedtransform

transform: AffineMatrix = ...

Inherited from Sprite.transform

Accessors

publicinheritedflipHorizontal

• get flipHorizontal(): boolean
• set flipHorizontal(value: boolean): void

• Inherited from Sprite.flipHorizontal

  Gets or sets the flipHorizontal, which will flip the graphic horizontally (across the y axis)

  ---

  Returns boolean

• Inherited from Sprite.flipHorizontal

  Parameters

  • value: boolean

  Returns void

publicinheritedflipVertical

• get flipVertical(): boolean
• set flipVertical(value: boolean): void

• Inherited from Sprite.flipVertical

  Gets or sets the flipVertical, which will flip the graphic vertically (across the x axis)

  ---

  Returns boolean

• Inherited from Sprite.flipVertical

  Parameters

  • value: boolean

  Returns void

publicinheritedheight

• get height(): number
• set height(newHeight: number): void

• Inherited from Sprite.height

  Gets or sets the height of the graphic (always positive)

  ---

  Returns number

• Inherited from Sprite.height

  Gets or sets the height of the graphic (always positive)

  ---

  Parameters

  • newHeight: number

  Returns void

publicinheritedlocalBounds

• get localBounds(): BoundingBox

• Inherited from Sprite.localBounds

  Gets a copy of the bounds in pixels occupied by the graphic on the the screen. This includes scale.

  ---

  Returns BoundingBox

publicinheritedorigin

• get origin(): Vector | undefined
• set origin(value: Vector | undefined): void

• Inherited from Sprite.origin

  Gets or sets the origin of the graphic, if not set the center of the graphic is the origin

  ---

  Returns Vector | undefined

• Inherited from Sprite.origin

  Parameters

  • value: Vector | undefined

  Returns void

publicinheritedrotation

• get rotation(): number
• set rotation(value: number): void

• Inherited from Sprite.rotation

  Gets or sets the rotation of the graphic

  ---

  Returns number

• Inherited from Sprite.rotation

  Parameters

  • value: number

  Returns void

publicinheritedscale

• get scale(): Vector
• set scale(value: Vector): void

• Inherited from Sprite.scale

  Gets or sets the scale of the graphic, this affects the width and

  ---

  Returns Vector

• Inherited from Sprite.scale

  Parameters

  • value: Vector

  Returns void

publicinheritedwidth

• get width(): number
• set width(newWidth: number): void

• Inherited from Sprite.width

  Gets or sets the width of the graphic (always positive)

  ---

  Returns number

• Inherited from Sprite.width

  Gets or sets the width of the graphic (always positive)

  ---

  Parameters

  • newWidth: number

  Returns void

Methods

publicinherited_drawImage

• _drawImage(ex: ExcaliburGraphicsContext, x: number, y: number): void

• Inherited from Sprite._drawImage

  Meant to be overridden by the graphic implementation to draw the underlying image (HTMLCanvasElement or HTMLImageElement) to the graphics context without transform. Transformations like position, rotation, and scale are handled by Graphic._preDraw and Graphic._postDraw

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

    The excalibur graphics context

  • x: number

  • y: number

  Returns void

publicinheritedclone

• clone(): Sprite

• Inherited from Sprite.clone

  Returns a new instance of the graphic that has the same properties

  ---

  Returns Sprite

publicinheritedcloneGraphicOptions

• cloneGraphicOptions(): GraphicOptions

• Inherited from Sprite.cloneGraphicOptions

  Returns GraphicOptions

publicinheriteddraw

• draw(ex: ExcaliburGraphicsContext, x: number, y: number): void

• Inherited from Sprite.draw

  Draw the whole graphic to the context including transform

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

    The excalibur graphics context

  • x: number

  • y: number

  Returns void

publicinheritedisStale

• isStale(): boolean

• Inherited from Sprite.isStale

  Returns boolean

publicstaticinheritedfrom

• from(image: ImageSource, options?: Omit<GraphicOptions & SpriteOptions, image>): Sprite

• Inherited from Sprite.from

  Parameters

  • image: ImageSource

  • optionaloptions: Omit<GraphicOptions & SpriteOptions, image>

  Returns Sprite

publicstaticfromSprite

• fromSprite(sprite: Sprite, options?: Partial<Omit<TiledSpriteOptions & GraphicOptions, image>>): TiledSprite

• Parameters

  • sprite: Sprite

  • optionaloptions: Partial<Omit<TiledSpriteOptions & GraphicOptions, image>>

  Returns TiledSprite