Module GameTypes :: Class SCA_DelaySensor
[hide private]
[frames] | no frames]

Class SCA_DelaySensor

source code

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 [hide private]
    Deprecated
 
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
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings.
source code
integer
getFrequency()
The frequency for pulse mode sensors.
source code
 
getInvert()
True if this sensor activates on negative events.
source code
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector.
source code
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode.
source code
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode.
source code
 
isPositive()
True if this sensor brick is in a positive state.
source code
 
isTriggered()
True if this sensor brick has triggered the current controller.
source code
 
setFrequency(freq)
Sets the frequency for pulse mode sensors.
source code
 
setInvert(invert)
Sets if this sensor activates on positive or negative events.
source code
 
setLevel(level)
Set whether to detect level or edge transition when entering a state.
source code
 
setUseNegPulseMode(pulse)
Sets negative pulse mode.
source code
 
setUsePosPulseMode(pulse)
Sets positive pulse mode.
source code
    Inherited from SCA_ILogicBrick
integer
getExecutePriority()
Gets the execution priority of this logic brick.
source code
KX_GameObject
getOwner()
Gets the game object associated with this logic brick.
source code
 
setExecutePriority(priority)
Sets the priority of this logic brick.
source code
    Inherited from CValue
string
getName()
Returns the name of the CValue.
source code
    Inherited from PyObjectPlus
bool
isA(game_type)
Check if this is a type or a subtype game_type.
source code
Instance Variables [hide private]
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.
integer repeat
1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.
    Inherited from SCA_ISensor
int frequency
The frequency for pulse mode sensors.
boolean invert
Flag to set if this sensor activates on positive or negative events.
boolean level
Option whether to detect level or edge transition when entering a state.
boolean positive
True if this sensor brick is in a positive state.
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.
boolean triggered
True if this sensor brick is in a positive state.
boolean useNegPulseMode
Flag to turn negative pulse mode on and off.
boolean usePosPulseMode
Flag to turn positive pulse mode on and off.
    Inherited from SCA_ILogicBrick
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
string name
The name of this CValue derived object (read-only).
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read-only).
    Inherited from PyObjectPlus
bool invalid
Test if the object has been freed by the game engine and is no longer valid.
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

Deprecated: Use the delay attribute instead.

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

Deprecated: Use the duration attribute instead.

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.

Deprecated: Use the repeat attribute instead.

getDelay()

source code 
Return the delay parameter value.
Returns: integer

Deprecated: Use the delay attribute instead.

getDuration()

source code 
Return the duration parameter value
Returns: integer

Deprecated: Use the duration attribute instead.

getRepeat()

source code 
Return the repeat parameter value
Returns: KX_TRUE or KX_FALSE

Deprecated: Use the repeat attribute instead.


Instance Variable Details [hide private]

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