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

[hide private]

Deprecated

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

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]

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.

boolean

useXY
axis this actuator is tracking, true=X, false=Y

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]

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

Deprecated: Use the object attribute instead.

setObject(target)

source code

Sets the object this actuator tracks.

Parameters:

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

Deprecated: Use the object attribute instead.

getMin()

source code

Returns the minimum distance to target maintained by the actuator.

Returns: float

Deprecated: Use the min attribute instead.

setMin(distance)

source code

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()

source code

Gets the maximum distance to stay from the target object.

Returns: float

Deprecated: Use the max attribute instead.

setMax(distance)

source code

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()

source code

Returns the height to stay above the target object.

Returns: float

Deprecated: Use the height attribute instead.

setHeight(height)

source code

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)

source code

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()

source code

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.