# User Data (Unit)
Grammar — User Data (userType, instance, field, index)
Flags —Native
|Function
Returns a value from user data for the given type, instance, and field. User data is defined in the Data module.
# Arguments
string
[ gamelink::User ] — User Typestring
[ userinstance ] — Instancestring
[ userfield ] — Fieldint
— Index
Returns — string
[ gamelink::Unit ]
native string UserDataGetUnit(
string inType,
string inInstance,
string inField,
int inIndex,
);
# Related
Category: User Data / Get Value
- [F] —
abilcmd
— Load User Data Value Into Variable — ( ) - [F] —
abilcmd
— User Data (Ability Command) — ( UserDataGetAbilCmd ) - [F] —
string
[ gamelink::Actor ] — User Data (Actor) — ( UserDataGetActor ) - [F] —
color
— User Data (Color) — ( UserDataGetColor ) - [F] —
int
[ preset::UserDataCompare ] — User Data (Compare) — ( UserDataGetCompare ) - [F] —
string
[ gamelink ] — User Data (Game Link) — ( UserDataGetGameLink ) - [F] —
string
[ filepath ] — User Data (Image) — ( UserDataGetImagePath ) - [F] —
int
[ preset::TextTagEdge ] — User Data (Image Edge) — ( UserDataGetImageEdge ) - [F] —
string
[ preset::AttachPoints ] — User Data (Image Attach) — ( UserDataGetImageAttachPoint ) - [F] —
int
— User Data (Integer) — ( UserDataGetInt ) - [F] —
string
[ gamelink::Model ] — User Data (Model) — ( UserDataGetModel ) - [F] —
string
[ filepath ] — User Data (Movie) — ( UserDataGetMovie ) - [F] —
fixed
— User Data (Real) — ( UserDataGetFixed ) - [F] —
string
[ gamelink::Sound ] — User Data (Sound) — ( UserDataGetSound ) - [F] —
string
— User Data (String) — ( UserDataGetString ) - [F] —
text
— User Data (Text) — ( UserDataGetText ) - [F] —
string
[ gamelink::Unit ] — User Data (Unit) — ( UserDataGetUnit ) - [F] —
string
[ gamelink::Upgrade ] — User Data (Upgrade) — ( UserDataGetUpgrade ) - [F] —
string
[ gamelink::User ] — User Data (User Type) — ( UserDataGetUserType ) - [F] —
string
[ userinstance ] — User Data (User Instance) — ( UserDataGetUserInstance )
# Examples
# campaigns/swarmstory.sc2campaign
// L7928
UserDataGetUnit("TechUnit", lv_techUnit, "UIUnitType", 1)
// L7942
UserDataGetUnit("TechUnit", lv_techUnit, "UIEggType", 1)
// L7952
UserDataGetUnit("TechUnit", lv_techUnit, "UIUnitType", 1)
// L8926
UserDataGetUnit("TechUnit", lv_techUnit, "UIUnitType", 1)
// L8951
UserDataGetUnit("TechUnit", lv_techUnit, "UIUnitType", 1)
# campaigns/swarmstoryutil.sc2mod
// L5030
UserDataGetUnit("CalloutAttachment", lib281DEC45_gf_ZSS_CharacterCalloutData(lp_character), "Attach Unit", 1)
# campaigns/voidstory.sc2campaign
// L1993
UserDataGetUnit("Locations", libVoiC_gf_PC_LocationUserData(lp_location), "Unit", 1)
# mods/heroesmapmods/battlegroundmapmods/braxisholdout.stormmod
// L1581
UserDataGetUnit("BeaconWaves", lv_tier, lv_wave, lv_itUserData)
# mods/missionpacks/campaigncommon.sc2mod
// L479
UserDataGetUnit("Locations", libComC_gf_CC_LocationUserData(lp_location), "Unit", 1)
# mods/starcoop/starcoop.sc2mod
// L997
UserDataGetUnit("CoopAICommanderTiers", UserDataGetUserInstance("CoopAICommanders", libCOMI_gv_cM_CoopAIPlayer_CommanderShared, "UnitTiers", 1), "PhaseUnits", 1)
// L2564
UserDataGetUnit("CoopAICommanderTiers", lv_commanderTier, "PhaseUnits", lv_unitTypeIter)
// L2566
UserDataGetUnit("CoopAICommanderTiers", lv_commanderTier, "PhaseUnitsAlternate", lv_unitTypeIter)
// L2586
UserDataGetUnit("CoopAIAttackWaveUnitLimits", UserDataInstance("CoopAIAttackWaveUnitLimits", lv_unitTypeLimitIter), "UnitToLimit", 1)
// L2941
UserDataGetUnit("CoopAICommanderTiers", lv_commanderTier, "PhaseUnits", lv_unitTypeIter)
// L2946
UserDataGetUnit("CoopAICommanderTiers", lv_commanderTier, "PhaseUnitsAlternate", lv_unitTypeIter)
// L2948
UserDataGetUnit("CoopAICommanderTiers", lv_commanderTier, "PhaseUnitsAlternate", lv_unitTierIter)
// L2957
UserDataGetUnit("CoopAIAttackWaveUnitLimits", UserDataInstance("CoopAIAttackWaveUnitLimits", lv_unitTypeLimitIter), "UnitToLimit", 1)
// L3098
UserDataGetUnit("CoopAICommanders", libCOMI_gv_cM_CoopAIPlayer_Commander[lp_player], "StartingTech", lv_startingTechStockIter)
// L3185
UserDataGetUnit("CoopAICommanders", libCOMI_gv_cM_CoopAIPlayer_Commander[lp_player], "StartingTech", lv_unitCreateIter)
# mods/starcoop/starcoop.sc2mod
// L777
UserDataGetUnit("EvolutionTiers", lv_killerTier, "UnitsToEvolveInto", lv_type)
// L819
UserDataGetUnit("EvolutionTiers", UserDataInstance("EvolutionTiers", lv_tier), "UnitsToEvolveInto", lv_tierEndpoint)
// L825
UserDataGetUnit("EvolutionTiers", UserDataInstance("EvolutionTiers", lv_tier), "UnitsToEvolveInto", RandomInt(1, lv_tierEndpoint))
// L3466
UserDataGetUnit("EvolutionTiers", UserDataInstance("EvolutionTiers", lv_tier), "UnitsToEvolveInto", lv_tierEndpoint)
// L3472
UserDataGetUnit("EvolutionTiers", UserDataInstance("EvolutionTiers", lv_tier), "UnitsToEvolveInto", RandomInt(1, lv_tierEndpoint))
# mods/starcoop/starcoop.sc2mod
// L1091
UserDataGetUnit("PlayerPrestige", lp_prestige, "DisableUnit", lv_index)
# mods/starcoop/starcoop.sc2mod
// L5387
UserDataGetUnit("CoopTechTychusSquad", lp_squadInstance, "EquipmentStructure", 1)
// L5471
UserDataGetUnit("CoopTechTychusSquad", lv_instance, "Unit Type", 1)
// L8936
UserDataGetUnit("CoopTechTychusSquad", lv_squadinstance, "Unit Type", 1)
// L8984
UserDataGetUnit("CoopTechTychusSquad", lv_squadinstance, "Unit Type", 1)
// L9097
UserDataGetUnit("CoopTechTychusSquad", lv_squadinstance, "EquipmentStructure", 1)
# mods/warcoop/warcoopdata.sc2mod
// L587
UserDataGetUnit("PlayableLegends", libWCdr_gf_GetLegendInstanceForPlayer(lp_legendPlayer), "HeroUnit", 1)
// L2717
UserDataGetUnit("LegionWaves", lp_wave, "UnitTypes", lv_waveunitindex)
// L2728
UserDataGetUnit("LegionWaves", lp_wave, "UnitTypes", lv_waveunitindex)
// L2791
UserDataGetUnit("LegionWaves", lp_wave, "UnitTypes", lp_unitIndex)