Module GameTypes :: Class KX_CameraActuator

Class KX_CameraActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          KX_CameraActuator

Applies changes to a camera.

Author: snail

Instance Methods

bool

isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)

Deprecated

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 GameTypes.SCA_ILogicBrick)

string

getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)

KX_GameObject

getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

Instance Variables
int	executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from GameTypes.SCA_ILogicBrick)
float	height height to stay above the target object
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
float	max maximum distance to stay from the target object
float	min minimum distance to the target object maintained by the actuator
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
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 GameTypes.SCA_ILogicBrick)
boolean	useXY 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

Deprecated: Use the object attribute instead.

setObject(target)

Sets the object this actuator tracks.

Parameters:

target (KX_GameObject, string or None) - the object to track.

Deprecated: Use the object attribute instead.

getMin()

Returns the minimum distance to target maintained by the actuator.

Returns: float

Deprecated: Use the min attribute instead.

setMin(distance)

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

Parameters:

distance (float) - The minimum distance to maintain.

Deprecated: Use the min attribute instead.

getMax()

Gets the maximum distance to stay from the target object.

Returns: float

Deprecated: Use the max attribute instead.

setMax(distance)

Sets the maximum distance to stay from the target object.

Parameters:

distance (float) - The maximum distance to maintain.

Deprecated: Use the max attribute instead.

getHeight()

Returns the height to stay above the target object.

Returns: float

Deprecated: Use the height attribute instead.

setHeight(height)

Sets the height to stay above the target object.

Parameters:

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

Deprecated: Use the height attribute instead.

setXY(xaxis)

Sets the axis to get behind.

Parameters:

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

Deprecated: Use the useXY attribute instead.

getXY()

Returns the axis this actuator is tracking.

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

Deprecated: Use the useXY attribute instead.