# User Data (Text)

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 — text

native text UserDataGetText(
	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

// L2199
UserDataGetText("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Name", 1)

// L2199
UserDataGetText("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Description", 1)

// L2199
UserDataGetText("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Name", 1)

// L3687
UserDataGetText("CampaignTips", lp_tipData, "Name", 1)

// L3687
UserDataGetText("CampaignTips", lp_tipData, "Description", 1)

// L3687
UserDataGetText("CampaignTips", lp_tipData, "Name", 1)

// L4818
UserDataGetText("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_map), "NameLowerCase", 1)

// L6179
UserDataGetText("MissionObjective", libSwaC_gf_ZS_ObjectiveUserDataInstance(lp_objective), "RewardText", 1)

// L6472
UserDataGetText("Planets", libSwaC_gf_ZS_PlanetUserData(lp_planet), "StoryUI Name", 1)

// L6478
UserDataGetText("Planets", libSwaC_gf_ZS_PlanetUserData(lp_planet), "StoryUI Prompt", 1)

# campaigns/swarmstoryutil.sc2mod

— Lib281DEC45.galaxy

// L1710
UserDataGetText("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "TechnologyDescriptionLabel", 1)

// L2164
UserDataGetText("CampaignTips", lp_tip, "Name", 1)

// L2164
UserDataGetText("CampaignTips", lp_tip, "Description", 1)

// L2164
UserDataGetText("CampaignTips", lp_tip, "Name", 1)

// L2381
UserDataGetText("Character", lp_userInstance, "Name", 1)

// L4555
UserDataGetText("Character", lp_character, "Name", 1)

// L4564
UserDataGetText("Character", lp_character, "Callout Subtitle", 1)

// L4569
UserDataGetText("Character", lp_character, "Callout Prompts", lp_index)

// L7363
UserDataGetText("Scenes", lib281DEC45_gv_zSS_DebugSceneList[IntLoopCurrent()], "name", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignLib.galaxy

// L2005
UserDataGetText("Locations", libVoiC_gf_PC_LocationUserData(lp_location), "UIFluffCategories", 1)

// L2011
UserDataGetText("Locations", libVoiC_gf_PC_LocationUserData(lp_location), "UIFluffData", 1)

// L2035
UserDataGetText("Locations", libVoiC_gf_PC_LocationUserData(lp_planet), "StoryUI Name", 1)

// L2174
UserDataGetText("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "LoadingScreenVictoryTitle", 1)

// L2184
UserDataGetText("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "LoadingScreenVictorySubtitle", 1)

// L2194
UserDataGetText("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "LoadingScreenVictoryBody", 1)

// L2544
UserDataGetText("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "Debrief", 1)

// L3778
UserDataGetText("MissionObjective", libVoiC_gf_PS_ObjectiveUserDataInstance(lp_objective), "RewardText", 1)

// L4029
UserDataGetText("Scenes", lp_scene, "Name", 1)

// L4259
UserDataGetText("SpearofAdunUpgrade", lp_soAUpgrade, "Name", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignMissionLib.galaxy

// L2565
UserDataGetText("MissionObjective", libVoiC_gf_PS_ObjectiveUserDataInstance(lp_objective), "FormatTextSingle", 1)

// L2568
UserDataGetText("MissionObjective", libVoiC_gf_PS_ObjectiveUserDataInstance(lp_objective), "FormatText", 1)

// L2718
UserDataGetText("CampaignTips", libVCMI_gv_pM_MissionTip[lv_index], "Name", 1)

// L2719
UserDataGetText("CampaignTips", libVCMI_gv_pM_MissionTip[lv_index], "Name", 1)

// L2724
UserDataGetText("CampaignTips", libVCMI_gv_pM_MissionTip[lv_index], "Description", 1)

// L2725
UserDataGetText("CampaignTips", libVCMI_gv_pM_MissionTip[lv_index], "Description", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignStoryLib.galaxy

// L1366
UserDataGetText("CampaignTips", lp_tip, "Name", 1)

// L1366
UserDataGetText("CampaignTips", lp_tip, "Description", 1)

// L1366
UserDataGetText("CampaignTips", lp_tip, "Name", 1)

// L3841
UserDataGetText("Clickable", lp_clickableInstance, "Name", 1)

// L3845
UserDataGetText("Clickable", lp_clickableInstance, "Name", 1)

// L3858
UserDataGetText("Clickable", lp_clickableInstance, "Callout Subtitle", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignUILib.galaxy

// L916
UserDataGetText("TechUnit", libVoiC_gf_PC_TechUnitOfArmyUnit(libVCUI_gv_pU_ArmyUnits[libVCUI_gv_pU_ArmyCategorySelectedIndex][libVCUI_gv_pU_ArmyUnitSelectedIndex[libVCUI_gv_pU_ArmyCategorySelectedIndex]]), "ArmyInfoFluffText", 1)

// L948
UserDataGetText("CampaignUnitAbilities", lv_ability, "Name", 1)

// L949
UserDataGetText("CampaignUnitAbilities", lv_ability, "TooltipDescription", 1)

// L2187
UserDataGetText("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "UIFluffText", lp_index)

// L2193
UserDataGetText("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "VignetteEasterEggText", 1)

// L10404
UserDataGetText("LoreCredits", UserDataInstance("LoreCredits", libVCUI_gv_pU_LoreCreditsItemDisplayCounter), "Description", 1)

# mods/heroesdata.stormmod

— GameLib.galaxy

// L2573
UserDataGetText("EndOfMatchMapSpecificAward", lp_userData, "Award Name", 1)

// L2574
UserDataGetText("EndOfMatchMapSpecificAward", lp_userData, "Description", 1)

// L2580
UserDataGetText("EndOfMatchMapSpecificAward", lp_userData, "Tooltip Text", 1)

// L2915
UserDataGetText("EndOfMatchGeneralAward", lp_userData, "Award Name", 1)

// L2916
UserDataGetText("EndOfMatchGeneralAward", lp_userData, "Description", 1)

// L2923
UserDataGetText("EndOfMatchGeneralAward", lp_userData, "Tooltip Text", 1)

// L2928
UserDataGetText("EndOfMatchGeneralAward", lp_userData, "Award Name", 1)

// L2929
UserDataGetText("EndOfMatchGeneralAward", lp_userData, "Description", 1)

// L2936
UserDataGetText("EndOfMatchGeneralAward", lp_userData, "Tooltip Text", 1)

# mods/missionpacks/campaigncommon.sc2mod

— LibCMMI.galaxy

// L184
UserDataGetText("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "FormatText", 1)

// L189
UserDataGetText("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "FormatTextSingle", 1)

# mods/missionpacks/campaigncommon.sc2mod

— LibComC.galaxy

// L593
UserDataGetText("Maps", libComC_gf_CC_MapUserDataInstance(lp_map), "LoadingScreenVictoryTitle", 1)

// L602
UserDataGetText("Maps", libComC_gf_CC_MapUserDataInstance(lp_map), "LoadingScreenVictorySubtitle", 1)

// L611
UserDataGetText("Maps", libComC_gf_CC_MapUserDataInstance(lp_map), "LoadingScreenVictoryBody", 1)

// L1443
UserDataGetText("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "RewardText", 1)

// L1674
UserDataGetText("Scenes", lp_scene, "Name", 1)

// L2271
UserDataGetText("TechUnit", libComC_gf_NC_TechUnitOfArmyUnit(lp_armyUnit), "DescriptionShort", 1)

// L2724
UserDataGetText("CampaignPerkGroup", lp_perkGroup, "Name", 1)

// L2734
UserDataGetText("CampaignPerk", lp_campaignPerk, "Name", 1)

// L2744
UserDataGetText("CampaignPerk", lp_campaignPerk, "Tooltip", 1)

// L2749
UserDataGetText("CampaignPerk", lp_campaignPerk, "Description", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCMI.galaxy

// L2935
UserDataGetText("CampaignTips", libNCMI_gv_NM_MissionTip[lv_index], "Name", 1)

// L2936
UserDataGetText("CampaignTips", libNCMI_gv_NM_MissionTip[lv_index], "Name", 1)

// L2941
UserDataGetText("CampaignTips", libNCMI_gv_NM_MissionTip[lv_index], "Description", 1)

// L2942
UserDataGetText("CampaignTips", libNCMI_gv_NM_MissionTip[lv_index], "Description", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCST.galaxy

// L1247
UserDataGetText("CampaignTips", lp_tip, "Name", 1)

// L1247
UserDataGetText("CampaignTips", lp_tip, "Description", 1)

// L1247
UserDataGetText("CampaignTips", lp_tip, "Name", 1)

// L3303
UserDataGetText("Clickable", lp_clickableInstance, "Name", 1)

// L3311
UserDataGetText("Clickable", lp_clickableInstance, "Callout Subtitle", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNovC.galaxy

// L1419
UserDataGetText("CampaignTechItem", lp_techItem, "Name", 1)

// L1542
UserDataGetText("CampaignTechItem", lp_techItem, "Name", 1)

// L1552
UserDataGetText("CampaignTechItem", lp_techItem, "Description", lp_upgradeIndex)

// L1557
UserDataGetText("CampaignTechItem", lp_techItem, "TooltipReward", 1)

// L1919
UserDataGetText("CampaignPerk", lp_campaignPerk, "DescriptionExtra", 1)

// L1933
UserDataGetText("CampaignPerk", lp_campaignPerk, "TooltipReward", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOMI.galaxy

// L5600
UserDataGetText("NovaUnitRanks", UserDataInstance("NovaUnitRanks", lv_i), "Rank", 1)

// L5611
UserDataGetText("NovaUnitNames", UserDataInstance("NovaUnitNames", lp_armyUnit), "Name", 1)

// L9356
UserDataGetText("MissionObjective", libCOOC_gf_CS_ObjectiveUserDataInstance(lp_objective), "FormatText", 1)

// L9412
UserDataGetText("MissionObjective", libCOOC_gf_CS_ObjectiveUserDataInstance(lp_objective), "FormatText", 1)

// L12376
UserDataGetText("Mutators", libCOMU_gv_cT_MAbomination_Mutators[libCOMU_gv_cT_MAbomination_MutatorsCount], "Name", 1)

// L16782
UserDataGetText(libCOMI_gv_c_DehakaConsumeEffectUserType, lv_userInstance, "Text", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOMU.galaxy

// L137
UserDataGetText("Mutators", lp_mutator, "Name", 1)

// L143
UserDataGetText("Mutators", lp_mutator, "Description", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOOC.galaxy

// L575
UserDataGetText("MissionObjective", libCOOC_gf_CS_ObjectiveUserDataInstance(lp_objective), "RewardText", 1)

// L813
UserDataGetText("MasteryUpgrades", lp_masteryUpgrade, "ValueFormat", 1)

// L1538
UserDataGetText("PlayerCommanders", lp_commander, "Name", 1)

// L1556
UserDataGetText("PlayerCommanders", lp_commander, "Description", 1)

// L1568
UserDataGetText("PlayerCommanders", lp_commander, "InfoDetails", lp_detailIndex)

// L1767
UserDataGetText("GeneralTips", lp_tipID, "TipTitle", 1)

// L1773
UserDataGetText("GeneralTips", lp_tipID, "TipDetails", 1)

// L2644
UserDataGetText("TechUnit", libCOOC_gf_CC_TechUnitOfArmyCategory(lp_armyCategory), "TechnologyTooltip", 1)

// L2889
UserDataGetText("ArmyUpgrade", libCOOC_gf_CC_ArmyUpgradeUserData(lp_armyUpgrade), "Results", 1)