function/for

The FOR function controls periods child events spend in their True state. There are two possible variants: less and least.

Field	Type	Required	Description
blockOptions.method.args.blocks	string	+	The argument declaration of blocks field. The name is “blocks”. The type is “blocks”. The blocks field could contain several when blocks.
blockOptions.method.name	string	+	Should contain the value function.
blockOptions.function	object	+	Definition of a function to apply to children.
blockOptions.function.for	object	–	Settings of a FOR function.
blockOptions.function.for.method	enum(less, least)	+	A FOR function method to apply.
blockOptions.function.for.seconds	int	+	A period FOR function should control.

NOTE: The FOR function state is not saved between the scene service restarts, so, the function operator should not be used to handle large periods of time like hours and days. It is only intended to handle periods in seconds.

function/for/less

The function for/less is intended to ignore too-long transitions between the True and the False state of child events.
The for/less sets the interval duration in seconds.
If a child event becomes True, this function saves the timestamp of state transition. The state of a function stays False. If a child event becomes False, the function for/less checks whether an interval between the state transitions was less than the interval set as a function for/less condition.
If it is less than that interval, the function operator becomes True, and then, immediately, becomes False. Otherwise, if the interval between the transitions is greater than the For/Less function specified, the operator stays False.

function/for/least

The function for/least is intended to ignore transitions that occur too fast. The for/least sets the interval duration in seconds. If a child event becomes True, the function saves the transition timestamp. If a child event becomes False, it immediately sets a function in that same state (False). If a child event stays True for the time specified in a for/least function conditions, the function becomes True itself.

Only after that the scene state can be notified as True.

This feature is available since advanced_scenes/1.18.

Examples:

function/for/less

				
					{
   "blockOptions":{
      "method":{
         "args":{
            "blocks":"blocks"
         },
         "name":"function"
      },
     "function":{
         "for":{
             "method":"less",
             "seconds":10
         }
      }
   },
   "blockType":"when",
   "fields":[
       {
           "name":"blocks",
           "type":"blocks",
           "value": [
               __WHEN_BLOCK__, __WHEN_BLOCK__
           ]
       }
   ]
}

function/for/least

				
					{
   "blockOptions":{
      "method":{
         "args":{
            "blocks":"blocks"
         },
         "name":"function"
      },
     "function":{
         "for":{
             "method":"least",
             "seconds":10
         }
      }
   },
   "blockType":"when",
   "fields":[
       {
           "name":"blocks",
           "type":"blocks",
           "value": [
               __WHEN_BLOCK__, __WHEN_BLOCK__
           ]
       }
   ]
}

Here, the __WHEN_BLOCK__ stands for any valid when block, like a final event or a logical operator.