Assets.SquareTile

Description: Defines a SquareTile that is used by the SquareTileMap. Represents one tile within the tile map.

Extends: Graphics.Sprite2d

Constructors

SquareTile (image, width, height)
Creates a new instance of the SquareTile object.

image: Graphics.ImageSource
The image that is within the tile.

width: number
The width of the tile.

height: number
The height of the tile.

Fields

Inherited from: Graphics.Sprite2d

ZIndex: number
Gets or sets the ZIndex of the Graphic2d. The ZIndex is used to control draw order. Higher ZIndexes appear above lower ZIndexed graphics.

Visible: boolean
Gets or sets the Visible property. The Visible property determines whether the renderable will be drawn to the game screen.

Position: EndGate.Vector2d
Gets or sets the Position of the Graphic2d. The Position determines where the graphic will be drawn on the screen.

Rotation: number
Gets or sets the Rotation of the Graphic2d..

Parent: Graphic2d
Gets the parent of the Graphic2d. Value is null if no parent exists.

AbsolutePosition: EndGate.Vector2d
Gets the absolute position of the Graphic2d. This is used to calculate absolute positions when graphic's have parents.

OnDisposed: EndGate.EventHandler1 <Graphic2d>
Gets an event that is triggered when the Graphic2d has been disposed. Functions can be bound or unbound to this event to be executed when the event triggers.

Opacity: number
Gets or sets the current opacity. Value is between 0 and 1.

Image: Graphics.ImageSource
Gets or sets the Image that is drawn to the game screen.

Size: EndGate.Size2d
Gets or sets the size of the Sprite2d. If the Size is not equal to the image's ClipSize the Sprite2d will appear stretched.

Methods

Inherited from: Graphics.Sprite2d

GetChildren()
Returns the list of children for the current Graphic2d.

AddChild()
Adds a child to the Graphic2d. Children are drawn with relative positions to the parent Graphic2d. Children of a Graphic2d should not be added to the Scene, parent Graphic2d's are responsible for drawing their children.

RemoveChild()
Removes a child from the Graphic2d. Returns a Boolean value indicating whether or not the child was able to be removed.

Draw()
Abstract: Should be overridden to draw the derived class onto the context. If this graphic is part of a scene the Draw function will be called automatically.

GetDrawBounds()
Abstract: Should be overridden to return the bounding area that represents where the graphic will draw.

Scale()
Abstract: Should be overridden to scale the size of the Graphic2d.

Clone()
Abstract: Returns a nearly identical copy of this Graphic2d. If this Graphic2d belongs to a parent, the cloned Graphic2d will not. If this Graphic2d has children, all children will be cloned as well. Lastly, the cloned Graphic2d will not have the same event bindings as this one does.

Dispose()
Triggers the OnDisposed event. If this Graphic2d is used with a Scene2d it will be removed from the scene when disposed.

Draw()
Draws the sprite onto the given context. If this sprite is part of a scene the Draw function will be called automatically.

GetDrawBounds()
The bounding area that represents where the Sprite2d will draw.

Scale()
Scale's the Sprite2d graphic.

Clone()
Returns a nearly identical copy of this Sprite2d. If this Sprite2d belongs to a parent, the cloned Sprite2d will not. If this Sprite2d has children, all children will be cloned as well. Lastly, the cloned Sprite2d will not have the same event bindings as this one does.

Examples

There's currently no example available for this page. If you'd like to suggest one send me an containing a description, code, and link to the page for the suggested example. As a thanks I'll associate the code snippet with your name directly below the example if approved.