Module GameTypes :: Class SCA_PropertyActuator

Class SCA_PropertyActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          SCA_PropertyActuator

Property Actuator

Properties:

Instance Methods

[hide private]

Deprecated

setProperty(prop)
Set the property on which to operate.

source code

string

getProperty()
Returns the name of the property on which to operate.

source code

setValue(value)
Set the value with which the actuator operates.

source code

string

getValue()
Gets the value with which this actuator operates.

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]

int

mode
TODO - add constants to game logic dict!.

string

propName
the property on which to operate.

string

value
the value with which the actuator operates.

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]

setProperty(prop)

source code

Set the property on which to operate.

If there is no property of this name, the call is ignored.

Parameters:

prop (string) - The name of the property to set.

Deprecated: Use the propName attribute instead.

getProperty()

source code

Returns the name of the property on which to operate.

Returns: string

Deprecated: Use the propName attribute instead.

setValue(value)

source code

Set the value with which the actuator operates.

If the value is not compatible with the type of the property, the subsequent action is ignored.

Deprecated: Use the value attribute instead.

getValue()

source code

Gets the value with which this actuator operates.

Returns: string

Deprecated: Use the value attribute instead.