blender/source/gameengine/PyDoc/KX_StateActuator.py

27 lines
805 B
Python

# $Id$
# Documentation for KX_StateActuator
from SCA_IActuator import *
class KX_StateActuator(SCA_IActuator):
"""
State actuator changes the state mask of parent object.
"""
def setOperation(op):
"""
Set the type of bit operation to be applied on object state mask.
Use setMask() to specify the bits that will be modified.
@param op: bit operation (0=Copy, 1=Add, 2=Substract, 3=Invert)
@type op: integer
"""
def setMask(mask):
"""
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.
@param mask: bits that will be modified
@type mask: integer
"""