« Back to Product

Documentation

IPS_SetEventTriggerValue

 bool IPS_SetEventTriggerValue (int $EventID, mixed $TriggerValue) 

Parameters

EventID

ID of the event to be changed

TriggerValue

Value/ type, depending on TriggerVariableID

Returns

If the function succeeds, it returns TRUE, otherwise FALSE.

Description

Indicates the value/threshold at which the event should be run.

The TriggerType of the event must be set to:

  • On limit exceed
  • On limit drop
  • On specific value
Warning

The limit must match the type of the trigger variable (for float variables, an integer is accepted as well). Otherwise the function fails. Therefore, the trigger variable must be set via IPS_SetEventTrigger beforehand.

Example

IPS_SetEventTriggerValue($EventID, true); //Trigger only for TRUE values
Any questions?