diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.SCA_DelaySensor.rst')
| -rw-r--r-- | doc/python_api/rst/bge_types/bge.types.SCA_DelaySensor.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.SCA_DelaySensor.rst b/doc/python_api/rst/bge_types/bge.types.SCA_DelaySensor.rst new file mode 100644 index 00000000000..ce2b8e52eec --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.SCA_DelaySensor.rst @@ -0,0 +1,39 @@ +SCA_DelaySensor(SCA_ISensor) +============================ + +.. module:: bge.types + +base class --- :class:`SCA_ISensor` + +.. class:: SCA_DelaySensor(SCA_ISensor) + + 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 :class:`SCA_ISensor.reset` at any time to restart sensor. + + .. attribute:: delay + + length of the initial OFF period as number of frame, 0 for immediate trigger. + + :type: integer. + + .. attribute:: 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 + + .. attribute:: repeat + + 1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once. + + :type: integer + |