Module KX_StateActuator :: Class KX_StateActuator

Class KX_StateActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_StateActuator

State actuator changes the state mask of parent object.

Property:

Instance Methods
 
setOperation(op)
DEPRECATED: Use the operation property instead.
 
setMask(mask)
DEPRECATED: Use the mask property instead.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
Instance Variables
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
integer mask
value that defines the bits that will be modified by the operation.
integer operation
type of bit operation to be applied on object state mask.
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
Method Details

setOperation(op)

 

DEPRECATED: Use the operation property instead. Set the type of bit operation to be applied on object state mask. Use setMask() to specify the bits that will be modified.

Parameters:
  • op (integer) - bit operation (0=Copy, 1=Add, 2=Substract, 3=Invert)

setMask(mask)

 

DEPRECATED: Use the mask property instead. Set the value that defines the bits that will be modified by the operation. The bits that are 1 in the value will be updated in the object state, the bits that are 0 are will be left unmodified expect for the Copy operation which copies the value to the object state.

Parameters:
  • mask (integer) - bits that will be modified

Instance Variable Details

mask

value that defines the bits that will be modified by the operation. The bits that are 1 in the mask will be updated in the object state, the bits that are 0 are will be left unmodified expect for the Copy operation which copies the mask to the object state
Type:
integer

operation

type of bit operation to be applied on object state mask. You can use one of the following constant:
  • KX_STATE_OP_CPY (0) : Copy state mask
  • KX_STATE_OP_SET (1) : Add bits to state mask
  • KX_STATE_OP_CLR (2) : Substract bits to state mask
  • KX_STATE_OP_NEG (3) : Invert bits to state mask
Type:
integer