Module GameTypes :: Class SCA_PropertyActuator

Class SCA_PropertyActuator

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

Property Actuator

Properties:

Instance Methods

bool

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

Deprecated

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

string

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

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

string

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

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)
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
int	mode TODO - add constants to game logic dict!.
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases.	owner The game object this logic brick is attached to (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
string	propName the property on which to operate.
string	value the value with which the actuator operates.

Method Details

setProperty(prop)

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

Returns the name of the property on which to operate.

Returns: string

Deprecated: Use the propName attribute instead.

setValue(value)

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.

Parameters:

value (string)

Deprecated: Use the value attribute instead.

getValue()

Gets the value with which this actuator operates.

Returns: string

Deprecated: Use the value attribute instead.