Module SCA_DelaySensor :: Class SCA_DelaySensor

Class SCA_DelaySensor

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
            SCA_ISensor.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.

Instance Methods

[hide private]

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

source code

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

source code

setRepeat(repeat)
Set if the sensor repeat mode.

source code

integer

getDelay()
Return the delay parameter value.

source code

integer

getDuration()
Return the duration parameter value

source code

KX_TRUE or KX_FALSE

getRepeat()
Return the repeat parameter value

source code

Inherited from SCA_ISensor.SCA_ISensor: getFrequency, getInvert, getLevel, getUseNegPulseMode, getUsePosPulseMode, isPositive, isTriggered, reset, setFrequency, setInvert, setLevel, setUseNegPulseMode, setUsePosPulseMode

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Method Details

[hide private]

setDelay(delay)

source code

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

setDuration(duration)

source code

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

setRepeat(repeat)

source code

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.