Module KX_CameraActuator :: Class KX_CameraActuator

Class KX_CameraActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_CameraActuator

Applies changes to a camera.


Author: snail

Instance Methods
string, KX_GameObject or None if no object is set
getObject(name_only=1)
Returns the name of the object this actuator tracks.
 
setObject(target)
Sets the object this actuator tracks.
float
getMin()
Returns the minimum distance to target maintained by the actuator.
 
setMin(distance)
Sets the minimum distance to the target object maintained by the actuator.
float
getMax()
Gets the maximum distance to stay from the target object.
 
setMax(distance)
Sets the maximum distance to stay from the target object.
float
getHeight()
Returns the height to stay above the target object.
 
setHeight(height)
Sets the height to stay above the target object.
 
setXY(xaxis)
Sets the axis to get behind.
boolean
getXY()
Returns the axis this actuator is tracking.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
Instance Variables
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
float height
height to stay above the target object
float max
maximum distance to stay from the target object
float min
minimum distance to the target object maintained by the actuator
KX_GameObject or None object
the object this actuator tracks.
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
boolean xy
axis this actuator is tracking, true=X, false=Y
Method Details

getObject(name_only=1)

 

Returns the name of the object this actuator tracks.

Parameters:
  • name_only (bool) - optional argument, when 0 return a KX_GameObject
Returns: string, KX_GameObject or None if no object is set

setObject(target)

 

Sets the object this actuator tracks.

Parameters:

setMin(distance)

 

Sets the minimum distance to the target object maintained by the actuator.

Parameters:
  • distance (float) - The minimum distance to maintain.

setMax(distance)

 

Sets the maximum distance to stay from the target object.

Parameters:
  • distance (float) - The maximum distance to maintain.

setHeight(height)

 

Sets the height to stay above the target object.

Parameters:
  • height (float) - The height to stay above the target object.

setXY(xaxis)

 

Sets the axis to get behind.

Parameters:
  • xaxis (boolean) - False to track Y axis, True to track X axis.

getXY()

 

Returns the axis this actuator is tracking.

Returns: boolean
True if tracking X axis, False if tracking Y axis.