# Unit Enters/Leaves Region
Grammar — u state|Enters/Leaves r
Flags —Native
|Event
This event fires when a unit enters or leaves a region. Use “Triggering Player” to get the player that was controlling the unit. Use “Triggering Region” to get the region that the unit either entered or left. Use “Triggering Unit” to get the unit.
# Arguments
unitref
[ unit ] — Unitregion
— Regionbool
[ preset::RegionEnterLeaveState ] — State
Returns — void
native void TriggerAddEventUnitRegion(
trigger t,
unitref u,
region r,
bool state,
);
# Event parameters
- Triggering Game User — EventGameUser
- Triggering Player — EventPlayer
- Triggering Region — EventUnitRegion
- Triggering Unit — EventUnit
# Related
Category: Unit / Basic
- [F] —
void
— Unit Show Kill Display — ( UnitShowKillDisplay ) - [F] —
bool
— Unit Can Path To Point — ( UnitPathableToPoint ) - [F] —
bool
— Unit Can Path To Unit — ( UnitPathableToUnit ) - [F] —
void
— Create Units With Default Facing — ( libNtve_gf_CreateUnitsWithDefaultFacing ) - [F] —
void
— Create Units With Point Facing — ( libNtve_gf_CreateUnitsAtPoint2 ) - [F] —
unitgroup
— Create Units Facing Angle — ( UnitCreate ) - [F] —
unitgroup
— Create Units Facing Point — ( libNtve_gf_UnitCreateFacingPoint ) - [F] —
unit
— Last Created Unit — ( UnitLastCreated ) - [F] —
unitgroup
— Last Created Units — ( UnitLastCreatedGroup ) - [F] —
unit
— Original Caster Of Unit — ( UnitGetOriginalCaster ) - [F] —
string
[ gamelink::Effect ] — Effect That Created Unit — ( UnitGetOriginalEffect ) - [F] —
void
— Replace Unit — ( libNtve_gf_ReplaceUnit ) - [F] —
unit
— Last Replaced Unit — ( libNtve_gf_LastReplacedUnit ) - [F] —
void
— Change Owner — ( UnitSetOwner ) - [F] —
void
— Unit Owner Changes — ( TriggerAddEventUnitChangeOwner ) - [F] —
int
— Old Unit Owner — ( EventUnitOwnerOld ) - [F] —
int
— New Unit Owner — ( EventUnitOwnerNew ) - [F] —
void
— Rescue Unit — ( libNtve_gf_RescueUnit ) - [F] —
void
— Rescue Unit Group — ( libNtve_gf_RescueUnit2 ) - [F] —
void
— Kill Unit — ( UnitKill ) - [F] —
void
— Revive Unit — ( UnitRevive ) - [F] —
void
— Remove Unit — ( UnitRemove ) - [F] —
int
— Owner Of Unit — ( UnitGetOwner ) - [F] —
bool
— Unit Is Alive — ( UnitIsAlive ) - [F] —
bool
— Unit Is Valid — ( UnitIsValid ) - [F] —
bool
— Unit Group Is Dead — ( libNtve_gf_UnitGroupIsDead ) - [F] —
void
— Move Unit Instantly — ( UnitSetPosition ) - [F] —
void
— Make Unit Face Angle — ( UnitSetFacing ) - [F] —
void
— Make Unit Face Point — ( libNtve_gf_MakeUnitFacePoint ) - [F] —
point
— Position Of Unit — ( UnitGetPosition ) - [F] —
point
— Goal Position Of Unit — ( UnitGetGoalPosition ) - [F] —
fixed
— Facing Angle Of Unit — ( UnitGetFacing ) - [F] —
void
— Pause/Unpause Unit — ( libNtve_gf_PauseUnit ) - [F] —
void
— Pause/Unpause All Units — ( UnitPauseAll ) - [F] —
void
— Sleep/WakeUp Unit — ( libNtve_gf_SleepUnit ) - [F] —
void
— Show/Hide Unit — ( libNtve_gf_ShowHideUnit ) - [F] —
void
— Share Vision of Unit — ( libNtve_gf_ShareVisionofUnit ) - [F] —
bool
— Unit Is Paused — ( libNtve_gf_UnitIsPaused ) - [F] —
bool
— Unit Is Sleepiing — ( libNtve_gf_UnitIsSleepiing ) - [F] —
bool
— Unit Is Hidden — ( libNtve_gf_UnitIsHidden ) - [F] —
bool
— Unit Is Visible To Player — ( libNtve_gf_UnitIsVisibleToPlayer ) - [F] —
void
— Set Unit Custom Value — ( UnitSetCustomValue ) - [F] —
fixed
— Custom Value Of Unit — ( UnitGetCustomValue ) - [F] —
void
— Unit Enters/Leaves Region — ( TriggerAddEventUnitRegion ) - [F] —
region
— Triggering Region — ( EventUnitRegion ) - [F] —
void
— Unit Enters/Leaves Point — ( TriggerAddEventUnitRangePoint ) - [F] —
void
— Unit Enters/Leaves Range Of Unit — ( TriggerAddEventUnitRange ) - [F] —
unit
— Triggering Range Unit — ( EventUnitRangeUnit ) - [F] —
bool
— Unit In Region — ( libNtve_gf_UnitInRegion ) - [F] —
unit
— Triggering Unit — ( EventUnit ) - [F] —
void
— Load Unit Model — ( UnitLoadModel ) - [F] —
void
— Unload Unit Model — ( UnitUnloadModel ) - [F] —
unit
— Agent Of Player For Unit — ( UnitAgent ) - [F] —
void
— Change Empty Unit Variables In Events — ( UnitEventSetNullVariableInvalid ) - [F] —
text
— Name of Unit — ( UnitGetName ) - [F] —
int
— Ideal Harvester Count — ( UnitIdealWorkerCount ) - [F] —
int
— Current Harvester Count — ( UnitCurrentWorkerCount )
# Examples
# campaigns/liberty.sc2campaign
// L1704
TriggerAddEventUnitRegion(gt_Interceptors, null, RegionEntireMap(), true)
// L836
TriggerAddEventUnitRegion(gt_ArchonMerge, null, RegionEntireMap(), true)
// L1786
TriggerAddEventUnitRegion(gt_IntroArchons, null, RegionFromId(31), true)
// L1787
TriggerAddEventUnitRegion(gt_IntroArchons, null, RegionFromId(32), true)
// L934
TriggerAddEventUnitRegion(gt_SuicideZealots, null, RegionEntireMap(), true)
// L1613
TriggerAddEventUnitRegion(gt_SpawnedPlayerUnits, null, RegionEntireMap(), true)
// L4957
TriggerAddEventUnitRegion(gt_Level1BossInterceptorSpawned, null, RegionEntireMap(), true)
// L5971
TriggerAddEventUnitRegion(gt_TerraTronSawSpawned, null, RegionEntireMap(), true)
// L1118
TriggerAddEventUnitRegion(gt_RemoveDropships, UnitRefFromUnit(UnitFromId(290)), RegionFromId(31), true)
// L1346
TriggerAddEventUnitRegion(gt_Zerg2, null, RegionFromId(32), true)
// L1534
TriggerAddEventUnitRegion(gt_SwitchtoEscortPhase, null, RegionFromId(29), true)
// L1872
TriggerAddEventUnitRegion(gt_TIPZergCreep, null, RegionFromId(51), true)
// L1873
TriggerAddEventUnitRegion(gt_TIPZergCreep, null, RegionFromId(41), true)
// L2579
TriggerAddEventUnitRegion(gt_AddConvoyMarineintoUnitGroup, null, RegionFromId(15), true)
// L2740
TriggerAddEventUnitRegion(gt_BunkerGet1, null, RegionFromId(27), true)
// L2772
TriggerAddEventUnitRegion(gt_BunkerGet2, null, RegionFromId(28), true)
// L2855
TriggerAddEventUnitRegion(gt_ChrysalisTipTriggerA, null, RegionFromId(23), true)
// L2893
TriggerAddEventUnitRegion(gt_ChrysalisTipTriggerB, null, RegionFromId(24), true)
// L2354
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(9), true)
// L2355
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(10), true)
// L2356
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(28), true)
// L2357
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(11), true)
// L2358
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(12), true)
// L2359
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(39), true)
// L2360
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(1), true)
// L2361
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(22), true)
// L2362
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(13), true)
// L2363
TriggerAddEventUnitRegion(gt_AreaRevealers, null, RegionFromId(21), true)
// L1338
TriggerAddEventUnitRegion(gt_EradicationPointAlpha, null, RegionFromId(13), true)
// L1448
TriggerAddEventUnitRegion(gt_EradicationPointBeta, null, RegionFromId(15), true)
// L1562
TriggerAddEventUnitRegion(gt_EradicationPointGamma, null, RegionFromId(16), true)
// L1676
TriggerAddEventUnitRegion(gt_EradicationPointOmega, null, RegionFromId(17), true)
// L1767
TriggerAddEventUnitRegion(gt_EradicatePlayersBase, null, RegionFromId(22), true)
// L2353
TriggerAddEventUnitRegion(gt_TerrorFleetBetaBaseBehavior, null, RegionFromId(11), true)
// L2417
TriggerAddEventUnitRegion(gt_TerrorFleetGammaBaseBehavior, null, RegionFromId(12), true)
// L2481
TriggerAddEventUnitRegion(gt_TerrorFleetOmegaBaseBehavior, null, RegionFromId(8), true)
// L2670
TriggerAddEventUnitRegion(gt_RemoveTerrorFleets, null, RegionFromId(31), true)
// L2671
TriggerAddEventUnitRegion(gt_RemoveTerrorFleets, null, RegionFromId(32), true)
// L2468
TriggerAddEventUnitRegion(gt_ColonistLoad, null, RegionFromId(10), true)
// L2469
TriggerAddEventUnitRegion(gt_ColonistLoad, null, RegionFromId(9), true)
// L2470
TriggerAddEventUnitRegion(gt_ColonistLoad, null, RegionFromId(13), true)
// L2471
TriggerAddEventUnitRegion(gt_ColonistLoad, null, RegionFromId(8), true)
// L2472
TriggerAddEventUnitRegion(gt_ColonistLoad, null, RegionFromId(3), true)
// L2473
TriggerAddEventUnitRegion(gt_ColonistLoad, null, RegionFromId(7), true)
// L2454
TriggerAddEventUnitRegion(gt_TrainDespawn, null, RegionCircle(PointFromId(491), 1.0), true)
// L2455
TriggerAddEventUnitRegion(gt_TrainDespawn, null, RegionCircle(PointFromId(502), 1.0), true)
// L2456
TriggerAddEventUnitRegion(gt_TrainDespawn, null, RegionCircle(PointFromId(297), 1.0), true)
// L2581
TriggerAddEventUnitRegion(gt_EscortDespawn, null, RegionFromId(2), true)
// L3167
TriggerAddEventUnitRegion(gt_TrainDespawnAnimationsTop, null, RegionCircle(PointFromId(491), 16.0), true)
// L3200
TriggerAddEventUnitRegion(gt_TrainDespawnAnimationsMid, null, RegionCircle(PointFromId(502), 16.0), true)
// L3233
TriggerAddEventUnitRegion(gt_TrainDespawnAnimationsBottom, null, RegionCircle(PointFromId(297), 16.0), true)
// L1176
TriggerAddEventUnitRegion(gt_ChangeOwnerofDropshipUnits, null, RegionFromId(4), true)
// L1600
TriggerAddEventUnitRegion(gt_ChangeOwnerofVultureDropshipUnits, null, RegionFromId(4), true)
// L1917
TriggerAddEventUnitRegion(gt_JunkerNEPitstop1, null, RegionFromId(32), true)
// L1964
TriggerAddEventUnitRegion(gt_JunkerNEPitstop2, null, RegionFromId(33), true)
// L2009
TriggerAddEventUnitRegion(gt_JunkerNEPitstop3, null, RegionFromId(34), true)
// L2040
TriggerAddEventUnitRegion(gt_JunkerNEDespawn, null, RegionFromId(31), true)
// L2123
TriggerAddEventUnitRegion(gt_JunkerSPitstop1, null, RegionFromId(36), true)
// L2170
TriggerAddEventUnitRegion(gt_JunkerSPitstop2, null, RegionFromId(37), true)
// L2201
TriggerAddEventUnitRegion(gt_JunkerSDespawn, null, RegionFromId(35), true)
// L2281
TriggerAddEventUnitRegion(gt_JunkerWPitstop1, null, RegionFromId(38), true)
// L913
TriggerAddEventUnitRegion(gt_WarehouseBullies2, null, RegionFromId(17), true)
// L1193
TriggerAddEventUnitRegion(gt_VictoryWarehouseDudesKilled, null, RegionFromId(24), true)
// L1842
TriggerAddEventUnitRegion(gt_LokiActivates, null, RegionFromId(23), true)
// L2044
TriggerAddEventUnitRegion(gt_OdinApproachesP04Base, UnitRefFromUnit(UnitFromId(2)), RegionFromId(21), true)
// L2283
TriggerAddEventUnitRegion(gt_OdinApproachesP08Base, UnitRefFromUnit(UnitFromId(2)), RegionFromId(28), true)
// L2543
TriggerAddEventUnitRegion(gt_OdinApproachesP05Base, UnitRefFromUnit(UnitFromId(2)), RegionFromId(6), true)
// L2788
TriggerAddEventUnitRegion(gt_OdinApproachesP06Base, UnitRefFromUnit(UnitFromId(2)), RegionFromId(11), true)
// L3064
TriggerAddEventUnitRegion(gt_OdinApproachesP07Base, UnitRefFromUnit(UnitFromId(2)), RegionFromId(12), true)
// L3154
TriggerAddEventUnitRegion(gt_BattlecruisersYamatoOdin, UnitRefFromUnit(UnitFromId(2)), RegionFromId(10), true)
// L1956
TriggerAddEventUnitRegion(gt_CityAmbienceNorthSpawnVehicleRemoval, null, RegionFromId(14), true)
// L1988
TriggerAddEventUnitRegion(gt_CityAmbienceSESpawnVehicleRemoval, null, RegionFromId(15), true)
// L2020
TriggerAddEventUnitRegion(gt_CityAmbienceSWSpawnVehicleRemoval, null, RegionFromId(20), true)
// L2051
TriggerAddEventUnitRegion(gt_CityAmbienceWestBlimpRemoval, null, RegionFromId(1), true)
// L2082
TriggerAddEventUnitRegion(gt_CityAmbienceEastBlimpRemoval, null, RegionFromId(2), true)
// L2954
TriggerAddEventUnitRegion(gt_Statue1, null, RegionFromId(16), true)
// L3005
TriggerAddEventUnitRegion(gt_Statue2, null, RegionFromId(23), true)
// L3056
TriggerAddEventUnitRegion(gt_Statue3, null, RegionFromId(19), true)
// L3107
TriggerAddEventUnitRegion(gt_Statue4, null, RegionFromId(21), true)
// L3158
TriggerAddEventUnitRegion(gt_Statue5, null, RegionFromId(24), true)
// L2278
TriggerAddEventUnitRegion(gt_AlertTeamResponseAttack, null, RegionFromId(30), true)
// L2307
TriggerAddEventUnitRegion(gt_HybridAreaLastRoom, null, RegionFromId(25), true)
// L2340
TriggerAddEventUnitRegion(gt_ShutDoor01, null, RegionFromId(71), true)
// L2374
TriggerAddEventUnitRegion(gt_ShutDoor02, null, RegionFromId(66), true)
// L2402
TriggerAddEventUnitRegion(gt_Stasis01, null, RegionFromId(133), true)
// L2430
TriggerAddEventUnitRegion(gt_Stasis02, null, RegionFromId(137), true)
// L2458
TriggerAddEventUnitRegion(gt_Stasis03, null, RegionFromId(138), true)
// L2486
TriggerAddEventUnitRegion(gt_Stasis04, null, RegionFromId(144), true)
// L2514
TriggerAddEventUnitRegion(gt_Stasis05, null, RegionFromId(145), true)
// L3590
TriggerAddEventUnitRegion(gt_Computer01TurretGunsVisibilityEnter, null, RegionFromId(153), true)
// L890
TriggerAddEventUnitRegion(gt_Dogmeatgo, null, RegionCircle(PointFromId(632), 3.0), true)
// L936
TriggerAddEventUnitRegion(gt_GohomeDogmeat, null, RegionCircle(PointFromId(672), 3.0), true)
// L1094
TriggerAddEventUnitRegion(gt_RoadblockView, null, RegionFromId(64), true)
// L1157
TriggerAddEventUnitRegion(gt_RoadblockAggroQ, null, RegionFromId(52), true)
// L1287
TriggerAddEventUnitRegion(gt_FirstHoloboardencounter, null, RegionFromId(13), true)
// L1365
TriggerAddEventUnitRegion(gt_WhereisEveryoneQ, null, RegionFromId(8), true)
// L1494
TriggerAddEventUnitRegion(gt_ThisisuglyQ, null, RegionFromId(2), true)
// L1699
TriggerAddEventUnitRegion(gt_RiksvilleAutoSave01, null, RegionFromId(61), true)
// L1946
TriggerAddEventUnitRegion(gt_RiksvilleTownSquareVikingRemove, null, RegionFromId(37), true)
// L2036
TriggerAddEventUnitRegion(gt_SouthieMarineaggroProximity, null, RegionFromId(11), true)