Module GameTypes :: Class KX_ConstraintActuator

Class KX_ConstraintActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          KX_ConstraintActuator

A constraint actuator limits the position, rotation, distance or orientation of an object.

Properties:

Instance Methods

bool

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

Deprecated

setDamp(time)
Sets the time this constraint is delayed.

integer

getDamp()
Returns the damping time of the constraint.

setMin(lower)
Sets the lower bound of the constraint.

float

getMin()
Gets the lower bound of the constraint.

setMax(upper)
Sets the upper bound of the constraint.

float

getMax()
Gets the upper bound of the constraint.

setLimit(limit)
Sets the type of constraint.

getLimit()
Gets the type of constraint.

setRotDamp(duration)
Sets the time constant of the orientation constraint.

integer

getRotDamp()
Returns the damping time for application of the constraint.

setDirection(vector)
Sets the reference direction in world coordinate for the orientation constraint

3-tuple

getDirection()
Returns the reference direction of the orientation constraint in world coordinate.

setOption(option)
Sets several options of the distance constraint.

integer

getOption()
Returns the option parameter.

setTime(duration)
Sets the activation time of the actuator.

integer

getTime()
Returns the time parameter.

setProperty(property)
Sets the name of the property or material for the ray detection of the distance constraint.

string

getProperty()
Returns the property parameter.

setDistance(distance)
Sets the target distance in distance constraint.

float

getDistance()
Returns the distance parameter.

setRayLength(length)
Sets the maximum ray length of the distance constraint.

float

getRayLength()
Returns the length of the ray

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
integer	damp time constant of the constraint expressed in frame (not use by Force field constraint)
3-tuple of float: [x,y,z]	direction the reference direction in world coordinate for the orientation constraint
float	distance the target distance of the distance constraint
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)
integer	limit type of constraint, use one of the following constant: KX_ACT_CONSTRAINT_LOCX ( 1) : limit X coord KX_ACT_CONSTRAINT_LOCY ( 2) : limit Y coord KX_ACT_CONSTRAINT_LOCZ ( 3) : limit Z coord KX_ACT_CONSTRAINT_ROTX ( 4) : limit X rotation KX_ACT_CONSTRAINT_ROTY ( 5) : limit Y rotation KX_ACT_CONSTRAINT_ROTZ ( 6) : limit Z rotation KX_ACT_CONSTRAINT_DIRPX ( 7) : set distance along positive X axis KX_ACT_CONSTRAINT_DIRPY ( 8) : set distance along positive Y axis KX_ACT_CONSTRAINT_DIRPZ ( 9) : set distance along positive Z axis KX_ACT_CONSTRAINT_DIRNX (10) : set distance along negative X axis KX_ACT_CONSTRAINT_DIRNY (11) : set distance along negative Y axis KX_ACT_CONSTRAINT_DIRNZ (12) : set distance along negative Z axis KX_ACT_CONSTRAINT_ORIX (13) : set orientation of X axis KX_ACT_CONSTRAINT_ORIY (14) : set orientation of Y axis KX_ACT_CONSTRAINT_ORIZ (15) : set orientation of Z axis KX_ACT_CONSTRAINT_FHPX (16) : set force field along positive X axis KX_ACT_CONSTRAINT_FHPY (17) : set force field along positive Y axis KX_ACT_CONSTRAINT_FHPZ (18) : set force field along positive Z axis KX_ACT_CONSTRAINT_FHNX (19) : set force field along negative X axis KX_ACT_CONSTRAINT_FHNY (20) : set force field along negative Y axis KX_ACT_CONSTRAINT_FHNZ (21) : set force field along negative Z axis
float	max the upper bound of the constraint.
float	min The lower bound of the constraint For the rotation and orientation constraint, it represents radiant
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
integer	option Binary combination of the following values: Applicable to Distance constraint:
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 name of the property or material for the ray detection of the distance constraint.
float	rayLength the length of the ray of the distance constraint.
integer	rotDamp time constant for the rotation expressed in frame (only for the distance constraint) 0 = use damp for rotation as well
integer	time activation time of the actuator.

Method Details

setDamp(time)

Sets the time this constraint is delayed.

Parameters:

time (integer) - The number of frames to delay. Negative values are ignored.

setMin(lower)

Sets the lower bound of the constraint.

For rotational and orientation constraints, lower is specified in degrees.

Parameters:

lower (float)

getMin()

Gets the lower bound of the constraint.

For rotational and orientation constraints, the lower bound is returned in radians.

Returns: float

setMax(upper)

Sets the upper bound of the constraint.

For rotational and orientation constraints, upper is specified in degrees.

Parameters:

upper (float)

getMax()

Gets the upper bound of the constraint.

For rotational and orientation constraints, the upper bound is returned in radians.

Returns: float

setLimit(limit)

Sets the type of constraint.

See module GameLogic for valid constraint types.

Parameters:

limit - Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ

getLimit()

Gets the type of constraint.

See module GameLogic for valid constraints.

Returns:: Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ, Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ, Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ

setRotDamp(duration)

Sets the time constant of the orientation constraint.

Parameters:

duration (integer) - If the duration is negative, it is set to 0.

setDirection(vector)

Sets the reference direction in world coordinate for the orientation constraint

Parameters:

vector (3-tuple)

setOption(option)

Sets several options of the distance constraint.

Parameters:

option (integer) - Binary combination of the following values: 64 : Activate alignment to surface 128 : Detect material rather than property 256 : No deactivation if ray does not hit target 512 : Activate distance control

setTime(duration)

Sets the activation time of the actuator.

Parameters:

duration (integer) - The actuator disables itself after this many frame. If set to 0 or negative, the actuator is not limited in time.

setProperty(property)

Sets the name of the property or material for the ray detection of the distance constraint.

Parameters:

property (string) - If empty, the ray will detect any collisioning object.

setDistance(distance)

Sets the target distance in distance constraint.

Parameters:

distance (float)

setRayLength(length)

Sets the maximum ray length of the distance constraint.

Parameters:

length (float)

Instance Variable Details

max

the upper bound of the constraint. For rotation and orientation constraints, it represents radiant.

Type:: float

option

Binary combination of the following values: Applicable to Distance constraint:

KX_ACT_CONSTRAINT_NORMAL ( 64) : Activate alignment to surface
KX_ACT_CONSTRAINT_DISTANCE ( 512) : Activate distance control
KX_ACT_CONSTRAINT_LOCAL (1024) : direction of the ray is along the local axis

Applicable to Force field constraint:

KX_ACT_CONSTRAINT_DOROTFH (2048) : Force field act on rotation as well

Applicable to both:

KX_ACT_CONSTRAINT_MATERIAL ( 128) : Detect material rather than property
KX_ACT_CONSTRAINT_PERMANENT ( 256) : No deactivation if ray does not hit target

Type:: integer

time

activation time of the actuator. The actuator disables itself after this many frame. If set to 0, the actuator is not limited in time.

Type:: integer