Q.GameObject Class
Game Objects
This is the base class most Quintus objects are derived from, it extends
Q.Evented and adds component support to an object, allowing components to
be added and removed from an object. It also defines a destroyed method
which will debind the object, remove it from it's parent (usually a scene)
if it has one, and trigger a destroyed event.
Methods
add
-
components
Adds one or more components to an object. Accepts either a comma separated string or an array of strings that map to component names.
Instantiates a new component object of the correct type (if the component exists) and then triggers an addComponent event.
For example:
this.add("2d, aiBounce")Returns the object to allow chaining.
Parameters:
-
componentsString- comma separated list of components to add
Returns:
returns this for chaining purposes
debind
()
debind is called to remove any listeners an object had
on other objects. The most common case is when an object is
destroyed you'll want all the event listeners to be removed
for you.
del
-
components
Removes one or more components from an object. Accepts the
same style of parameters as add. Triggers a delComponent event
and and calls destroy on the component.
Returns the element to allow chaining.
Parameters:
-
componentsString- comma separated list of components to remove
Returns:
returns this for chaining purposes
del
-
components
Destroys the object by calling debind and removing the object from it's parent. Will trigger a destroyed event callback.
Parameters:
-
componentsString- comma separated list of components to remove
Returns:
returns this for chaining purposes
extend
-
className -
properties -
[classMethods]
Create a new Class that inherits from this class
Parameters:
-
classNameString -
propertiesObject- hash of properties (init will be the constructor)
-
[classMethods]Object optional- optional class methods to add to the class
has
-
component
Simple check to see if a component already exists on an object by searching for a property of the same name.
Parameters:
-
componentString- name of component to test against
Returns:
isA
-
className
See if a object is a specific class
Parameters:
-
classNameString- class to check against
off
-
event -
[target] -
[callback]
Unbinds an event. Can be called with 1, 2, or 3 parameters, each of which unbinds a more specific listener.
Parameters:
-
eventString- name of event
-
[target]Object optional- optionally limit to a specific target
-
[callback]Function optional- optionally limit to one specific callback
on
-
event -
[target] -
[callback]
Binds a callback to an event on this object. If you provide a
target object, that object will add this event to it's list of
binds, allowing it to automatically remove it when it is destroyed.
Parameters:
-
eventString- name or comma separated list of events
-
[target]Object optional- optional context for callback, defaults to the Evented
-
[callback]Function optional- callback (optional - defaults to name of event on context
trigger
-
event -
[data]
Triggers an event, passing in some optional additional data about the event.
Parameters:
-
eventString- name of event
-
[data]Object optional- optional data to pass to the callback