Module GameTypes :: Class KX_TrackToActuator

Class KX_TrackToActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          KX_TrackToActuator

Edit Object actuator in Track To mode.

Warning:

Track To Actuators will be ignored if at game start, the object to track to is invalid.

This will generate a warning in the console:

ERROR: GameObject OBName no object in 
        EditObjectActuator ActuatorName

Instance Methods

[hide private]

Deprecated

setObject(object)
Sets the object to track.

source code

string, KX_GameObject or None if no object is set

getObject(name_only)
Returns the name of the object to track.

source code

setTime(time)
Sets the time in frames with which to delay the tracking motion.

source code

integer

getTime()
Returns the time in frames with which the tracking motion is delayed.

source code

setUse3D(use3d)
DEPRECATED: Use the property.

source code

boolean

getUse3D()
Returns True if the tracking motion will track in the z direction.

source code

Inherited from SCA_ILogicBrick

integer

getExecutePriority()
Gets the execution priority of this logic brick.

source code

KX_GameObject

getOwner()
Gets the game object associated with this logic brick.

source code

setExecutePriority(priority)
Sets the priority of this logic brick.

source code

Inherited from CValue

string

getName()
Returns the name of the CValue.

source code

Inherited from PyObjectPlus

bool

isA(game_type)
Check if this is a type or a subtype game_type.

source code

Instance Variables

[hide private]

KX_GameObject or None

object
the object this actuator tracks.

integer

time
the time in frames with which to delay the tracking motion

boolean

use3D
the tracking motion to use 3D

Inherited from SCA_ILogicBrick

int

executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).

string

name
The name of this CValue derived object (read-only).

KX_GameObject or None in exceptional cases.

owner
The game object this logic brick is attached to (read-only).

Inherited from PyObjectPlus

bool

invalid
Test if the object has been freed by the game engine and is no longer valid.

Method Details

[hide private]

setObject(object)

source code

Sets the object to track.

Parameters:

object (KX_GameObject, string or None) - Either a reference to a game object or the name of the object to track.

Deprecated: Use the object attribute instead.

getObject(name_only)

source code

Returns the name of the object to track.

Parameters:

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

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

Deprecated: Use the object attribute instead.

setTime(time)

source code

Sets the time in frames with which to delay the tracking motion.

Deprecated: Use the time attribute instead.

getTime()

source code

Returns the time in frames with which the tracking motion is delayed.

Returns: integer

Deprecated: Use the time attribute instead.

setUse3D(use3d)

source code

DEPRECATED: Use the property. Sets the tracking motion to use 3D.

Parameters:

use3d (boolean) - - True: allow the tracking motion to extend in the z-direction.
- False: lock the tracking motion to the x-y plane.

Deprecated: Use the use3D attribute instead.

getUse3D()

source code

Returns True if the tracking motion will track in the z direction.

Returns: boolean

Deprecated: Use the use3D attribute instead.