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

[hide private]

string, KX_GameObject or None if no object is set

getObject(name_only=1)
Returns the name of the object this actuator tracks.

source code

setObject(target)
Sets the object this actuator tracks.

source code

float

getMin()
Returns the minimum distance to target maintained by the actuator.

source code

setMin(distance)
Sets the minimum distance to the target object maintained by the actuator.

source code

float

getMax()
Gets the maximum distance to stay from the target object.

source code

setMax(distance)
Sets the maximum distance to stay from the target object.

source code

float

getHeight()
Returns the height to stay above the target object.

source code

setHeight(height)
Sets the height to stay above the target object.

source code

setXY(xaxis)
Sets the axis to get behind.

source code

boolean

getXY()
Returns the axis this actuator is tracking.

source code

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Method Details

[hide private]

getObject(name_only=1)

source code

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)

source code

Sets the object this actuator tracks.

Parameters:

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

setMin(distance)

source code

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

Parameters:

distance (float) - The minimum distance to maintain.

setMax(distance)

source code

Sets the maximum distance to stay from the target object.

Parameters:

distance (float) - The maximum distance to maintain.

setHeight(height)

source code

Sets the height to stay above the target object.

Parameters:

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

setXY(xaxis)

source code

Sets the axis to get behind.

Parameters:

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

getXY()

source code

Returns the axis this actuator is tracking.

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