API Docs for: 1.4.0
Show:

Kiwi.Component Class

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

The base class that all components extend from. It contains all of the common functionality that is required of every Component. Any object

Constructor

Kiwi.Component

(
  • owner
  • componentName
)
Kiwi.Component

Defined in src\core\Component.ts:9

Parameters:

  • owner Object

    The object that this component belongs to.

  • componentName String

    The name of this component.

Returns:

Kiwi.Component:

Item Index

Methods

Properties

Methods

destroy

() public

Defined in src\core\Component.ts:121

Destroys this component and all of the properties that exist on it.

objType

() String public

Defined in src\core\Component.ts:38

Returns the type of this object

Returns:

String:

"Component"

postUpdate

() public

Defined in src\core\Component.ts:114

Components can postUpdate, that is run an update after the parent has updated. This is to be overriden by subclasses.

preUpdate

() public

Defined in src\core\Component.ts:100

Components can preUpdate, that is update before the parent updates. This is to be overriden by subclasses.

update

() public

Defined in src\core\Component.ts:107

If the component is being added to a State rather than a Game Object then over-ride its update method to perform required tasks.

Properties

active

Boolean public

Defined in src\core\Component.ts:81

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

Default: true

dirty

Boolean deprecated public

Defined in src\core\Component.ts:90

The state of this component.

Default: false

game

Kiwi.Game public

Defined in src\core\Component.ts:65

The game this Component belongs to

name

String public

Defined in src\core\Component.ts:73

The name of this component.

owner

Object public

Defined in src\core\Component.ts:48

The object that owns this entity

state

Kiwi.State public

Defined in src\core\Component.ts:56

Available since 1.3.1

The state which this component's owner belongs to.