# Replace Unit

Grammar — Replace unit with a unitType using options|Replace Unit Options vitals
Flags — Action

Use “Last Replaced Unit” to refer to the replacement unit. Note that any variables referring to the old unit will need to be updated.

# Arguments

• unit — Unit
• string [ gamelink::Unit ] — Unit-Type
• int [ preset::ReplaceUnitOptions ] — Options

Returns — void

void libNtve_gf_ReplaceUnit(
	unit lp_unit,
	string lp_unitType,
	int lp_options,
);

# 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/swarm.sc2campaign

— MapScript.galaxy

// L8988
libNtve_gf_ReplaceUnit(UnitFromId(1020), "XelNaga_Caverns_Floating_BridgeH8", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L1347
libNtve_gf_ReplaceUnit(auto9CD86608_var, "InfestedTerranCampaign", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L10697
libNtve_gf_ReplaceUnit(gv_mainDoor, "UmojanLabDoorsThinRightLowered", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L1229
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Hydralisk", 1)

// L960
libNtve_gf_ReplaceUnit(EventUnit(), "MutaliskBroodlord", libNtve_ge_ReplaceUnitOptions_NewUnitssMax)

// L4208
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Viper", libNtve_ge_ReplaceUnitOptions_NewUnitssMax)

// L1084
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Roach", 1)

// L878
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "SwarmHost", 1)

// L1623
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "SwarmHost", 1)

// L1310
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Ultralisk", 1)

// L2129
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Ultralisk", 1)

// L1229
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Hydralisk", 1)

// L960
libNtve_gf_ReplaceUnit(EventUnit(), "MutaliskBroodlord", libNtve_ge_ReplaceUnitOptions_NewUnitssMax)

// L4208
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Viper", libNtve_ge_ReplaceUnitOptions_NewUnitssMax)

// L1084
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Roach", 1)

// L878
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "SwarmHost", 1)

// L1623
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "SwarmHost", 1)

// L1310
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Ultralisk", 1)

// L2129
libNtve_gf_ReplaceUnit(UnitGroupLoopCurrent(), "Ultralisk", 1)

// L1347
libNtve_gf_ReplaceUnit(auto9CD86608_var, "InfestedTerranCampaign", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L10697
libNtve_gf_ReplaceUnit(gv_mainDoor, "UmojanLabDoorsThinRightLowered", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L8988
libNtve_gf_ReplaceUnit(UnitFromId(1020), "XelNaga_Caverns_Floating_BridgeH8", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L454
libNtve_gf_ReplaceUnit(autoDF7AB5E9_var, "InfestedTerranCampaign", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L8217
libNtve_gf_ReplaceUnit(UnitFromId(1489), "BarracksTechReactor", libNtve_ge_ReplaceUnitOptions_NewUnitsDefault)

// L8228
libNtve_gf_ReplaceUnit(UnitFromId(65), "SiegeTankSieged", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L454
libNtve_gf_ReplaceUnit(autoDF7AB5E9_var, "InfestedTerranCampaign", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L8217
libNtve_gf_ReplaceUnit(UnitFromId(1489), "BarracksTechReactor", libNtve_ge_ReplaceUnitOptions_NewUnitsDefault)

// L8228
libNtve_gf_ReplaceUnit(UnitFromId(65), "SiegeTankSieged", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L5192
libNtve_gf_ReplaceUnit(gv_terrazineTankLocations[gv_terrazineTankLocationsCount].lv_terrazineTankUnit, "NovaTerrazineTankDead", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

// L5192
libNtve_gf_ReplaceUnit(gv_terrazineTankLocations[gv_terrazineTankLocationsCount].lv_terrazineTankUnit, "NovaTerrazineTankDead", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)

# mods/starcoop/starcoop.sc2mod

— LibCOMI.galaxy

// L26476
libNtve_gf_ReplaceUnit(auto8B4AE5B8_var, "TychusResearchCenterUnlocked", libNtve_ge_ReplaceUnitOptions_OldUnitsRelative)