Module KX_SCA_AddObjectActuator :: Class KX_SCA_AddObjectActuator

[frames] | no frames]

Class KX_SCA_AddObjectActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_SCA_AddObjectActuator

Edit Object Actuator (in Add Object Mode)

Warning: An Add Object actuator will be ignored if at game start, the linked object doesn't exist (or is empty) or the linked object is in an active layer.

This will genereate a warning in the console:

ERROR: GameObject OBName has a AddObjectActuator ActuatorName without object (in 'nonactive' layer)

Instance Methods

setObject(object)
Sets the game object to add.

source code

string, KX_GameObject or None if no object is set

getObject(name_only=0)
Returns the name of the game object to be added.

source code

setTime(time)
Sets the lifetime of added objects, in frames.

source code

integer

getTime()
Returns the lifetime of the added object, in frames.

source code

setLinearVelocity(vx, vy, vz)
Sets the initial linear velocity of added objects.

source code

list [vx, vy, vz]

getLinearVelocity()
Returns the initial linear velocity of added objects.

source code

setAngularVelocity(vx, vy, vz)
Sets the initial angular velocity of added objects.

source code

list [vx, vy, vz]

getAngularVelocity()
Returns the initial angular velocity of added objects.

source code

getLastCreatedObject()
Returns the last object created by this actuator.

source code

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Method Details

setObject(object)

Sets the game object to add.

A copy of the object will be added to the scene when the actuator is activated.

If the object does not exist, this function is ignored.

object can either be a KX_GameObject or the name of an object or None.

Parameters:

object (KX_GameObject, string or None)

getObject(name_only=0)

Returns the name of the game object to be added.

Returns None if no game object has been assigned to be added.

Parameters:

name_only (bool) - optional argument, when 0 return a KX_GameObject

Returns: string, KX_GameObject or None if no object is set

setTime(time)

Sets the lifetime of added objects, in frames.

If time == 0, the object will last forever.

Parameters:

time (integer) - The minimum value for time is 0.

setLinearVelocity(vx, vy, vz)

Sets the initial linear velocity of added objects.

Parameters:

vx (float) - the x component of the initial linear velocity.
vy (float) - the y component of the initial linear velocity.
vz (float) - the z component of the initial linear velocity.

setAngularVelocity(vx, vy, vz)

Sets the initial angular velocity of added objects.

Parameters:

vx (float) - the x component of the initial angular velocity.
vy (float) - the y component of the initial angular velocity.
vz (float) - the z component of the initial angular velocity.

getLastCreatedObject()

Returns the last object created by this actuator.

Returns: KX_GameObject: A KX_GameObject or None if no object has been created.