• Listen to a special audio message from Bill Roper to the Hive Workshop community (Bill is a former Vice President of Blizzard Entertainment, Producer, Designer, Musician, Voice Actor) 🔗Click here to hear his message!
  • Read Evilhog's interview with Gregory Alper, the original composer of the music for WarCraft: Orcs & Humans 🔗Click here to read the full interview.

Triggers

GapGeneratorV2.w3x
Variables
Variables
Requirement
Variables
Unit Indexer
GapGenerator
Const
Register
System
GapGeneratorConfig
GapGeneratorRegisterSample
GapGeneratorRegistration
GapGeneratorOnEnter
GapGeneratorOnIndex
GapGeneratorLoop
Testmap
---------------------------
GapGeneratorRegister Farm
GapGeneratorRegister Ogre Lord
Ogre Lord Patrol
Player Teal Visible
Enter map-specific custom script code below. This text will be included in the map script after variables are declared and before any trigger code.
Name Type is_array initial_value
GapGenCheckIndex integer No
GapGenEvent real No
GapGenIndex integer No
GapGenLoopTrigger trigger No
GapGenMaxIndex integer No
GapGenOnIndexTrigger trigger No
GapGenRealloc boolean No
GapGenRegisterTrigger trigger No
GapGenSysRefRate real No
GapGenTempUnitGroup group No
GapGenUnit unit No
GapGenUnitAffectEnemy boolean Yes
GapGenUnitCurrentTimer real Yes
GapGenUnitPlayerGroup force No
GapGenUnitSource unit Yes
GapGenUnitTempLoc location No
GapGenUnitType unitcode No
GapGenUnitTypeAffectEnemy boolean No
GapGenUnitTypeAffectEnemyList boolean Yes
GapGenUnitTypeIsMobile boolean No
GapGenUnitTypeIsMobileList boolean Yes
GapGenUnitTypeList unitcode Yes
GapGenUnitTypeLoop integer No
GapGenUnitTypeRange real No
GapGenUnitTypeRangeList real Yes
GapGenUnitTypeRefRate real No
GapGenUnitTypeRefRateList real Yes
GapGenUnitTypeTotal integer No
GapGenUnitTypeVis integer No
GapGenUnitTypeVisList integer Yes
GapGenUnitVisibilityRange real Yes
GapGenVISBLACKMASK integer No 0
GapGenVISFOGOFWAR integer No 0
GapGenVisibility fogmodifier Yes
GapGenVisibilityType integer Yes
GapGenVISVISIBLE integer No 0
MobileGap fogmodifier Yes
Satuplink fogmodifier No
TempLoc location No
TempUnit unit No
UDex integer No
UDexGen integer No
UDexNext integer Yes
UDexPrev integer Yes
UDexRecycle integer No
UDexUnits unit Yes
UDexWasted integer No
UnitIndexerEnabled boolean No
UnitIndexEvent real No
UnitIndexLock integer Yes
Unit Indexer gives you an array-safe (1-8190) custom value for units, eliminating the need for hashtables to store unit-specific data.
Just use "Set MyArrayData[(Custom value of Unit)] = (Some data)".
--------
If you want to get the unit assigned to an index (reverse lookup) use "UDexUnits[(Index)]".
--------
If you want to detect when an index is created or when it is released, use "UnitIndexEvent Equal to 1.00" (created) or "UnitIndexEvent Equal to 2.00" (released). The index being created/released is called "UDex".
--------
You can enable/disable Unit Indexer to protect some of your undesirable units from being indexed like this:

Trigger - Turn off Unit Indexer <gen>
Unit - Create 1 Dummy for (Triggering player) at TempPoint facing 0.00 degrees
Trigger - Turn on Unit Indexer <gen>
--------
If you want to use a Map Initialization trigger that uses custom value of units, to make sure that UnitIndexer initializes first, use the event "UnitIndexEvent Equal to 3.00". Otherwise the custom value of units may be zero.
--------
Advanced:
--------
If you want to lock the index of a unit, use "Set UnitIndexLock[(Index)] = (UnitIndexLock[(Index)] + 1)". This will prevent the index from being recycled. If you want to unlock it and allow it to be recycled, run the Unit Indexer <gen> trigger.

Note: Make sure if you add a lock that you will eventually remove the lock, otherwise the index will never be recycled.
Unit Indexer
Events
Map initialization
Conditions
Actions
Custom script: call ExecuteFunc("InitializeUnitIndexer")
Custom script: endfunction
Custom script:
Custom script: function ClearUnitIndex takes nothing returns nothing
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
(Custom value of UDexUnits[UDex]) Equal to 0
Then - Actions
Set Variable Set UnitIndexLock[UDex] = (UnitIndexLock[UDex] - 1)
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
UnitIndexLock[UDex] Equal to 0
Then - Actions
Set Variable Set UDexNext[UDexPrev[UDex]] = UDexNext[UDex]
Set Variable Set UDexPrev[UDexNext[UDex]] = UDexPrev[UDex]
Set Variable Set UDexPrev[UDex] = "0"
Set Variable Set UnitIndexEvent = "0.00"
Set Variable Set UnitIndexEvent = "2.00"
Set Variable Set UnitIndexEvent = "0.00"
Set Variable Set UDexUnits[UDex] = No unit
Set Variable Set UDexNext[UDex] = UDexRecycle
Set Variable Set UDexRecycle = UDex
Else - Actions
Else - Actions
Custom script: endfunction
Custom script:
Custom script: function IndexUnit takes nothing returns boolean
Custom script: local integer pdex = udg_UDex
Custom script: local integer ndex
-------- - --------
-------- You can customize the following block - if conditions are false the (Matching unit) won't be indexed. --------
-------- - --------
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
UnitIndexerEnabled Equal to True
(Custom value of (Matching unit)) Equal to 0
Then - Actions
Set Variable Set UDexWasted = (UDexWasted + 1)
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
UDexWasted Equal to 32
Then - Actions
Set Variable Set UDexWasted = "0"
Set Variable Set UDex = UDexNext[0]
Custom script: loop
Custom script: exitwhen udg_UDex == 0
Custom script: set ndex = udg_UDexNext[udg_UDex]
Custom script: call ClearUnitIndex()
Custom script: set udg_UDex = ndex
Custom script: endloop
Else - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
UDexRecycle Equal to 0
Then - Actions
Set Variable Set UDex = (UDexGen + 1)
Set Variable Set UDexGen = UDex
Else - Actions
Set Variable Set UDex = UDexRecycle
Set Variable Set UDexRecycle = UDexNext[UDex]
Set Variable Set UDexUnits[UDex] = (Matching unit)
Unit - Set the custom value of UDexUnits[UDex] to UDex
Set Variable Set UDexPrev[UDexNext[0]] = UDex
Set Variable Set UDexNext[UDex] = UDexNext[0]
Set Variable Set UDexNext[0] = UDex
Set Variable Set UnitIndexLock[UDex] = "1"
Set Variable Set UnitIndexEvent = "0.00"
Set Variable Set UnitIndexEvent = "1.00"
Set Variable Set UnitIndexEvent = "0.00"
Custom script: set udg_UDex = pdex
Else - Actions
Custom script: return false
Custom script: endfunction
Custom script:
Custom script: function InitializeUnitIndexer takes nothing returns nothing
Custom script: local integer i = bj_MAX_PLAYER_SLOTS
Custom script: local boolexpr b = Filter(function IndexUnit)
Custom script: local region re = CreateRegion()
Custom script: local trigger t = GetTriggeringTrigger()
Custom script: local rect r = GetWorldBounds()
Custom script: call RegionAddRect(re, r)
Custom script: call TriggerRegisterEnterRegion(t, re, b)
Custom script: call TriggerClearActions(t)
Custom script: call TriggerAddAction(t, function ClearUnitIndex)
Set Variable Set UnitIndexerEnabled = "true"
Custom script: loop
Custom script: set i = i - 1
Custom script: call GroupEnumUnitsOfPlayer(bj_lastCreatedGroup, Player(i), b)
Custom script: exitwhen i == 0
Custom script: endloop
Custom script: call RemoveRect(r)
Custom script: set re = null
Custom script: set r = null
Custom script: set t = null
Custom script: set b = null
Set Variable Set UnitIndexEvent = "3.00"
Set Variable Set UnitIndexEvent = "0.00"
GapGeneratorConfig
Events
Game - UnitIndexEvent becomes Equal to 3.00
Conditions
Actions
-------- Set below variable to GapGeneratorRegistration --------
Set Variable Set GapGenRegisterTrigger = GapGeneratorRegistration <gen>
-------- Set below variable to GapGeneratorLoop --------
Set Variable Set GapGenLoopTrigger = GapGeneratorLoop <gen>
-------- Set below variable to GapGeneratorOnIndex --------
Set Variable Set GapGenOnIndexTrigger = GapGeneratorOnIndex <gen>
-------- System Refresh Rate (set to higher values if your map lags) --------
-------- Default: 1/32 = 0.03125 --------
Set Variable Set GapGenSysRefRate = (1 / 32.00)
-------- END CONFIG --------
Set Variable Set GapGenVISBLACKMASK = "0"
Set Variable Set GapGenVISFOGOFWAR = "1"
Set Variable Set GapGenVISVISIBLE = "2"
Set Variable Set GapGenEvent = "1.00"
Set Variable Set GapGenEvent = "0.00"
Trigger - Add to GapGenLoopTrigger the event (Every GapGenSysRefRate seconds of game time)
GapGeneratorRegisterSample
Events
Game - GapGenEvent becomes Equal to 1.00
Conditions
Actions
-------- COPY THIS TRIGGER TO REGISTER MULTIPLE UNITS --------
-------- DON'T FORGET TO TICK ENABLED --------
-------- Unit type to register --------
Set Variable Set GapGenUnitType = No unit-type
-------- Range of the gap effect --------
Set Variable Set GapGenUnitTypeRange = "0.00"
-------- Refresh Rate for gaps --------
-------- STATIC GAPS SHOULD USE EXTREMELY HIGH VALUES --------
-------- READ THE FOLLOWING NOTES FOR MOBILE GAPS --------
-------- Despite it capable of being low-valued, please consider the computational costs --------
-------- Too small value will render the system to use a lot of computation to refresh --------
-------- Too high value will render the delay between refresh too noticeable for players --------
-------- It is up to you, the user, to consider what value works best for your scenario --------
Set Variable Set GapGenUnitTypeRefRate = "0.00"
-------- There are 3 option for this: VISBLACKMASK, VISFOGOFWAR, VISVISIBLE, each representing the modifier that will be applied --------
Set Variable Set GapGenUnitTypeVis = GapGenVISBLACKMASK
-------- If set to False, will affect allies and self instead --------
Set Variable Set GapGenUnitTypeAffectEnemy = "true"
-------- END CONFIG --------
Trigger - Run GapGenRegisterTrigger (checking conditions)
GapGeneratorRegistration
Events
Conditions
Actions
Set Variable Set GapGenUnitTypeTotal = (GapGenUnitTypeTotal + 1)
Set Variable Set GapGenUnitTypeList[GapGenUnitTypeTotal] = GapGenUnitType
Set Variable Set GapGenUnitTypeIsMobileList[GapGenUnitTypeTotal] = GapGenUnitTypeIsMobile
Set Variable Set GapGenUnitTypeRangeList[GapGenUnitTypeTotal] = GapGenUnitTypeRange
Set Variable Set GapGenUnitTypeRefRateList[GapGenUnitTypeTotal] = GapGenUnitTypeRefRate
Set Variable Set GapGenUnitTypeVisList[GapGenUnitTypeTotal] = GapGenUnitTypeVis
Set Variable Set GapGenUnitTypeAffectEnemyList[GapGenUnitTypeTotal] = GapGenUnitTypeAffectEnemy
Set Variable Set GapGenTempUnitGroup = (Units in (Playable map area) matching ((Unit-type of (Matching unit)) Equal to GapGenUnitType))
Unit Group - Pick every unit in GapGenTempUnitGroup and do (Actions)
Loop - Actions
Set Variable Set GapGenUnit = (Picked unit)
Trigger - Run GapGenOnIndexTrigger (checking conditions)
Custom script: call DestroyGroup(udg_GapGenTempUnitGroup)
GapGeneratorOnEnter
Events
Game - UnitIndexEvent becomes Equal to 1.00
Conditions
Actions
Set Variable Set GapGenUnit = UDexUnits[UDex]
Trigger - Run GapGenOnIndexTrigger (checking conditions)
GapGeneratorOnIndex
Events
Conditions
Actions
For each (Integer GapGenUnitTypeLoop ) from 1 to GapGenUnitTypeTotal , do (Actions)
Loop - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
(Unit-type of GapGenUnit) Equal to GapGenUnitTypeList[GapGenUnitTypeLoop]
Then - Actions
-------- Player Filter --------
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
GapGenUnitTypeAffectEnemyList[GapGenUnitTypeLoop] Equal to True
Then - Actions
Set Variable Set GapGenUnitPlayerGroup = (All enemies of (Owner of GapGenUnit).)
Else - Actions
Set Variable Set GapGenUnitPlayerGroup = (All allies of (Owner of GapGenUnit).)
-------- Visibility Filter --------
Set Variable Set GapGenUnitTempLoc = (Position of GapGenUnit)
Player Group - Pick every player in GapGenUnitPlayerGroup and do (Actions)
Loop - Actions
Set Variable Set GapGenMaxIndex = (GapGenMaxIndex + 1)
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
GapGenUnitTypeVisList[GapGenUnitTypeLoop] Equal to GapGenVISBLACKMASK
Then - Actions
Visibility - Create an initially Enabled visibility modifier for (Picked player) emitting Black mask from GapGenUnitTempLoc to a radius of GapGenUnitTypeRangeList[GapGenUnitTypeLoop] .
Else - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
GapGenUnitTypeVisList[GapGenUnitTypeLoop] Equal to GapGenVISFOGOFWAR
Then - Actions
Visibility - Create an initially Enabled visibility modifier for (Picked player) emitting Fog of war from GapGenUnitTempLoc to a radius of GapGenUnitTypeRangeList[GapGenUnitTypeLoop] .
Else - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
GapGenUnitTypeVisList[GapGenUnitTypeLoop] Equal to GapGenVISVISIBLE
Then - Actions
Visibility - Create an initially Enabled visibility modifier for (Picked player) emitting Visibility from GapGenUnitTempLoc to a radius of GapGenUnitTypeRangeList[GapGenUnitTypeLoop] .
Else - Actions
Set Variable Set GapGenVisibility[GapGenMaxIndex] = (Last created visibility modifier)
Set Variable Set GapGenUnitCurrentTimer[GapGenMaxIndex] = GapGenUnitTypeRefRateList[GapGenUnitTypeLoop]
Set Variable Set GapGenUnitSource[GapGenMaxIndex] = GapGenUnit
Custom script: call RemoveLocation(udg_GapGenUnitTempLoc)
Custom script: call DestroyForce(udg_GapGenUnitPlayerGroup)
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
(GapGenLoopTrigger is on) Equal to False
Then - Actions
Trigger - Turn on GapGenLoopTrigger
Else - Actions
Else - Actions
GapGeneratorLoop
Events
Conditions
Actions
For each (Integer GapGenIndex ) from 1 to GapGenMaxIndex , do (Actions)
Loop - Actions
Set Variable Set GapGenUnit = GapGenUnitSource[GapGenIndex]
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
Or - Any (Conditions) are true
Conditions
(GapGenUnit is dead) Equal to True
GapGenUnitCurrentTimer[GapGenIndex] Less than or equal to 0.00
Then - Actions
-------- Removal --------
Visibility - Disable GapGenVisibility[GapGenIndex]
Visibility - Destroy GapGenVisibility[GapGenIndex]
-------- Deallocation --------
Set Variable Set GapGenVisibility[GapGenIndex] = GapGenVisibility[GapGenMaxIndex]
Set Variable Set GapGenUnitCurrentTimer[GapGenIndex] = GapGenUnitCurrentTimer[GapGenMaxIndex]
Set Variable Set GapGenUnitSource[GapGenIndex] = GapGenUnitSource[GapGenMaxIndex]
Set Variable Set GapGenIndex = (GapGenIndex - 1)
Set Variable Set GapGenMaxIndex = (GapGenMaxIndex - 1)
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
GapGenMaxIndex Equal to 0
Then - Actions
Trigger - Turn off GapGenLoopTrigger
Else - Actions
-------- Allocate new instance if still alive and all instances of this unit deallocated --------
Set Variable Set GapGenRealloc = "true"
For each (Integer GapGenCheckIndex ) from 1 to GapGenMaxIndex , do (Actions)
Loop - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
GapGenUnit Equal to GapGenUnitSource[GapGenCheckIndex]
Then - Actions
Set Variable Set GapGenRealloc = "false"
Else - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
GapGenRealloc Equal to True
(GapGenUnit is alive) Equal to True
Then - Actions
Trigger - Run GapGenOnIndexTrigger (checking conditions)
Else - Actions
Else - Actions
Set Variable Set GapGenUnitCurrentTimer[GapGenIndex] = (GapGenUnitCurrentTimer[GapGenIndex] - GapGenSysRefRate)
Unit Indexer might need to be upgraded into Unit Events
GapGeneratorRegister Farm
Events
Game - GapGenEvent becomes Equal to 1.00
Conditions
Actions
-------- COPY THIS TRIGGER TO REGISTER MULTIPLE UNITS --------
-------- DON'T FORGET TO TICK ENABLED --------
-------- Unit type to register --------
Set Variable Set GapGenUnitType = "hhou"
-------- Range of the gap effect --------
Set Variable Set GapGenUnitTypeRange = "500.00"
-------- Refresh Rate for gaps --------
Set Variable Set GapGenUnitTypeRefRate = "10000.00"
-------- There are 3 option for this: VISBLACKMASK, VISFOGOFWAR, VISVISIBLE, each representing the modifier that will be applied --------
Set Variable Set GapGenUnitTypeVis = GapGenVISBLACKMASK
-------- If set to False, will affect allies and self instead --------
Set Variable Set GapGenUnitTypeAffectEnemy = "false"
-------- END CONFIG --------
Trigger - Run GapGenRegisterTrigger (checking conditions)
GapGeneratorRegister Ogre Lord
Events
Game - GapGenEvent becomes Equal to 1.00
Conditions
Actions
-------- COPY THIS TRIGGER TO REGISTER MULTIPLE UNITS --------
-------- DON'T FORGET TO TICK ENABLED --------
-------- Unit type to register --------
Set Variable Set GapGenUnitType = "nogl"
-------- Range of the gap effect --------
Set Variable Set GapGenUnitTypeRange = "500.00"
-------- Refresh Rate for gaps --------
Set Variable Set GapGenUnitTypeRefRate = "0.50"
-------- There are 3 option for this: VISBLACKMASK, VISFOGOFWAR, VISVISIBLE, each representing the modifier that will be applied --------
Set Variable Set GapGenUnitTypeVis = GapGenVISBLACKMASK
-------- If set to False, will affect allies and self instead --------
Set Variable Set GapGenUnitTypeAffectEnemy = "false"
-------- END CONFIG --------
Trigger - Run GapGenRegisterTrigger (checking conditions)
Ogre Lord Patrol
Events
Time - Elapsed game time is 0.00 seconds
Time - Every 60.00 seconds of game time
Conditions
Actions
Unit - Order Ogre Lord 0242 <gen> to Patrol To . (Player 3 (Teal) start location)
Player Teal Visible
Events
Map initialization
Conditions
Actions
Player - For Player 3 (Teal) , turn Shared vision On toward Player 1 (Red)
Top