# User Data (User Instance)

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 Type
• string [ userinstance ] — Instance
• string [ userfield ] — Field
• int — Index

Returns — string [ userinstance ]

native string UserDataGetUserInstance(
	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

— SwarmCampaignLib.galaxy

// L8391
UserDataGetUserInstance("TechUnit", libSwaC_gf_ZS_TechUnitOfArmyCategory(lp_armyCategory), "CalloutAttachment", 1)

# campaigns/swarmstoryutil.sc2mod

— Lib281DEC45.galaxy

// L3668
UserDataGetUserInstance("AmbientScenes", lib281DEC45_gv_zSS_AmbientSceneInstance[lp_sceneIndex], "Sequence Scene", 1)

// L5710
UserDataGetUserInstance("ScriptedScenes", lp_scene, "ConvoCharacter", 1)

// L8625
UserDataGetUserInstance("AmbientScenes", lib281DEC45_gv_zSS_AmbientSceneInstance[lv_index], "Sequence Scene", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignLib.galaxy

// L5092
UserDataGetUserInstance("TechUnit", libVoiC_gf_PC_TechUnitOfArmyUnit(lp_armyUnit), "Faction", 1)

// L5656
UserDataGetUserInstance("CampaignPerk", lp_campaignPerk, "Group", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignStoryLib.galaxy

// L2824
UserDataGetUserInstance("AmbientScenes", lp_scene, "AmbientEvents", lv_eventIndex)

// L2825
UserDataGetUserInstance("AmbientScenes", lp_scene, "AmbientEvents", lv_eventIndex)

// L2854
UserDataGetUserInstance("AmbientScenes", libVCST_gv_pS_AmbientSceneInstance[lp_room][lp_scene], "NextScene", 1)

// L4525
UserDataGetUserInstance("Scenes", lp_scene, "Type", 1)

// L4894
UserDataGetUserInstance("Conversations", libVCST_gv_pS_DebugStoryListInstance[libVCST_gv_pS_DebugStorySelectedIndex], "PrimaryCharacter", 1)

// L4898
UserDataGetUserInstance("Conversations", libVCST_gv_pS_DebugStoryListInstance[libVCST_gv_pS_DebugStorySelectedIndex], "PrimaryCharacter", 1)

// L5699
UserDataGetUserInstance("AmbientScenes", libVCST_gv_pS_AmbientSceneInstance[lv_indexRoom][lv_indexScene], "NextScene", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignUILib.galaxy

// L944
UserDataGetUserInstance("TechUnit", lp_campaignTechUnit, "ArmyInfoAbilities", lv_abilityIndex)

// L945
UserDataGetUserInstance("TechUnit", lp_campaignTechUnit, "ArmyInfoAbilities", lv_abilityIndex)

# mods/missionpacks/campaigncommon.sc2mod

— LibComC.galaxy

// L1633
UserDataGetUserInstance("Timestamps", lv_sceneTimestamp, "Scene", 1)

// L2729
UserDataGetUserInstance("CampaignPerk", lp_campaignPerk, "Group", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCST.galaxy

// L2473
UserDataGetUserInstance("AmbientScenes", lp_scene, "AmbientEvents", lv_eventIndex)

// L2474
UserDataGetUserInstance("AmbientScenes", lp_scene, "AmbientEvents", lv_eventIndex)

// L2504
UserDataGetUserInstance("AmbientScenes", libNCST_gv_nS_AmbientSceneInstance[lp_room][lp_scene], "NextScene", 1)

// L3879
UserDataGetUserInstance("Scenes", lp_scene, "Type", 1)

// L4264
UserDataGetUserInstance("Conversations", libNCST_gv_nS_DebugStoryListInstance[libNCST_gv_nS_DebugStorySelectedIndex], "PrimaryCharacter", 1)

// L4268
UserDataGetUserInstance("Conversations", libNCST_gv_nS_DebugStoryListInstance[libNCST_gv_nS_DebugStorySelectedIndex], "PrimaryCharacter", 1)

// L4870
UserDataGetUserInstance("AmbientScenes", libNCST_gv_nS_AmbientSceneInstance[lv_indexRoom][lv_indexScene], "NextScene", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOMI.galaxy

// L997
UserDataGetUserInstance("CoopAICommanders", libCOMI_gv_cM_CoopAIPlayer_CommanderShared, "UnitTiers", 1)

// L1190
UserDataGetUserInstance("CoopAICommanders", libCOMI_gv_cM_CoopAIPlayer_Commander[lp_player], "UnitTiers", lv_tierIndex)

// L1195
UserDataGetUserInstance("CoopAICommanders", libCOMI_gv_cM_CoopAIPlayer_Commander[lp_player], "UnitTiers", (lv_tierIndex + 1))

// L3271
UserDataGetUserInstance("CoopAIUpgrade", UserDataInstance("CoopAIUpgrade", lv_upgradeIter), "ExclusiveToCommander", lv_exclusiveCommanderIter)

// L3271
UserDataGetUserInstance("CoopAIUpgrade", UserDataInstance("CoopAIUpgrade", lv_upgradeIter), "ExclusiveToCommander", lv_exclusiveCommanderIter)

// L5010
UserDataGetUserInstance(libCOMI_gv_cM_HornerStatUserType, lv_itInstanceStat, "Faction", 1)

// L5046
UserDataGetUserInstance(libCOMI_gv_cM_HornerStatUserType, lv_itInstanceStat, "Faction", 1)

// L12519
UserDataGetUserInstance(lv_playerUserType, lv_itPlayerInstance, "Is Commander", 1)

// L12521
UserDataGetUserInstance(lv_playerUserType, lv_itPlayerInstance, "Preset Team", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOMU.galaxy

// L4798
UserDataGetUserInstance("MutationAbominations", lv_mutationabominationinstance, "Mutator", 1)

// L4801
UserDataGetUserInstance("MutationAbominations", lv_mutationabominationinstance, "Mutator", 1)

// L4976
UserDataGetUserInstance("MutationAbominations", UserDataInstance("MutationAbominations", lp_mutationAbominationIndex), "Mutator", 1)

// L5132
UserDataGetUserInstance("MutationDifficultyCountTargets", lv_countweightinstance, "MinDifficulty", 1)

// L5133
UserDataGetUserInstance("MutationDifficultyCountTargets", lv_countweightinstance, "MinDifficulty", 1)

// L5269
UserDataGetUserInstance("MutationAbominations", lv_mutabominstance, "Mutator", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOOC.galaxy

// L716
UserDataGetUserInstance("MasteryUpgrades",UserDataInstance("MasteryUpgrades", auto9A82478A_ai),"Commander",1)

// L739
UserDataGetUserInstance("MasteryUpgrades", lp_masteryUpgrade, "Commander", 1)

// L868
UserDataGetUserInstance("MasteryUpgrades",UserDataInstance("MasteryUpgrades", auto37349ADB_ai),"Commander",1)

// L958
UserDataGetUserInstance("PlayerCommanders", lv_commander, "Prestige", libCOOC_gf_CC_PlayerActivePrestigeIndex(lp_player))

// L1096
UserDataGetUserInstance("PlayerPrestige", lp_prestige, "UpgradeSupplements", lv_index)

// L1127
UserDataGetUserInstance("PlayerPrestige", lp_prestige, "PlayerResponses", lv_index)

// L1210
UserDataGetUserInstance("PlayerLevels", lp_playerLevel, "Commander", 1)

// L1663
UserDataGetUserInstance(lp_userType, lp_userInstance, "Commander", lv_index)

// L2308
UserDataGetUserInstance("PlayerLevels",lv_indexLevel,"Commander",1)

// L2336
UserDataGetUserInstance("PlayerLevels",lv_indexLevel,"Commander",1)

# mods/starcoop/starcoop.sc2mod

— LibCOUI.galaxy

// L1429
UserDataGetUserInstance("MasteryUpgrades",UserDataInstance("MasteryUpgrades", autoE4006FE8_ai),"Commander",1)

// L6970
UserDataGetUserInstance("MutatorChallenges", lv_selectedChallenge, "Mutators", lv_challengeMutatorIndex)

// L6971
UserDataGetUserInstance("MutatorChallenges", lv_selectedChallenge, "Mutators", lv_challengeMutatorIndex)

# mods/warcoop/warcoopdata.sc2mod

— WarCoopData.galaxy

// L2039
UserDataGetUserInstance("LegendAbilityReplacements", lv_abilityReplacementInstance, "Legend", 1)

// L2042
UserDataGetUserInstance("LegendAbilityReplacements", lv_abilityReplacementInstance, "Legend", 1)

// L2527
UserDataGetUserInstance("LegionDifficultyScaling", lp_difficultyScalingInstance, "GameMode", 1)

// L2533
UserDataGetUserInstance("LegionDifficultyPresets", lp_difficultyScalingInstance, "GameMode", 1)

// L2583
UserDataGetUserInstance("LegionDifficultyScaling", lv_difficultyscalinginstance, "Modifier", 1)

// L2613
UserDataGetUserInstance("LegionDifficultyScaling", lv_difficultyscalinginstance, "Modifier", 1)

// L2765
UserDataGetUserInstance("LegionWaves", lv_waveinstance, "Army", 1)

// L2770
UserDataGetUserInstance("LegionWaves", lv_waveinstance, "Army", 1)

// L3802
UserDataGetUserInstance("PlayableLegends", libWCdr_gf_GetLegendInstanceForPlayer(lv_legendplayer), "HeroItemCategory", 1)

// L3807
UserDataGetUserInstance("LootDropLevels", lv_lootlevelinstance, "HeroItemCategory", 1)