ScarDoc

Start typing to search the SCAR reference.

Function
Util

Util_TriggerEvent

Library function to trigger NIS event under a certain sets of conditions. NOTE: if checking against a marker DO NOT specify a range. The range of the marker set in the WorldBuilder will be used.

On this page
Util_TriggerEvent(playerid, position, range, func, non_combat, onscreen_only, onscreen_duration)

Description

triggering event when one of the player's squads come near a particular SGroup, EGroup, Marker, or Position and that squad is onscreen, and that squad is not in combat. 6 arguments when using marker, 7 arguments when using position, egroup and sgroup with the additional range value non_combat set to TRUE means the squad cannot be in combat if the event is to be triggered. onscreen_only set to TRUE means the squad must be onscreen if the event is to be triggered.

Parameters

  • playeridPlayerIDrequired
  • positionMarker/EGroup/SGroup/ScarPosrequired
  • rangeIntegerrequired
  • funcLuaFunctionrequired
  • non_combatBooleanrequired
  • onscreen_onlyBooleanrequired
  • onscreen_durationIntegerrequired

Returns

Void

Source

Declared in the game's script sources at:

scar/scarutil.scar