• 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

cloaking invisbility system with events 1-3.w3m
Variables
Variables
This Map Only
On Cloak Test
On DeCloak Test
Melee Initialization
Test Init
Unit Indexer
Unit Indexer
Cloaking System
Instructions
cloaking system custom scripts
Cloaking System Decloak on Attack
Cloaking System Decloak on Cast
Cloaking System Periodic
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 except Custom Script Item. Custom Script Item will merge into map script after globals variables declaration with the list order in trigger view.
Name Type is_array initial_value
cloaking_system_ability abilcode No A000
cloaking_system_ability_codes abilcode Yes
cloaking_system_base_values real Yes
cloaking_system_cltriggers trigger Yes
cloaking_system_decltriggers trigger Yes
cloaking_system_enumunit unit No
cloaking_system_increments real Yes
cloaking_system_timers timer Yes
cloaking_system_unitgroup group No
IsUnitPreplaced boolean Yes
u 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
On Cloak Test
Events
Conditions
Actions
Game - Display to (All players) the text: ((Name of cloaking_system_enumunit) + Cloaked)
On DeCloak Test
Events
Conditions
Actions
Game - Display to (All players) the text: ((Name of cloaking_system_enumunit) + Decloaked)
Default melee game initialization for all players
Melee Initialization
Events
Map initialization
Conditions
Actions
Melee Game - Use melee time of day (for all players)
Melee Game - Limit Heroes to 1 per Hero-type (for all players)
Melee Game - Give trained Heroes a Scroll of Town Portal (for all players)
Melee Game - Set starting resources (for all players)
Melee Game - Remove creeps and critters from used start locations (for all players)
Melee Game - Create starting units (for all players)
Melee Game - Run melee AI scripts (for computer players)
Melee Game - Enforce victory/defeat conditions (for all players)
Test Init
Events
Time - Elapsed game time is 0.00 seconds
Conditions
Actions
Set Variable Set u = Paladin 0001 <gen>
Custom script: call CloakingSystemAddUnit(udg_u,0,5.0,0.0,gg_trg_On_Cloak_Test,gg_trg_On_DeCloak_Test,1.0)
This trigger works in two key phases:

1) During map initialization, enumerate all existing units of all players to give them an index.
2) Adds a second event to itself to index new units as they enter the map.

As a unit enters the map, check for any old units that may have been removed at some point in order to free their index.
Unit Indexer
Events
Map initialization
Conditions
Actions
Custom script: call ExecuteFunc("InitializeUnitIndexer")
Custom script: endfunction
-------- --------
-------- This is the core function - it provides an index all existing units and for units as they enter the map --------
-------- --------
Custom script: function IndexUnit takes nothing returns boolean
Custom script: local integer pdex = udg_UDex
Custom script: local integer ndex
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
IsUnitPreplaced[0] Equal to False
Then - Actions
-------- --------
-------- Check for removed units for every (32) new units created --------
-------- --------
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
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
-------- --------
-------- Remove index from linked list --------
-------- --------
Custom script: set ndex = udg_UDexNext[udg_UDex]
Custom script: set udg_UDexNext[udg_UDexPrev[udg_UDex]] = ndex
Custom script: set udg_UDexPrev[ndex] = udg_UDexPrev[udg_UDex]
Set Variable Set UDexPrev[UDex] = "0"
Set Variable Set IsUnitPreplaced[UDex] = "false"
-------- --------
-------- Fire deindex event for UDex --------
-------- --------
Set Variable Set UnitIndexEvent = "2.00"
Set Variable Set UnitIndexEvent = "0.00"
-------- --------
-------- Recycle the index for later use --------
-------- --------
Set Variable Set UDexUnits[UDex] = No unit
Set Variable Set UDexNext[UDex] = UDexRecycle
Set Variable Set UDexRecycle = UDex
Custom script: set udg_UDex = ndex
Else - Actions
Set Variable Set UDex = UDexNext[UDex]
Custom script: endloop
Else - Actions
Else - Actions
-------- --------
-------- You can use the boolean UnitIndexerEnabled to protect some of your undesirable units from being indexed --------
-------- - Example: --------
-------- -- Set UnitIndexerEnabled = False --------
-------- -- Unit - Create 1 Dummy for (Triggering player) at TempLoc facing 0.00 degrees --------
-------- -- Set UnitIndexerEnabled = True --------
-------- --------
-------- You can also 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
-------- --------
-------- Generate a unique integer index for this unit --------
-------- --------
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]
-------- --------
-------- Link index to unit, unit to index --------
-------- --------
Set Variable Set UDexUnits[UDex] = (Matching unit)
Unit - Set the custom value of UDexUnits[UDex] to UDex
Set Variable Set IsUnitPreplaced[UDex] = IsUnitPreplaced[0]
-------- --------
-------- Use a doubly-linked list to store all active indexes --------
-------- --------
Set Variable Set UDexPrev[UDexNext[0]] = UDex
Set Variable Set UDexNext[UDex] = UDexNext[0]
Set Variable Set UDexNext[0] = UDex
-------- --------
-------- Fire index event for UDex --------
-------- --------
Set Variable Set UnitIndexEvent = "0.00"
Set Variable Set UnitIndexEvent = "1.00"
Set Variable Set UnitIndexEvent = "0.00"
Else - Actions
Custom script: set udg_UDex = pdex
Custom script: return false
Custom script: endfunction
-------- --------
-------- The next function initializes the core of the system --------
-------- --------
Custom script: function InitializeUnitIndexer takes nothing returns nothing
Custom script: local integer i = 0
Custom script: local region re = CreateRegion()
Custom script: local rect r = GetWorldBounds()
Custom script: local boolexpr b = Filter(function IndexUnit)
Set Variable Set UnitIndexEvent = "-1.00"
Set Variable Set UnitIndexerEnabled = "true"
Set Variable Set IsUnitPreplaced[0] = "true"
Custom script: call RegionAddRect(re, r)
Custom script: call TriggerRegisterEnterRegion(CreateTrigger(), re, b)
Custom script: call RemoveRect(r)
Custom script: set re = null
Custom script: set r = null
Custom script: loop
Custom script: call GroupEnumUnitsOfPlayer(bj_lastCreatedGroup, Player(i), b)
Custom script: set i = i + 1
Custom script: exitwhen i == bj_MAX_PLAYER_SLOTS
Custom script: endloop
Custom script: set b = null
-------- --------
-------- This is the "Unit Indexer Initialized" event, use it instead of "Map Initialization" for best results --------
-------- --------
Set Variable Set IsUnitPreplaced[0] = "false"
Set Variable Set UnitIndexEvent = "3.00"
How to install:

1. Add any Unit Indexer into your map
2. Copy the "Cloaking System" folder into your map
3. Set cloaking_system_ability to the rawcode of an ability based on Permanent Invisbility. Set the durations to 0 since they are handled by the system,

How to add a unit to the system:
1. use the following custom script:
call CloakingSystemAddUnit(unit, rawcode, base_fade_duration, fade_duration_per_level, oncloaktrigger, ondecloaktrigger,delay)

Explaination of paremeters:

unit: The unit you wish to cloak.

rawcode: If set to an abilty rawcode, used in conjunction with fade_duration_per_level. The ability whose level is used in calculating the decrease in fade duation per level. Set to 0 if you wish for a constant fade duration.

base_fade_duration: the base duration between the unit being decloaked from casting or attacking to when it becomes invisible again.

fade_duration_per_level: this value x the level of rawcode is subtracted from base_fade_duration to determine how long before the unit becomes invisible again. Set to 0 if you wish for a constant fade duration.

oncloaktrigger: Trigger to execute when the unit becomes invisible because the fade duration has passed (will also execute when the unit is first added to the system and the delay has expired). Use cloaking_system_enum_unit to get the unit that is cloaking. Set to null to ignore.

oncloaktrigger: Trigger to execute when the unit breaks invisbility by attacking or casting a spell. Use cloaking_system_enum_unit to get the unit that is decloaking. Set to null to ignore.

delay: Delay between when a unit is first added to the system and when it first cloaks. Set to 0 to cloak as soon as the unit its added.

--------

The formula for fade duration is base_fade_duration - (fade_duration_per_level x the level of rawcode for the unit)

Use cloaking_system_enumunit to get the unit that is cloaking or decloaking in events
function CloakingSystemAddUnit takes unit u, integer abilcode, real base, real increment, trigger oncloak, trigger ondecloak, real delay returns nothing
	local integer udata = GetUnitUserData(u)
	if udg_cloaking_system_timers[udata] == null then
		set udg_cloaking_system_timers[udata] = CreateTimer()
	endif
	call TimerStart(udg_cloaking_system_timers[udata],delay,false,null)
	set udg_cloaking_system_ability_codes[udata]=abilcode
	set udg_cloaking_system_base_values[udata]=base
	set udg_cloaking_system_increments[udata]=increment
	set udg_cloaking_system_cltriggers[udata]=oncloak	
	set udg_cloaking_system_decltriggers[udata]=ondecloak
	call GroupAddUnit(udg_cloaking_system_unitgroup,u)
	call EnableTrigger(gg_trg_Cloaking_System_Periodic)
endfunction
function CloakingSystemRemoveUnit takes unit u returns nothing
	call PauseTimer(udg_cloaking_system_timers[GetUnitUserData(u)])
	call DestroyTimer(udg_cloaking_system_timers[GetUnitUserData(u)])
	set udg_cloaking_system_timers[GetUnitUserData(u)]=null
	call UnitRemoveAbility(u,udg_cloaking_system_ability)	
	call GroupRemoveUnit(udg_cloaking_system_unitgroup,u)
	if BlzGroupGetSize(udg_cloaking_system_unitgroup) == 0 then
		call DisableTrigger(gg_trg_Cloaking_System_Periodic)
	endif
endfunction
Cloaking System Decloak on Attack
Events
Unit - A unit Is attacked
Conditions
((Attacking unit) is in cloaking_system_unitgroup.) Equal to True
Actions
Countdown Timer - Start cloaking_system_timers[(Custom value of (Attacking unit))] as a One-shot timer that will expire in (cloaking_system_base_values[(Custom value of (Attacking unit))] - ((Real((Level of cloaking_system_ability_codes[(Custom value of (Attacking unit))] for (Attacking unit)))) x cloaking_system_increments[(Custom value of (Attacking unit))])) seconds
Cloaking System Decloak on Cast
Events
Unit - A unit Starts the effect of an ability
Conditions
((Triggering unit) is in cloaking_system_unitgroup.) Equal to True
Actions
Countdown Timer - Start cloaking_system_timers[(Custom value of (Triggering unit))] as a One-shot timer that will expire in (cloaking_system_base_values[(Custom value of (Triggering unit))] - ((Real((Level of cloaking_system_ability_codes[(Custom value of (Triggering unit))] for (Triggering unit)))) x cloaking_system_increments[(Custom value of (Triggering unit))])) seconds
Cloaking System Periodic
Events
Time - Every 0.03 seconds of game time
Conditions
Actions
Unit Group - Pick every unit in cloaking_system_unitgroup and do (Actions)
Loop - Actions
Set Variable Set cloaking_system_enumunit = (Picked unit)
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
(Remaining time for cloaking_system_timers[(Custom value of cloaking_system_enumunit)]) Less than or equal to 0.00
Then - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
(Level of cloaking_system_ability for cloaking_system_enumunit) Equal to 0
Then - Actions
Unit - Add cloaking_system_ability to cloaking_system_enumunit
Custom script: call UnitMakeAbilityPermanent(udg_cloaking_system_enumunit,true,udg_cloaking_system_ability)
Trigger - Run cloaking_system_cltriggers[(Custom value of cloaking_system_enumunit)] (checking conditions)
Else - Actions
Else - Actions
If (All Conditions are True) then do (Then Actions) else do (Else Actions)
If - Conditions
(Level of cloaking_system_ability for cloaking_system_enumunit) Greater than 0
Then - Actions
Unit - Remove cloaking_system_ability from cloaking_system_enumunit
Trigger - Run cloaking_system_decltriggers[(Custom value of cloaking_system_enumunit)] (checking conditions)
Else - Actions
Top