# Unit Property
Grammar — u prop (current|Current/Default)
Flags —Native
|Function
Returns a unit property.
# Arguments
unit
— Unitint
[ preset::Unit_Property ] — Propertybool
[ preset::CurrentDefaultOption ] — Current
Returns — fixed
native fixed UnitGetPropertyFixed(
unit inUnit,
int inProp,
bool inCurrent,
);
# Related
Category: Unit / Properties
- [F] —
string
[ gamelink::Unit ] — Unit Type Of Unit — ( UnitGetType ) - [F] —
int
— Unit Tag — ( UnitGetTag ) - [F] —
int
— Unit Seed — ( UnitGetSeed ) - [F] —
void
— Unit Property Changes — ( TriggerAddEventUnitProperty ) - [F] —
int
[ preset::Unit_Property ] — Triggering Unit Property — ( EventUnitProperty ) - [F] —
int
— Triggering Unit Property Change (Integer) — ( EventUnitPropertyChangeInt ) - [F] —
fixed
— Triggering Unit Property Change (Real) — ( EventUnitPropertyChangeFixed ) - [F] —
void
— Set Unit Property — ( UnitSetPropertyFixed ) - [F] —
void
— Set Unit State — ( UnitSetState ) - [F] —
void
— Set Unit Seed — ( UnitSetSeed ) - [F] —
void
— Reset Unit Seed — ( UnitResetSeed ) - [F] —
void
— Make Unit Invulnerable — ( libNtve_gf_MakeUnitInvulnerable ) - [F] —
void
— Make Unit Uncommandable — ( libNtve_gf_MakeUnitUncommandable ) - [F] —
fixed
— Unit Property — ( UnitGetPropertyFixed ) - [F] —
int
— Unit Property (Int) — ( UnitGetPropertyInt ) - [F] —
fixed
— Unit Type Property — ( UnitTypeGetProperty ) - [F] —
bool
— Unit Classification Check — ( UnitTestState ) - [F] —
bool
— Unit Type Classification Check — ( UnitTypeTestFlag ) - [F] —
bool
— Unit Type Attribute Check — ( UnitTypeTestAttribute ) - [F] —
bool
— Unit Targetable Check — ( UnitTestPlane ) - [F] —
bool
— Unit Is Invulnerable — ( libNtve_gf_UnitIsInvulnerable ) - [F] —
int
— Unit Kills — ( libNtve_gf_UnitGetPropertyKills ) - [F] —
int
— Unit Resources — ( libNtve_gf_UnitGetPropertyResources ) - [F] —
point
— Unit Attachment Point — ( UnitGetAttachmentPoint ) - [F] —
text
— Name Of Unit Type — ( UnitTypeGetName ) - [F] —
string
— Gender Code Of Unit Type — ( UnitTypeGetGenderCode ) - [F] —
int
— Unit Type Cost — ( UnitTypeGetCost ) - [F] —
bool
— Unit Type Is Affected By Upgrade — ( UnitTypeIsAffectedByUpgrade ) - [F] —
void
— Reset Movement Speed — ( UnitResetSpeed ) - [F] —
bool
— Unit Uses Mover — ( UnitMoverExists ) - [F] —
bool
— Unit Type Uses Mover — ( libNtve_gf_UnitMoverExists ) - [F] —
string
[ gamelink::Unit ] — Unit Type From String — ( UnitTypeFromString ) - [F] —
void
— Set Unit Color — ( UnitSetTeamColorIndex ) - [F] —
void
— Set Unit Info Button - Ability Tooltip — ( libNtve_gf_SetUnitInfoButtonAbilityTooltip ) - [F] —
void
— Set Unit Info Button - Button Tooltip — ( libNtve_gf_SetUnitInfoButtonButtonTooltip ) - [F] —
void
— Set Unit Info Button - Item Tooltip — ( libNtve_gf_SetUnitInfoButtonItemTooltip ) - [F] —
void
— Reset Unit Info Button - Ability Tooltip — ( libNtve_gf_ResetUnitInfoButtonAbilityTooltip ) - [F] —
void
— Reset Unit Info Button - Button Tooltip — ( libNtve_gf_ResetUnitInfoButtonButtonTooltip ) - [F] —
void
— Reset Unit Info Button - Item Tooltip — ( libNtve_gf_ResetUnitInfoButtonItemTooltip ) - [F] —
void
— Set Unit Command Button Tooltip — ( UnitSetInfoButtonTooltip ) - [F] —
void
— Reset Unit Command Button Tooltip — ( UnitClearInfoButtonTooltip ) - [F] —
void
— Set Unit Highlight Cursor — ( UnitSetCursor ) - [F] —
void
— Set Unit Ping Cursor — ( UnitSetPingCursor ) - [F] —
void
— Set Unit Info — ( UnitSetInfoText ) - [F] —
void
— Set Unit Info Text — ( UnitSetInfoText2 ) - [F] —
void
— Set Unit Info Tip — ( UnitSetInfoTip ) - [F] —
void
— Set Unit Info SubTip — ( UnitSetInfoSubTip ) - [F] —
void
— Clear Unit Info — ( UnitClearInfoText ) - [F] —
void
— Set Unit Status Bar State (Deprecated) — ( UnitForceStatusBar ) - [F] —
void
— Show Unit Status Bar — ( UnitStatusBarOverride ) - [F] —
void
— Hide Unit Status Bar — ( UnitStatusBarClearOverride ) - [F] —
void
— Set Unit Scale — ( UnitSetScale ) - [F] —
void
— Set Unit Model Variation — ( libNtve_gf_UnitSetVariation ) - [F] —
void
— Change Unit Height — ( UnitSetHeight ) - [F] —
fixed
— Height Of Unit — ( UnitGetHeight ) - [F] —
void
— Change Unit Damage — ( libNtve_gf_ChangeUnitDamage ) - [F] —
unit
— Add On Child — ( UnitAddOnChild ) - [F] —
unit
— Add On Parent — ( UnitAddOnParent )
# Examples
# campaigns/liberty.sc2campaign
// L2115
UnitGetPropertyFixed(UnitGroupLoopCurrent(), c_unitPropLife, c_unitPropCurrent)
// L5429
UnitGetPropertyFixed(gv_boss, c_unitPropMovementSpeed, c_unitPropNormal)
// L6288
UnitGetPropertyFixed(lv_plane, c_unitPropMovementSpeed, c_unitPropNormal)
// L7253
UnitGetPropertyFixed(EventUnit(), c_unitPropHeight, c_unitPropCurrent)
// L8073
UnitGetPropertyFixed(gv_boss, c_unitPropLife, c_unitPropCurrent)
// L8073
UnitGetPropertyFixed(gv_boss, c_unitPropShields, c_unitPropCurrent)
// L8073
UnitGetPropertyFixed(gv_boss, c_unitPropLifeMax, c_unitPropCurrent)
// L8073
UnitGetPropertyFixed(gv_boss, c_unitPropShieldsMax, c_unitPropCurrent)
// L8142
UnitGetPropertyFixed(gv_unitHPBarUnit, c_unitPropLife, c_unitPropCurrent)
// L8142
UnitGetPropertyFixed(gv_unitHPBarUnit, c_unitPropShields, c_unitPropCurrent)
// L8142
UnitGetPropertyFixed(gv_unitHPBarUnit, c_unitPropLifeMax, c_unitPropCurrent)
// L6130
UnitGetPropertyFixed(gv_briefingTransport1, c_unitPropMovementSpeed, c_unitPropCurrent)
// L6161
UnitGetPropertyFixed(autoA4BFEB74_var, c_unitPropMovementSpeed, c_unitPropNormal)
// L294
UnitGetPropertyFixed(lp_u, c_unitPropShields, c_unitPropCurrent)
// L296
UnitGetPropertyFixed(lp_u, c_unitPropLife, c_unitPropCurrent)
// L298
UnitGetPropertyFixed(lp_u, c_unitPropEnergy, c_unitPropCurrent)
// L600
UnitGetPropertyFixed(auto6A6C64E5_var, c_unitPropLife, c_unitPropCurrent)
// L1090
UnitGetPropertyFixed(gv_infestableStructure[lv_index], c_unitPropLife, c_unitPropCurrent)
// L2010
UnitGetPropertyFixed(gv_infestableStructure[lv_index], c_unitPropLife, c_unitPropCurrent)
// L2019
UnitGetPropertyFixed(gv_infestableStructure[lv_index], c_unitPropLife, c_unitPropCurrent)
// L1206
UnitGetPropertyFixed(gv_purifier, c_unitPropLifeMax, c_unitPropCurrent)
// L1209
UnitGetPropertyFixed(gv_purifier, c_unitPropLifeMax, c_unitPropCurrent)
// L1210
UnitGetPropertyFixed(gv_purifier, c_unitPropLife, c_unitPropCurrent)
// L1238
UnitGetPropertyFixed(gv_purifier, c_unitPropLife, c_unitPropCurrent)
// L757
UnitGetPropertyFixed(auto582274C1_var, c_unitPropEnergyMax, c_unitPropNormal)
// L2610
UnitGetPropertyFixed(lv_trainCarToAnimate_LOCAL, c_unitPropLifePercent, c_unitPropCurrent)
// L4474
UnitGetPropertyFixed(UnitFromId(90), c_unitPropLife, c_unitPropCurrent)
// L91
UnitGetPropertyFixed(UnitFromId(2), c_unitPropLifeMax, c_unitPropNormal)
// L1218
UnitGetPropertyFixed(UnitFromId(2), c_unitPropLifeMax, c_unitPropNormal)
// L1270
UnitGetPropertyFixed(gv_odin, c_unitPropLife, c_unitPropCurrent)
// L1304
UnitGetPropertyFixed(gv_odin, c_unitPropLifePercent, c_unitPropCurrent)
// L4060
UnitGetPropertyFixed(UnitFromId(2), c_unitPropLifePercent, c_unitPropCurrent)
// L4365
UnitGetPropertyFixed(EventUnit(), c_unitPropLifePercent, c_unitPropCurrent)
// L4408
UnitGetPropertyFixed(EventUnit(), c_unitPropLife, c_unitPropCurrent)
// L4409
UnitGetPropertyFixed(EventUnit(), c_unitPropLife, c_unitPropCurrent)
// L4412
UnitGetPropertyFixed(EventUnit(), c_unitPropLife, c_unitPropCurrent)
// L2942
UnitGetPropertyFixed(lv_statue, c_unitPropLife, c_unitPropCurrent)
// L4077
UnitGetPropertyFixed(gv_raynor, c_unitPropKills, c_unitPropCurrent)
// L1761
UnitGetPropertyFixed(autoDB06C22C_var, c_unitPropEnergyPercent, c_unitPropCurrent)
// L1762
UnitGetPropertyFixed(autoDB06C22C_var, c_unitPropEnergy, c_unitPropCurrent)
// L3199
UnitGetPropertyFixed(auto486BEE07_var, c_unitPropLife, c_unitPropCurrent)
// L3199
UnitGetPropertyFixed(auto486BEE07_var, c_unitPropLifeMax, c_unitPropCurrent)
// L3272
UnitGetPropertyFixed(lv_miner, c_unitPropLife, c_unitPropCurrent)
// L3272
UnitGetPropertyFixed(lv_miner, c_unitPropLifeMax, c_unitPropCurrent)
// L3332
UnitGetPropertyFixed(lv_miner, c_unitPropLife, c_unitPropCurrent)
// L3332
UnitGetPropertyFixed(lv_miner, c_unitPropLifeMax, c_unitPropCurrent)
// L3392
UnitGetPropertyFixed(lv_miner, c_unitPropLife, c_unitPropCurrent)
// L3392
UnitGetPropertyFixed(lv_miner, c_unitPropLifeMax, c_unitPropCurrent)
// L4140
UnitGetPropertyFixed(auto78D96694_var, c_unitPropLifePercent, c_unitPropCurrent)
// L29202
UnitGetPropertyFixed(gf_ActorUnit(ge_ActorID_ActorRaynor), c_unitPropMovementSpeed, c_unitPropNormal)
// L29922
UnitGetPropertyFixed(gf_ActorUnit(ge_ActorID_ActorRaynor), c_unitPropMovementSpeed, c_unitPropNormal)
// L1502
UnitGetPropertyFixed(auto3D8B0D95_var, c_unitPropLife, c_unitPropCurrent)
// L1533
UnitGetPropertyFixed(lv_zergGroup[lv_i].lv_ambusher, c_unitPropLife, c_unitPropCurrent)
// L1557
UnitGetPropertyFixed(lv_zergGroup[lv_i].lv_ambusher, c_unitPropLife, c_unitPropCurrent)
// L1567
UnitGetPropertyFixed(lv_zergGroup[lv_i].lv_ambusher, c_unitPropLife, c_unitPropCurrent)
// L2161
UnitGetPropertyFixed(lv_coCe, c_unitPropMovementSpeed, c_unitPropCurrent)
// L111
UnitGetPropertyFixed(UnitFromId(326), c_unitPropLifeMax, c_unitPropNormal)
// L461
UnitGetPropertyFixed(gv_tosh, c_unitPropLife, c_unitPropCurrent)
// L480
UnitGetPropertyFixed(gv_tosh, c_unitPropLifePercent, c_unitPropCurrent)
// L1509
UnitGetPropertyFixed(autoEB9076F6_var, c_unitPropLifePercent, c_unitPropCurrent)
// L4488
UnitGetPropertyFixed(gv_tosh, c_unitPropLife, c_unitPropCurrent)
// L4489
UnitGetPropertyFixed(gv_tosh, c_unitPropLife, c_unitPropCurrent)
// L2095
UnitGetPropertyFixed(gv_nova, c_unitPropLife, c_unitPropCurrent)
// L2104
UnitGetPropertyFixed(auto18934A38_var, c_unitPropLifePercent, c_unitPropCurrent)
// L3167
UnitGetPropertyFixed(UnitFromId(684), c_unitPropEnergy, c_unitPropCurrent)
// L3513
UnitGetPropertyFixed(gv_nova, c_unitPropLife, c_unitPropCurrent)
// L3522
UnitGetPropertyFixed(autoB164A4B2_var, c_unitPropLifePercent, c_unitPropCurrent)
// L4097
UnitGetPropertyFixed(gv_nova, c_unitPropLife, c_unitPropCurrent)
// L4106
UnitGetPropertyFixed(autoC46A0E1C_var, c_unitPropLifePercent, c_unitPropCurrent)
// L955
UnitGetPropertyFixed(UnitFromId(96), c_unitPropShieldsPercent, c_unitPropCurrent)
// L955
UnitGetPropertyFixed(UnitFromId(109), c_unitPropShieldsPercent, c_unitPropCurrent)
// L1016
UnitGetPropertyFixed(lv_nullifierTop, c_unitPropEnergy, c_unitPropCurrent)
// L1025
UnitGetPropertyFixed(lv_nullifierBottom, c_unitPropEnergy, c_unitPropCurrent)
// L1034
UnitGetPropertyFixed(lv_highTemplar, c_unitPropEnergy, c_unitPropCurrent)
// L1144
UnitGetPropertyFixed(lv_nullifier1, c_unitPropEnergy, c_unitPropCurrent)
// L1153
UnitGetPropertyFixed(lv_nullifier2, c_unitPropEnergy, c_unitPropCurrent)
// L1246
UnitGetPropertyFixed(lv_highTemplars[lv_i], c_unitPropEnergy, c_unitPropCurrent)
// L1818
UnitGetPropertyFixed(gv_tHEONEDRILL, c_unitPropLife, c_unitPropNormal)
// L1819
UnitGetPropertyFixed(gv_tHEONEDOOR, c_unitPropLife, c_unitPropCurrent)
// L2028
UnitGetPropertyFixed(gv_tHEONEDRILL, c_unitPropLifePercent, c_unitPropCurrent)
// L2053
UnitGetPropertyFixed(gv_tHEONEDRILL, c_unitPropLifePercent, c_unitPropCurrent)
// L2439
UnitGetPropertyFixed(gv_tHEONEDOOR, c_unitPropLifePercent, c_unitPropCurrent)
// L2446
UnitGetPropertyFixed(gv_tHEONEDOOR, c_unitPropLifePercent, c_unitPropCurrent)
// L2451
UnitGetPropertyFixed(gv_tHEONEDOOR, c_unitPropLifePercent, c_unitPropCurrent)
// L2459
UnitGetPropertyFixed(gv_tHEONEDOOR, c_unitPropLifePercent, c_unitPropCurrent)
// L1282
UnitGetPropertyFixed(gv_sITE_1_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1330
UnitGetPropertyFixed(gv_sITE_1_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1380
UnitGetPropertyFixed(gv_sITE_1_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1598
UnitGetPropertyFixed(gv_sITE_2_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1677
UnitGetPropertyFixed(gv_sITE_2_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1920
UnitGetPropertyFixed(gv_sITE_3_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1952
UnitGetPropertyFixed(gv_sITE_3_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1984
UnitGetPropertyFixed(gv_sITE_3_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L2016
UnitGetPropertyFixed(gv_sITE_3_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L2054
UnitGetPropertyFixed(gv_sITE_3_BUILDING, c_unitPropLifePercent, c_unitPropCurrent)
// L1922
UnitGetPropertyFixed(auto1789B74F_var, c_unitPropLife, c_unitPropCurrent)
// L1925
UnitGetPropertyFixed(auto1789B74F_var, c_unitPropLife, c_unitPropCurrent)
// L2602
UnitGetPropertyFixed(gv_uNITDaMothership, c_unitPropLifePercent, c_unitPropCurrent)
// L2644
UnitGetPropertyFixed(gv_uNITDaMothership, c_unitPropLifePercent, c_unitPropCurrent)
// L6238
UnitGetPropertyFixed(lv_allUnits, c_unitPropSuppliesUsed, c_unitPropCurrent)