View.Container.API

Class: Container

Container

A class for objects that are to be drawn on the canvas (or to contain drawn objects) All objects which are drawn on the game's canvas extends the View-class.

new Container(child1, child2, child3)

Constructor for the View class.

Parameters:

Name	Type	Description
child1	View.Child	A child to add to the view upon creation
child2	View.Child	An other child to add to the view upon creation
child3	View.Child	A third ...

Properties:

Name	Type	Description
children	View.Child[]	The view's children
parent	View.Container	The parent of the view or undefined if the view is an orphan
drawCacheEnabled	boolean	Whether or not draw caching is enabled

Source:

• View/Container.js , lineno 4

Extends

• View.Child

Members

drawCanvas

Remove drawCanvas function which was inherited from View

Source:

• View/Container.js , lineno 334

Methods

addChildren(child1, child2) → {View.Child[]}

Adds children to a View object. If the object that the children are added to, is a descendant of the current room, the children will be drawn on the stage when added. The added children will be drawn above the current children.

Parameters:

Name	Type	Description
child1	View.Child	A child to add to the View object
child2	View.Child	Another child to add...

Source:

• View/Container.js , lineno 40

Returns:

An array containing the added children

Type

View.Child[]

applyToThisAndChildren(func)

Executes a function for the View and all of the its children.

Parameters:

Name	Type	Description
func	function	Function to execute

Source:

• View/Container.js , lineno 170

ChildInitWithoutRedrawRegions()()

Inherited From:

• View.Child#ChildInitWithoutRedrawRegions

Source:

• View/Child.js , lineno 20

draw(c, area, forceRedraw)

Draws all children and grandchildren of an object that inherits the View class. It is usually not necessary to call this function since it is automatically called by the engine's redraw loop.

Parameters:

Name	Type	Description
c	CanvasRenderingContext2D	A canvas' 2d context to draw the children on
area	Math.Rectangle	A rectangle specifying the area to draw
forceRedraw	boolean	Whether or not to force a redraw even though draw caching is enabled (this option is actually used when caching the view)

Source:

• View/Container.js , lineno 274

getChildren() → {View.Child[]}

Fetches an array of all the View's children. This will not return a pointer, so changing the returned array will not change the View's children.

Source:

• View/Container.js , lineno 116

Returns:

Array containing all of the View's children

Type

View.Child[]

getCombinedRedrawRegion() → {Math.Rectangle}

Gets the complete region that will used for drawing on next redraw

Source:

• View/Container.js , lineno 190

Returns:

A rectangle representing the region

Type

Math.Rectangle

getDirectionTo(child) → {number}(child) → {number}

Calculates the direction to another child

Parameters:

Name	Type	Description
child	View.Child	The object to calculate the direction to

Inherited From:

• View.Child#getDirectionTo

Source:

• View/Child.js , lineno 308

Returns:

The direction in radians

Type

number

getDistanceTo(child) → {number}(child) → {number}

Calculates the distance to another child (the distance between the object's positions)

Parameters:

Name	Type	Description
child	View.Child	The object to calculate the distance to

Inherited From:

• View.Child#getDistanceTo

Source:

• View/Child.js , lineno 299

Returns:

The distance in pixels

Type

number

getParents() → {View.Container[]}() → {View.Container[]}

Creates and returns and array of all the child's parents (from closest to farthest)

Inherited From:

• View.Child#getParents

Source:

• View/Child.js , lineno 253

Returns:

A list of all the child's parents

Type

View.Container[]

getRoom() → {View.Room|Boolean}() → {View.Room|Boolean}

Finds the room to which the object is currently added

Inherited From:

• View.Child#getRoom

Source:

• View/Child.js , lineno 270

Returns:

The room to which the object is currently added, or false if the object is not added to a room

Type

View.Room | Boolean

getRoomPosition() → {Math.Vector|Boolean}() → {Math.Vector|Boolean}

Fetches the position of the child inside the room

Inherited From:

• View.Child#getRoomPosition

Source:

• View/Child.js , lineno 225

Returns:

The objects position in its room, or false if the object is not placed in any room.

Type

Math.Vector | Boolean

insertBelow(insertChildren, child) → {View.Child[]}

Adds a child to a View object, below an already added child. This means that the inserted child (or children) will be drawn below the child which they are inserted below.

Parameters:

Name	Type	Description
insertChildren	View.Child | Array.<View.Child>	Child or array of children to insert before an existing child
child	View.Child	Current child to insert other children before

Source:

• View/Container.js , lineno 74

Returns:

Array of the inserted children

Type

View.Child[]

isDrawn() → {Boolean}() → {Boolean}

Checks if the child object is in a state where it will get drawn. For this function to return true, the child object has to be both visible and placed in a visible room.

Inherited From:

• View.Child#isDrawn

Source:

• View/Child.js , lineno 216

Returns:

Whether or not the child object is in a state where it will get drawn

Type

Boolean

isInVisibleRoom() → {Boolean}() → {Boolean}

Checks if the child object is inside a room that is currently visible

Inherited From:

• View.Child#isInVisibleRoom

Source:

• View/Child.js , lineno 202

Returns:

Whether or not the child object is currently in a visible room

Type

Boolean

isVisible() → {boolean}() → {boolean}

Checks if the objects is visible. This function runs before each draw to ensure that it is necessary

Inherited From:

• View.Child#isVisible

Source:

• View/Child.js , lineno 316

Returns:

Whether or not the object is visible (based on its size and opacity vars)

Type

boolean

moveTo(x, y)(x, y)

Sets the position of the object relative to its parent

Parameters:

Name	Type	Description
x	number	The horisontal position
y	number	The vertical position

Inherited From:

• View.Child#moveTo

Source:

• View/Child.js , lineno 289

parseOffsetGlobal(offset) → {Math.Vector}(offset) → {Math.Vector}

Parses an offset global into an actual Math.Vector offset (this function is only here for convenience and should be replaced by any class that inherits the child class)

Parameters:

Name	Type	Description
offset	number	Offset global (OFFSET_TOP_LEFT, etc.)

Inherited From:

• View.Child#parseOffsetGlobal

Source:

• View/Child.js , lineno 193

Returns:

A parsed version of the offset global

Type

Math.Vector

removeAllChildren(purge)

Removes all children from the View.

Parameters:

Name	Type	Description
purge	boolean	Whether or not to purge the removed children, meaning that their scheduled functions and loop-attached functions will be removed. (true by default)

Source:

• View/Container.js , lineno 253

removeChildren(child1, child2) → {View.Child[]}

Removes one or more children from the View.

Parameters:

Name	Type	Description
child1	View.Child	A child to add to the View object
child2	View.Child	Another child to remove...

Source:

• View/Container.js , lineno 229

Returns:

An array of the children which was removed. If an object, which was supplied as argument, was not a child of the View, it will not appear in the returned array

Type

View.Child[]

setTheme(themeName, recursive)

Sets theme of an View. Children whose theme is not already set, will inherit the set theme. To enforce the theme to all children, use the recursive argument.

Parameters:

Name	Type	Argument	Default	Description
themeName	string			The name of the theme to apply as the object's theme
recursive	boolean	<optional>	false	Whether or not the set theme will be applied to children for which a theme has already been set. If this argument is unset, it will default to false

Source:

• View/Container.js , lineno 134

Generated with wicked.