API Docs for: 1.4.0
Show:

Kiwi.Group Class

Defined in: src\core\Group.ts:9
Module: Kiwi

The group class is central to creating the scene graph that contains all objects in a state. A group can contain entities or other groups, thereby enabling a nested tree scene graph. The members of the Group's coordinates are also in relation to the Group that they were added to. So if you moved an entire Group, each member of that Group would also 'move'.

Constructor

Kiwi.Group

(
  • state
  • [name='']
)
Kiwi.Group

Defined in src\core\Group.ts:9

Parameters:

  • state Kiwi.State

    The State that this Group is a part of.

  • [name=''] String optional

    The name of this group.

Returns:

Kiwi.Group:

Methods

addChild

(
  • child
)
Object public

Defined in src\core\Group.ts:391

Adds an Entity to this Group. The Entity must not already be in this Group.

Parameters:

  • child Object

    The child to be added.

Returns:

Object:

The child that was added.

addChildAfter

(
  • child
  • beforeChild
)
Object public

Defined in src\core\Group.ts:460

Adds an Entity to this Group after another child.

Parameters:

  • child Object

    The child to be added.

  • beforeChild Object

    The child after which the child will be added.

Returns:

Object:

The child.

addChildAt

(
  • child
  • index
)
Object public

Defined in src\core\Group.ts:416

Adds an Entity to this Group in the specific location. The Entity must not already be in this Group and it must be supported by the Group.

Parameters:

  • child Object

    The child to be added.

  • index Number

    The index the child will be set at.

Returns:

Object:

The child.

addChildBefore

(
  • child
  • beforeChild
)
Object public

Defined in src\core\Group.ts:436

Adds an Entity to this Group before another child.

Parameters:

  • child Object

    The child to be added.

  • beforeChild Entity

    The child before which the child will be added.

Returns:

Object:

The child.

addTag

(
  • tag
)
public

Defined in src\core\Group.ts:1260

Available since 1.1.0

Adds a new Tag to this Entity. Useful for identifying large amounts of the same type of GameObjects. You can pass multiple strings to add multiple tags.

Parameters:

  • tag String

    The tag that you would like to add to this Entity.

callAll

(
  • componentName
  • functionName
  • args
)
public

Defined in src\core\Group.ts:1034

Calls a function on every member. If componentName is null the function is called on the entity itself, otherwise it is called on the named component. Uses runtime string property lookups. Not optimal for large groups if speed is an issue.

Parameters:

  • componentName String

    The name of the component to call the function on - set to null to call a function on the entity.

  • functionName String

    The name of the function to call.

  • args Array

    An array of arguments to pas to the function.

clear

() public

Defined in src\core\Group.ts:1182

Clear all children from this Group

contains

(
  • child
)
Boolean public

Defined in src\core\Group.ts:339

Checks if the given entity is in this group

Parameters:

  • child IChild

    The IChild that you want to checked.

Returns:

Boolean:

true if entity exists in group.

containsAncestor

(
  • descendant
  • ancestor
)
Boolean public

Defined in src\core\Group.ts:367

Checks to see if one child is an ansector of another child.

Parameters:

  • descendant Object

    The object that you are checking.

  • ancestor Group

    The parent (ancestor) that you are checking for.

Returns:

Boolean:

containsDescendant

(
  • child
)
Boolean public

Defined in src\core\Group.ts:350

Checks to see if the given object is contained in this group as a descendant

Parameters:

  • child Object

    The IChild that you want to check.

Returns:

Boolean:

countDead

() Number public

Defined in src\core\Group.ts:1162

Returns the number of member which are not marked as 'alive'

Returns:

Number:

countLiving

() Number public

Defined in src\core\Group.ts:1142

Returns the number of member which are marked as 'alive'

Returns:

Number:

destroy

(
  • [immediate=false]
  • [destroyChildren=true]
)
public

Defined in src\core\Group.ts:1316

Removes all children and destroys the Group.

Parameters:

  • [immediate=false] Boolean optional

    If the object should be immediately removed or if it should be removed at the end of the next update loop.

  • [destroyChildren=true] Boolean optional

    If all of the children on the group should also have their destroy methods called.

forEach

(
  • context
  • callback
  • [params]
)
public

Defined in src\core\Group.ts:978

Loops through each member in the group and run a method on for each one.

Parameters:

  • context Any

    The context that the callbacks are to have when called.

  • callback Any

    The callback method to execute on each member.

  • [params] Any optional multiple

    Any extra parameters.

forEachAlive

(
  • context
  • callback
  • [params]
)
public

Defined in src\core\Group.ts:994

Loop through each member of the groups that is alive.

Parameters:

  • context Any

    The context that the callbacks are to have when called.

  • callback Any

    The callback method to execute on each member.

  • [params] Any optional multiple

    Any extra parameters.

getAllChildren

(
  • getGroups
  • destinationArray
)
Array

Defined in src\core\Group.ts:585

Available since 1.1.0

Get all children of this Group. By default, this will search the entire sub-graph, including children of children etc.

Parameters:

  • getGroups Boolean

    Optional: Whether to include Groups in the results. When false, will only collect GameObjects.

  • destinationArray Array

    Optional: The array in which to store the results.

Returns:

Array:

getChildAt

(
  • index
)
Object public

Defined in src\core\Group.ts:609

Get the child at a specific position in this Group by its index.

Parameters:

  • index Number

    The index of the child

Returns:

Object:

The child, if found or null if not.

getChildByID

(
  • id
  • recurse
)
Object public

Defined in src\core\Group.ts:651

Get a child from this Group by its UUID. By default this will not check sub-groups, but if you supply the correct flag it will check the entire scene graph under this object.

Parameters:

  • id String

    The ID of the child.

  • recurse Boolean

    Whether to search child groups for the child. Default FALSE.

Returns:

Object:

The child, if found or null if not.

getChildByName

(
  • name
  • recurse
)
Object public

Defined in src\core\Group.ts:626

Get a child from this Group by its name. By default this will not check sub-groups, but if you supply the correct flag it will check the entire scene graph under this object.

Parameters:

  • name String

    The name of the child.

  • recurse Boolean

    Whether to search child groups for the child. Default FALSE.

Returns:

Object:

The child, if found or null if not.

getChildIndex

(
  • child
)
Number public

Defined in src\core\Group.ts:676

Returns the index position of the Entity or -1 if not found.

Parameters:

  • child Object

    The child.

Returns:

Number:

The index of the child or -1 if not found.

getChildrenByTag

(
  • tag
)
Array public

Defined in src\core\Group.ts:776

Available since 1.1.0

Returns an array of children which contain the tag which is passed.

Parameters:

  • tag String

Returns:

Array:

getFirstAlive

() Object deprecated public

Defined in src\core\Group.ts:689

Deprecated: in v1.1.0

Returns the first Entity from this Group marked as 'alive' or null if no members are alive

Returns:

Object:

getFirstChildByTag

(
  • tag
)
IChild public

Defined in src\core\Group.ts:803

Available since 1.3.0

Returns the first child which contains the tag passed.

Parameters:

  • tag String

Returns:

IChild:

getFirstDead

() Object deprecated public

Defined in src\core\Group.ts:707

Deprecated: in v1.1.0

Returns the first member of the Group which is not 'alive', returns null if all members are alive.

Returns:

Object:

getLastChildByTag

(
  • tag
)
IChild public

Defined in src\core\Group.ts:832

Available since 1.3.0

Returns the last child which contains the tag passed.

Parameters:

  • tag String

Returns:

IChild:

hasTag

(
  • tag
)
Boolean public

Defined in src\core\Group.ts:1295

Available since 1.1.0

Checks to see if this Entity has a Tag based upon a string which you pass.

Parameters:

  • tag String

Returns:

Boolean:

numChildren

() Number public

Defined in src\core\Group.ts:302

Returns the total number of children in this Group. Doesn't distinguish between alive and dead children.

Returns:

Number:

The number of children in this Group

objType

() String public

Defined in src\core\Group.ts:45

Returns the type of this object

Returns:

String:

"Group"

removeChild

(
  • child
  • [destroy=false]
)
Object public

Defined in src\core\Group.ts:492

Removes an Entity from this Group if it is a child of it.

Parameters:

  • child Object

    The child to be removed.

  • [destroy=false] Boolean optional

    If the entity that gets removed should be destroyed as well.

Returns:

Object:

The child.

removeChildAt

(
  • index
)
Object

Defined in src\core\Group.ts:520

Removes the Entity from this Group at the given position.

Parameters:

  • index Number

    The index of the child to be removed.

Returns:

Object:

The child, or null.

removeChildren

(
  • begin
  • end
  • destroy
)
Number public

Defined in src\core\Group.ts:538

Removes all Entities from this Group within the given range.

Parameters:

  • begin Number

    The begining index.

  • end Number

    The last index of the range.

  • destroy Number

    If the children should be destroyed as well.

Returns:

Number:

The number of removed entities.

removeFirstAlive

(
  • [destroy=false]
)
Object deprecated public

Defined in src\core\Group.ts:564

Deprecated: in v1.1.0

Removes the first Entity from this Group marked as 'alive'

Parameters:

  • [destroy=false] Boolean optional

    If the entity should run the destroy method when it is removed.

Returns:

Object:

The Entity that was removed from this Group if alive, otherwise null

removeTag

(
  • tag
)
public

Defined in src\core\Group.ts:1279

Available since 1.1.0

Removes a Tag from this Entity.

Parameters:

  • tag String

    The tag that you would like to remove from this Entity.

render

(
  • camera
)
deprecated public

Defined in src\core\Group.ts:1130

The render method that is required by the IChild. This method never gets called as the render is only worried about rendering entities.

Parameters:

replaceChild

(
  • oldChild
  • newChild
)
Boolean public

Defined in src\core\Group.ts:945

Replaces a child Entity in this Group with a new one.

Parameters:

  • oldChild Object

    The Entity in this Group to be removed.

  • newChild Object

    The new Entity to insert into this Group at the old Entities position.

Returns:

Boolean:

true if the Entities were replaced successfully, otherwise false.

setAll

(
  • componentName
  • property
  • value
)
public

Defined in src\core\Group.ts:1014

Sets a property on every member. If componentName is null the property is set on the entity itself, otherwise it is set on the named component. Uses runtime string property lookups. Not optimal for large groups if speed is an issue.

Parameters:

  • componentName String

    The name of the component to set the property on - set to null to set a property on the entity.

  • property String

    The name of the property to set.

  • value Any

    The value to set the property to.

setChildIndex

(
  • child
  • index
)
Boolean public

Defined in src\core\Group.ts:868

Sets a new position of an existing Entity within the Group.

Parameters:

  • child Object

    The child in this Group to change.

  • index Number

    The index for the child to be set at.

Returns:

Boolean:

true if the Entity was moved to the new position, otherwise false.

swapChildren

(
  • child1
  • child2
)
Boolean public

Defined in src\core\Group.ts:889

Swaps the position of two existing Entities that are a direct child of this group.

Parameters:

  • child1 Object

    The first child in this Group to swap.

  • child2 Object

    The second child in this Group to swap.

Returns:

Boolean:

true if the Entities were swapped successfully, otherwise false.

swapChildrenAt

(
  • index1
  • index2
)
Boolean public

Defined in src\core\Group.ts:917

Swaps the position of two existing Entities within the Group based on their index.

Parameters:

  • index1 Number

    The position of the first Entity in this Group to swap.

  • index2 Number

    The position of the second Entity in this Group to swap.

Returns:

Boolean:

true if the Entities were swapped successfully, otherwise false.

update

() public

Defined in src\core\Group.ts:1054

The update loop for this group.

Properties

_active

Boolean private

Defined in src\core\Group.ts:1105

An active Entity is one that has its update method called by its parent.

Default: true

_destroyRemoveChildren

Boolean private

Defined in src\core\Group.ts:1358

A temporary property that holds a boolean indicating whether or not the group's children should be destroyed or not.

_dirty

Boolean private

Defined in src\core\Group.ts:312

An indication of whether or not this group is 'dirty' and thus needs to be re-rendered or not.

_parent

Kiwi.Group private

Defined in src\core\Group.ts:83

The parent group of this group.

_tags

Array private

Defined in src\core\Group.ts:1250

Available since 1.1.0

Any tags that are on this Entity. This can be used to grab GameObjects or Groups on the whole game which have these particular tags. By default Entitys contain no tags.

_visible

Boolean private

Defined in src\core\Group.ts:1217

Available since 1.0.1

A boolean that indicates whether or not this entity is visible or not. Note that is does not get set to false if the alpha is 0.

Default: true

_willRender

Boolean deprecated private

Defined in src\core\Group.ts:1193

Deprecated: Use _visible instead

Controls whether render is automatically called by the parent.

active

Boolean public

Defined in src\core\Group.ts:1114

Toggles the active state of this Entity. An Entity that is active has its update method called by its parent. This method should be over-ridden to handle specific dom/canvas/webgl implementations.

Default: true

anchorPointX

Number public

Defined in src\core\Group.ts:234

Available since 1.1.0

The anchor point offset of this group in the X axis. This is just aliased to the transform property, and is in turn an alias of rotPointX.

anchorPointY

Number public

Defined in src\core\Group.ts:248

Available since 1.1.0

The anchor point offset of this group in the Y axis. This is just aliased to the transform property, and is in turn an alias of rotPointY.

components

Kiwi.ComponentManager public

Defined in src\core\Group.ts:262

The Component Manager

dirty

Boolean public

Defined in src\core\Group.ts:320

Sets all children of the Group to be dirty.

exists

Boolean private

Defined in src\core\Group.ts:1082

If an Entity no longer exists it is cleared for garbage collection or pool re-allocation

exists

Boolean public

Defined in src\core\Group.ts:1090

Toggles the exitence of this Group. An Entity that no longer exists can be garbage collected or re-allocated in a pool This method should be over-ridden to handle specific canvas/webgl implementations.

game

Kiwi.Game public

Defined in src\core\Group.ts:270

The game this Group belongs to

id

String public

Defined in src\core\Group.ts:286

A unique identifier for this Group within the game used internally by the framework. See the name property for a friendly version.

members

Array public

Defined in src\core\Group.ts:294

The collection of children belonging to this group

name

String public

Defined in src\core\Group.ts:65

A name for this Group. This is not checked for uniqueness within the Game, but is very useful for debugging.

Default: ''

parent

Kiwi.Group public

Defined in src\core\Group.ts:91

Set's the parent of this entity. Note that this also sets the transforms parent of this entity to be the passed groups transform.

rotPointX

Number public

Defined in src\core\Group.ts:206

Available since 1.1.0

The rotation offset of this group in the X axis. This is just aliased to the transform property.

rotPointY

Number public

Defined in src\core\Group.ts:220

Available since 1.1.0

The rotation offset of this group in the Y axis. This is just aliased to the transform property.

scale

Number public

Defined in src\core\Group.ts:182

Available since 1.1.0

The scale of this group. This is just aliased to the transform property. This is WRITE-ONLY.

state

Kiwi.State public

Defined in src\core\Group.ts:278

The State that this Group belongs to

transform

Kiwi.Geom.Transform public

Defined in src\core\Group.ts:74

The transform object for this group. Transform handles the calculation of coordinates/rotation/scale e.t.c in the Game World.

visible

Boolean public

Defined in src\core\Group.ts:1227

Available since 1.0.1

Set the visibility of this entity. True or False.

Default: true

willRender

Boolean deprecated public

Defined in src\core\Group.ts:1202

Deprecated: Use visible instead

Controls whether render is automatically called by the parent.

worldX

Number public

Defined in src\core\Group.ts:134

Available since 1.1.0

The X coordinate of this group in world space; that is, after parent transforms. This is just aliased to the transform property. This is READ-ONLY.

worldY

Number public

Defined in src\core\Group.ts:145

Available since 1.1.0

The Y coordinate of this group in world space; that is, after parent transforms. This is just aliased to the transform property. This is READ-ONLY.

x

Number public

Defined in src\core\Group.ts:108

The X coordinate of this group. This is just aliased to the transform property.

y

Number public

Defined in src\core\Group.ts:121

The Y coordinate of this group. This is just aliased to the transform property.