# User Data (Game Link)

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 [ gamelink ]

native string UserDataGetGameLink(
	string inType,
	string inInstance,
	string inField,
	int inIndex,
);

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

— MapScript.galaxy

// L152
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 2)

// L153
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 2)

// L157
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 3)

// L158
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 3)

// L162
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 4)

// L163
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 4)

// L152
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 2)

// L153
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 2)

// L157
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 3)

// L158
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 3)

// L162
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 4)

// L163
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lv_indexMission), "CompletionAchievementTerms", 4)

# campaigns/swarmstory.sc2campaign

— SwarmCampaignLib.galaxy

// L4885
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "Pitch", 1)

// L4891
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "Travel Pitch", 1)

// L5097
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "EvolutionUnlocked", 1)

// L6514
UserDataGetGameLink("Planets", libSwaC_gf_ZS_PlanetUserData(lp_planet), "No Mission Pitch", 1)

// L6569
UserDataGetGameLink("ConversationTimestamps", UserDataInstance("ConversationTimestamps", lv_index), "Conversation", 1)

// L8776
UserDataGetGameLink("TechUnit", libSwaC_gf_ZS_TechUnitOfArmyCategory(libSwaC_gv_zS_ArmyCustomCategoryCurrent), "AchievementTermUpgrade", 1)

// L10685
UserDataGetGameLink("TechUnit", libSwaC_gf_ZS_TechUnitOfArmyUnit(lp_armyUnit), "MorphArmyUnit", lp_index)

// L12680
UserDataGetGameLink("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_map), "Achievements", 1)

// L13259
UserDataGetGameLink("Planets", libSwaC_gf_ZS_PlanetUserData(libSwaC_gf_StoryMapPlanet(libSwaC_gf_CurrentMap())), "Travel Summary Origin", lv_index)

// L14194
UserDataGetGameLink("TechUnit", libSwaC_gf_ZS_TechUnitOfArmyCategory(libSwaC_gf_MissionArmyCategoryUnlocked(lp_mission)), "AchievementTermEvolve", 1)

# campaigns/swarmstoryutil.sc2mod

— Lib281DEC45.galaxy

// L950
UserDataGetGameLink("Maps", lib281DEC45_gf_ZS_MapUserDataInstance(lv_mission), "Achievements", lv_index)

// L1573
UserDataGetGameLink("Maps", lib281DEC45_gf_ZS_MapUserDataInstance(lib281DEC45_gv_zSS_NextMission), "UIAmbience", 1)

// L2377
UserDataGetGameLink("Character", lp_userInstance, "Game Link", 1)

// L2378
UserDataGetGameLink("Character", lp_userInstance, "Game Link", 1)

// L4554
UserDataGetGameLink("Character", lp_character, "Game Link", 1)

// L4559
UserDataGetGameLink("Character", lp_character, "Game Link", 1)

// L8136
UserDataGetGameLink("ScriptedScenes", lv_scene, "Default Map", 1)

# campaigns/void.sc2campaign

— MapScript.galaxy

// L383
UserDataGetGameLink("Clickable", lp_speaker, "GreetingConversation", 1)

// L383
UserDataGetGameLink("Clickable", lp_speaker, "GreetingConversation", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignLib.galaxy

// L1655
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(libVoiC_gf_CurrentMap()), "Achievements", 1)

// L1726
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "Achievements", 1)

// L1727
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 1)

// L1728
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 1)

// L1731
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 2)

// L1732
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 2)

// L1735
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 3)

// L1736
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 3)

// L1739
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 4)

// L1740
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 4)

# campaigns/voidstory.sc2campaign

— VoidCampaignMissionLib.galaxy

// L1309
UserDataGetGameLink("TechUnit", libVoiC_gf_PC_TechUnitOfArmyCategory(lv_indexArmyCategory), "RequiredRace", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignStoryLib.galaxy

// L198
UserDataGetGameLink("Scenes", libVCST_gv_pS_DebugStoryListInstance[libVCST_gv_pS_DebugStorySelectedIndex], "Conversation", 1)

// L206
UserDataGetGameLink("Conversations", libVCST_gv_pS_DebugStoryListInstance[libVCST_gv_pS_DebugStorySelectedIndex], "ConvoGameLink", 1)

// L252
UserDataGetGameLink("Conversations", lp_convoInstance, "RequiredMission", lv_indexMission)

// L253
UserDataGetGameLink("Conversations", lp_convoInstance, "RequiredMission", lv_indexMission)

// L257
UserDataGetGameLink("Conversations", lp_convoInstance, "ConvoGameLink", 1)

// L2447
UserDataGetGameLink("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Location", 1)

// L2448
UserDataGetGameLink("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Mission", 1)

// L2454
UserDataGetGameLink("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Mission", 1)

// L2912
UserDataGetGameLink("AmbientEvents", lp_ambientEvent, "CategoryRequiredForEvent", 1)

// L2912
UserDataGetGameLink("AmbientEvents", lp_ambientEvent, "CategoryRequiredForEvent", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignUILib.galaxy

// L1181
UserDataGetGameLink("ArmyUpgradeCategories", lp_faction, "GlowModel", 1)

// L1523
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lv_selectedMission), "Achievements", lv_index)

// L1883
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(libVCUI_gv_pU_MissionNextMap), "UIAmbience", 1)

// L1958
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(libVCUI_gv_pU_MissionNextMap), "Achievements", lv_achievementIndex)

// L5453
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "Achievements", lv_index)

// L5482
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "Achievements", lv_index)

// L5708
UserDataGetGameLink("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "Achievements", lv_index)

# mods/heroesdata.stormmod

— GameLib.galaxy

// L2579
UserDataGetGameLink("EndOfMatchMapSpecificAward", lp_userData, "Score Value Boolean", 1)

// L2922
UserDataGetGameLink("EndOfMatchGeneralAward", lp_userData, "Score Value Boolean", 1)

// L2935
UserDataGetGameLink("EndOfMatchGeneralAward", lp_userData, "Score Value Boolean", 1)

// L17945
UserDataGetGameLink(libGame_gv_wheelCmdUserType, lv_instance, "WheelDiffEffect", 1)

# mods/heroesmapmods/battlegroundmapmods/braxisholdout.stormmod

— LibSCHO.galaxy

// L3520
UserDataGetGameLink("AttackWaves", lp_attackWave, "Attacking Units", lv_itUserData)

# mods/liberty.sc2mod

— LibertyLib.galaxy

// L963
UserDataGetGameLink("SCEvent_Events", lv_itInstance, "Disabler", 1)

// L964
UserDataGetGameLink("SCEvent_Events", lv_itInstance, "Skin", 1)

// L965
UserDataGetGameLink(libLbty_gv_starCraftEventsEventTable, lv_itInstance, "Upgrade", 1)

# mods/missionpacks/campaigncommon.sc2mod

— LibComC.galaxy

// L144
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(libComC_gf_CurrentMap()), "Achievements", 1)

// L145
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(libComC_gf_CurrentMap()), "Achievements", 1)

// L188
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "Achievements", 1)

// L189
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 1)

// L190
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 1)

// L193
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 2)

// L194
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 2)

// L197
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 3)

// L198
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 3)

// L201
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_completedMission), "CompletionAchievementTerms", 4)

# mods/missionpacks/novacampaign.sc2mod

— LibNCST.galaxy

// L197
UserDataGetGameLink("Scenes", libNCST_gv_nS_DebugStoryListInstance[libNCST_gv_nS_DebugStorySelectedIndex], "Conversation", 1)

// L205
UserDataGetGameLink("Conversations", libNCST_gv_nS_DebugStoryListInstance[libNCST_gv_nS_DebugStorySelectedIndex], "ConvoGameLink", 1)

// L255
UserDataGetGameLink("Conversations", lp_convoInstance, "RequiredMission", lv_indexMission)

// L256
UserDataGetGameLink("Conversations", lp_convoInstance, "RequiredMission", lv_indexMission)

// L260
UserDataGetGameLink("Conversations", lp_convoInstance, "ConvoGameLink", 1)

// L2111
UserDataGetGameLink("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Location", 1)

// L2112
UserDataGetGameLink("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Mission", 1)

// L2118
UserDataGetGameLink("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Mission", 1)

// L2560
UserDataGetGameLink("AmbientEvents", lp_ambientEvent, "CategoryRequiredForEvent", 1)

// L2560
UserDataGetGameLink("AmbientEvents", lp_ambientEvent, "CategoryRequiredForEvent", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCUI.galaxy

// L651
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lv_selectedMission), "Achievements", lv_index)

// L1316
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(libNCUI_gf_NU_NextAvailableMission()), "Achievements", lv_achievementIndex)

// L1773
UserDataGetGameLink("CampaignTechItem", lv_indexTechItem, "UnitList", auto5C4EAFD3_ai)

// L2303
UserDataGetGameLink("CampaignTechItem", lv_techItem, "UnitList", autoA8BA21A8_ai)

// L3962
UserDataGetGameLink("Maps", libComC_gf_CC_MapUserDataInstance(lp_mission), "Achievements", lv_index)

# mods/missionpacks/novacampaign.sc2mod

— LibNovC.galaxy

// L1562
UserDataGetGameLink("CampaignTechItem", lp_techItem, "AssignedUnit", 1)

// L1572
UserDataGetGameLink("CampaignTechItem", lp_techItem, "UnitList", lp_unitIndex)

// L1587
UserDataGetGameLink("CampaignTechItem", lp_techItem, "RequiredMission", 1)

// L1592
UserDataGetGameLink("CampaignTechItem", lp_techItem, "RequiredObjective", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOMI.galaxy

// L950
UserDataGetGameLink("CoopAICommanders", lp_aIPersonality, "Race", 1)

// L5599
UserDataGetGameLink("NovaUnitRanks", UserDataInstance("NovaUnitRanks", lv_i), "RankUnitType", 1)

// L6158
UserDataGetGameLink("CoopAbilityTychusRageEffects", lp_rageEffect, "Rage Ability", 1)

// L6160
UserDataGetGameLink("CoopAbilityTychusRageEffects", lp_rageEffect, "Replacement Effect", 1)

# User Data (Game Link)

# Arguments

# Related

# Examples

# campaigns/swarm.sc2campaign

# campaigns/swarmstory.sc2campaign

# campaigns/swarmstoryutil.sc2mod

# campaigns/void.sc2campaign

# campaigns/voidstory.sc2campaign

# campaigns/voidstory.sc2campaign

# campaigns/voidstory.sc2campaign

# campaigns/voidstory.sc2campaign

# mods/heroesdata.stormmod

# mods/heroesmapmods/battlegroundmapmods/braxisholdout.stormmod

# mods/liberty.sc2mod

# mods/missionpacks/campaigncommon.sc2mod

# mods/missionpacks/novacampaign.sc2mod

# mods/missionpacks/novacampaign.sc2mod

# mods/missionpacks/novacampaign.sc2mod

# mods/starcoop/starcoop.sc2mod