API Docs for: 0.0.2
Show:

Atlantis.DrawableGameComponent Class

Extends Atlantis.GameComponent
Defined in: Framework\GameComponent.js:77
Module: Framework
Parent Module: Atlantis

Create a drawable game component.

Constructor

Atlantis.DrawableGameComponent

(
  • game
)

Defined in Framework\GameComponent.js:77

Parameters:

Methods

@setEnabled

(
  • enabled
)

Inherited from Atlantis.GameComponent: Framework\GameComponent.js:64

Gets the status of the component.

Parameters:

  • enabled Boolean

    Sets to true to enable

add

(
  • A
)

Defined in Framework\GameComponent.js:207

Add a component to the collection

Parameters:

draw

(
  • gameTime
  • context
)

Defined in Framework\GameComponent.js:108

Draw the component on screen.

Parameters:

draw

()

Defined in Framework\GameComponent.js:195

Draw all components

get

()

Defined in Framework\GameComponent.js:250

Get a component from the collection

initialize

()

Inherited from Atlantis.GameComponent but overwritten in Framework\GameComponent.js:149

Initialize logic.

isEnabled

() Boolean

Inherited from Atlantis.GameComponent: Framework\GameComponent.js:46

Gets the status of the component.

Returns:

Boolean:

The status of the component.

isInitialized

() Boolean

Inherited from Atlantis.GameComponent: Framework\GameComponent.js:55

Flags used to determine if the initialization processes is done.

Returns:

Boolean:

isVisible

() Boolean

Defined in Framework\GameComponent.js:116

Gets the visibility of the component.

Returns:

Boolean:

Return true if visible otherwise return false

loadContent

()

Defined in Framework\GameComponent.js:92

Load assets of the component.

loadContent

()

Defined in Framework\GameComponent.js:160

Load assets

remove

() Boolean

Defined in Framework\GameComponent.js:230

Remove a component from the collection

Returns:

Boolean:

Return true if the component has been successfully removed.

setVisible

(
  • visible
)

Defined in Framework\GameComponent.js:125

Set the component visible or invisible

Parameters:

unloadContent

()

Defined in Framework\GameComponent.js:100

Unload and dispose all assets of the component.

unloadContent

()

Defined in Framework\GameComponent.js:171

Unload assets

update

(
  • gameTime
)

Inherited from Atlantis.GameComponent but overwritten in Framework\GameComponent.js:182

Update all components

Parameters: