# User Data (String)

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

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

// L6654
UserDataGetString("Scenes", lp_scene, "RecordFileName", 1)

// L6691
UserDataGetString("Scenes", lp_scene, "cutscene", 1)

// L9962
UserDataGetString("TechUnit", libSwaC_gf_ZS_TechUnitOfArmyCategory(lp_armyCategory), "PlanetPanelCamera", 1)

// L10627
UserDataGetString("TechUnit", libSwaC_gf_ZS_TechUnitOfArmyUnit(lp_armyUnit), "PlanetPanelCamera", 1)

// L10633
UserDataGetString("TechUnit", libSwaC_gf_ZS_TechUnitOfArmyUnit(lp_armyUnit), "BonusMissionCamera", 1)

# campaigns/swarmstoryutil.sc2mod

— Lib281DEC45.galaxy

// L2316
UserDataGetString("ScriptedScenes", lv_indexScene, "Type", 1)

// L2317
UserDataGetString("ScriptedScenes", lv_indexScene, "DisplayName", 1)

// L2419
UserDataGetString("ScriptedScenes", lv_scene, "Type", 1)

// L3610
UserDataGetString("AmbientScenes", lp_scene, "Bookmarks", lv_index)

// L3632
UserDataGetString("AmbientScenes",lv_sceneinstance,"CutsceneFile",1)

// L3634
UserDataGetString("AmbientScenes", lib281DEC45_gv_zSS_AmbientSceneInstance[lp_sceneIndex], "Bookmarks", lp_bookmarkIndex)

// L3635
UserDataGetString("AmbientScenes", lib281DEC45_gv_zSS_AmbientSceneInstance[lp_sceneIndex], "Bookmarks", lp_bookmarkIndex)

// L4539
UserDataGetString("Character", lp_character, "SceneToken", 1)

// L4584
UserDataGetString("Character", lp_character, "Alias", 1)

// L4589
UserDataGetString("Character", lp_character, "SceneFinderTag", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignLib.galaxy

// L2434
UserDataGetString("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "VignetteScene", 1)

// L2447
UserDataGetString("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "VignetteEasterEggScene", 1)

// L4108
UserDataGetString("Scenes", lp_scene, "RecordFileName", 1)

// L4630
UserDataGetString("TechUnit", libVoiC_gf_PC_TechUnitOfArmyCategory(lp_armyCategory), "CutsceneFilters", 1)

// L4712
UserDataGetString("TechUnit", libVoiC_gf_PC_TechUnitOfArmyCategory(lp_armyCategory), "PlanetPanelCamera", 1)

// L5122
UserDataGetString("ArmyUpgradeCategories", libVoiC_gf_PC_ArmyUnitFaction(lp_armyUnit), "CutsceneFilter", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignStoryLib.galaxy

// L167
UserDataGetString("Conversations", lv_indexConvo, "Name", 1)

// L257
UserDataGetString("Conversations", lp_convoInstance, "Group", 1)

// L2447
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Room", 1)

// L2448
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Occurance", 1)

// L2449
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Cutscene", 1)

// L2454
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Occurance", 1)

// L2455
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Cutscene", 1)

// L2460
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Occurance", 1)

// L2461
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Cutscene", 1)

// L2908
UserDataGetString("AmbientEvents", lp_ambientEvent, "CutsceneFile", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignUILib.galaxy

// L2089
UserDataGetString("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "VignetteScene", 1)

// L2181
UserDataGetString("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "UILaunchFilter", 1)

# mods/heroesdata.stormmod

— GameLib.galaxy

// L2576
UserDataGetString("EndOfMatchMapSpecificAward", lp_userData, "Present as Ratio", 1)

// L2577
UserDataGetString("EndOfMatchMapSpecificAward", lp_userData, "Gated by Base", 1)

// L2578
UserDataGetString("EndOfMatchMapSpecificAward", lp_userData, "Award Badge Index", 1)

// L2918
UserDataGetString("EndOfMatchGeneralAward", lp_userData, "Gated by Base", 1)

// L2919
UserDataGetString("EndOfMatchGeneralAward", lp_userData, "Present as Ratio", 1)

// L2921
UserDataGetString("EndOfMatchGeneralAward", lp_userData, "Award Badge Index", 1)

// L2931
UserDataGetString("EndOfMatchGeneralAward", lp_userData, "Gated by Base", 1)

// L2932
UserDataGetString("EndOfMatchGeneralAward", lp_userData, "Present as Ratio", 1)

// L2934
UserDataGetString("EndOfMatchGeneralAward", lp_userData, "Award Badge Index", 1)

# mods/heroesdata.stormmod

— UILib.galaxy

// L2357
UserDataGetString("AnnouncerPackVOReplacementList", "Default", "SoundIDSuffixes", lv_index)

# mods/liberty.sc2mod

— LibertyLib.galaxy

// L961
UserDataGetString(libLbty_gv_starCraftEventsEventTable, lv_itInstance, "Start", 1)

// L962
UserDataGetString(libLbty_gv_starCraftEventsEventTable, lv_itInstance, "End", 1)

// L966
UserDataGetString(libLbty_gv_starCraftEventsEventTable, lv_itInstance, "Message", 1)

// L967
UserDataGetString(libLbty_gv_starCraftEventsEventTable, lv_itInstance, "MessageFilter", 1)

# mods/missionpacks/campaigncommon.sc2mod

— LibComC.galaxy

// L1663
UserDataGetString("Scenes", lp_scene, "Cutscene", 1)

// L1745
UserDataGetString("Scenes", lp_scene, "RecordFileName", 1)

// L2133
UserDataGetString("TechUnit", libComC_gf_NC_TechUnitOfArmyCategory(lp_armyCategory), "PlanetPanelCamera", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCST.galaxy

// L167
UserDataGetString("Conversations", lv_indexConvo, "Name", 1)

// L260
UserDataGetString("Conversations", lp_convoInstance, "Group", 1)

// L2111
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Room", 1)

// L2112
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Occurance", 1)

// L2113
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Cutscene", 1)

// L2118
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Occurance", 1)

// L2119
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Cutscene", 1)

// L2124
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Occurance", 1)

// L2125
UserDataGetString("Backgrounds", UserDataInstance("Backgrounds", lv_backgroundIndex), "Cutscene", 1)

// L2556
UserDataGetString("AmbientEvents", lp_ambientEvent, "CutsceneFile", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOMI.galaxy

// L16778
UserDataGetString(libCOMI_gv_c_DehakaConsumeEffectUserType, lv_userInstance, "Filter", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOOC.galaxy

// L1016
UserDataGetString("PlayerPrestigeUpgradeSupplements", lp_upgradeSupplemental, "PostScript", 1)

// L1103
UserDataGetString("PlayerPrestige", lp_prestige, "ScriptName", 1)

// L1580
UserDataGetString("PlayerCommanders", lp_commander, "SelectionScene", 1)

// L1698
UserDataGetString("PlayerCommanders", lp_commander, "HeroReviveLink", 1)

# mods/voidprologue.sc2mod

— LibA3DDD02B.galaxy

// L4987
UserDataGetString("Scenes", lp_scene, "RecordFileName", 1)

// L5007
UserDataGetString("Scenes", lp_scene, "RecordFileName", 1)

// L5026
UserDataGetString("Scenes", lp_scene, "Cutscene", 1)

// L5518
UserDataGetString("TechUnit", libA3DDD02B_gf_PP_TechUnitOfArmyCategory(lp_armyCategory), "PlanetPanelCamera", 1)

# mods/warcoop/warcoopdata.sc2mod

— WarCoopData.galaxy

// L374
UserDataGetString("PlayableLegends", lv_commanderdata, "CommanderInitTrigger", 1)

// L2663
UserDataGetString("LegionDifficultyPresets", lv_difficultypresetinstance, "Name", 1)