Module GameTypes :: Class SCA_DelaySensor

Class SCA_DelaySensor

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
             SCA_ISensor --+
                           |
                          SCA_DelaySensor

The Delay sensor generates positive and negative triggers at precise time, expressed in number of frames. The delay parameter defines the length of the initial OFF period. A positive trigger is generated at the end of this period. The duration parameter defines the length of the ON period following the OFF period. There is a negative trigger at the end of the ON period. If duration is 0, the sensor stays ON and there is no negative trigger. The sensor runs the OFF-ON cycle once unless the repeat option is set: the OFF-ON cycle repeats indefinately (or the OFF cycle if duration is 0). Use SCA_ISensor::reset() at any time to restart sensor.

Properties:

Instance Methods

bool

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

reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from GameTypes.SCA_ISensor)

Deprecated

setDelay(delay)
Set the initial delay before the positive trigger.

setDuration(duration)
Set the duration of the ON pulse after initial delay and the generation of the positive trigger.

setRepeat(repeat)
Set if the sensor repeat mode.

integer

getDelay()
Return the delay parameter value.

integer

getDuration()
Return the duration parameter value

KX_TRUE or KX_FALSE

getRepeat()
Return the repeat parameter value

integer

getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

integer

getFrequency()
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)

getInvert()
True if this sensor activates on negative events. (Inherited from GameTypes.SCA_ISensor)

boolean

getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from GameTypes.SCA_ISensor)

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)

getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from GameTypes.SCA_ISensor)

getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from GameTypes.SCA_ISensor)

isPositive()
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)

isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from GameTypes.SCA_ISensor)

setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)

setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)

setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)

setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from GameTypes.SCA_ISensor)

setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from GameTypes.SCA_ISensor)

Instance Variables
integer.	delay length of the initial OFF period as number of frame, 0 for immediate trigger.
integer	duration length of the ON period in number of frame after the initial OFF period.
int	executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from GameTypes.SCA_ILogicBrick)
int	frequency The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
boolean	invert Flag to set if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)
boolean	level Option whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)
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)
boolean	positive True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
integer	repeat 1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.
boolean	tap When enabled only sensors that are just activated will send a positive event, after this they will be detected as negative by the controllers. (Inherited from GameTypes.SCA_ISensor)
boolean	triggered True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
boolean	useNegPulseMode Flag to turn negative pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)
boolean	usePosPulseMode Flag to turn positive pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)

Method Details

setDelay(delay)

Set the initial delay before the positive trigger.

Parameters:

delay (integer) - length of the initial OFF period as number of frame, 0 for immediate trigger

Deprecated: Use the delay attribute instead.

setDuration(duration)

Set the duration of the ON pulse after initial delay and the generation of the positive trigger. If duration is greater than 0, a negative trigger is sent at the end of the ON pulse.

Parameters:

duration (integer) - length of the ON period in number of frame after the initial OFF period

Deprecated: Use the duration attribute instead.

setRepeat(repeat)

Set if the sensor repeat mode.

Parameters:

repeat (integer) - 1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.

Deprecated: Use the repeat attribute instead.

getDelay()

Return the delay parameter value.

Returns: integer

Deprecated: Use the delay attribute instead.

getDuration()

Return the duration parameter value

Returns: integer

Deprecated: Use the duration attribute instead.

getRepeat()

Return the repeat parameter value

Returns: KX_TRUE or KX_FALSE

Deprecated: Use the repeat attribute instead.

Instance Variable Details

duration

length of the ON period in number of frame after the initial OFF period. If duration is greater than 0, a negative trigger is sent at the end of the ON pulse.

Type:: integer