# User Data (Image)

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

native string UserDataGetImagePath(
	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
UserDataGetImagePath("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Icon", 1)

// L3687
UserDataGetImagePath("CampaignTips", lp_tipData, "Icon", 1)

// L4752
UserDataGetImagePath("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_map), "LoadingScreenVictoryImage", 1)

// L4763
UserDataGetImagePath("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_map), "UI_MissionArchive_Background", 1)

// L16709
UserDataGetImagePath("CampaignTips", "MineralPickup", "Icon", 1)

# campaigns/swarmstoryutil.sc2mod

— Lib281DEC45.galaxy

// L969
UserDataGetImagePath("Scenes", lv_scene, "Archives Image", 1)

// L2164
UserDataGetImagePath("CampaignTips", lp_tip, "Icon", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignLib.galaxy

// L2017
UserDataGetImagePath("Locations", libVoiC_gf_PC_LocationUserData(lp_loadingLocation), "LoadingImage", 1)

// L2204
UserDataGetImagePath("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_map), "LoadingScreenVictoryImage", 1)

// L4279
UserDataGetImagePath("SpearofAdunUpgrade", lp_soAUpgrade, "Icon", 1)

// L4519
UserDataGetImagePath("TechUnit", libVoiC_gf_PC_TechUnitOfArmyCategory(lp_armyCategory), "EvolutionMissionIcon", 1)

// L5074
UserDataGetImagePath("ArmyUpgradeCategories", libVoiC_gf_PC_ArmyUnitFaction(lp_armyUnit), "Icon", 1)

// L5080
UserDataGetImagePath("ArmyUpgradeCategories", libVoiC_gf_PC_ArmyUnitFaction(lp_armyUnit), "HoverIcon", 1)

// L5086
UserDataGetImagePath("ArmyUpgradeCategories", libVoiC_gf_PC_ArmyUnitFaction(lp_armyUnit), "CategoryIcon", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignMissionLib.galaxy

// L2730
UserDataGetImagePath("CampaignTips", libVCMI_gv_pM_MissionTip[lv_index], "Icon", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignStoryLib.galaxy

// L1366
UserDataGetImagePath("CampaignTips", lp_tip, "Icon", 1)

# campaigns/voidstory.sc2campaign

— VoidCampaignUILib.galaxy

// L947
UserDataGetImagePath("CampaignUnitAbilities", lv_ability, "Icon", 1)

// L1542
UserDataGetImagePath("Scenes", lv_selectedScene, "Image", 1)

// L2473
UserDataGetImagePath("CampaignPerk", lv_indexPerk, "Icon", 1)

// L10403
UserDataGetImagePath("LoreCredits", UserDataInstance("LoreCredits", libVCUI_gv_pU_LoreCreditsItemDisplayCounter), "Picture", 1)

# mods/missionpacks/campaigncommon.sc2mod

— LibComC.galaxy

// L489
UserDataGetImagePath("Locations", libComC_gf_CC_LocationUserData(lp_loadingLocation), "LoadingImage", 1)

// L620
UserDataGetImagePath("Maps", libComC_gf_CC_MapUserDataInstance(lp_map), "LoadingScreenVictoryImage", 1)

// L2739
UserDataGetImagePath("CampaignPerk", lp_campaignPerk, "Icon", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCMI.galaxy

// L2947
UserDataGetImagePath("CampaignTips", libNCMI_gv_NM_MissionTip[lv_index], "Icon", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCST.galaxy

// L1247
UserDataGetImagePath("CampaignTips", lp_tip, "Icon", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNCUI.galaxy

// L670
UserDataGetImagePath("Scenes", lv_selectedScene, "Image", 1)

# mods/missionpacks/novacampaign.sc2mod

— LibNovC.galaxy

// L1343
UserDataGetImagePath("Maps", libComC_gf_CC_MapUserDataInstance(lp_map), "CampaignScreenImage", 1)

// L1547
UserDataGetImagePath("CampaignTechItem", lp_techItem, "Icon", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOMU.galaxy

// L149
UserDataGetImagePath("Mutators", lp_mutator, "Icon", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOOC.galaxy

// L1532
UserDataGetImagePath("PlayerCommanders", lp_commander, "CustomImage", 1)

// L1779
UserDataGetImagePath("GeneralTips", lp_tipID, "TipIcon", 1)

// L2621
UserDataGetImagePath("TechUnit", libCOOC_gf_CC_TechUnitOfArmyCategory(lp_armyCategory), "EvolutionMissionIcon", 1)

# mods/starcoop/starcoop.sc2mod

— LibCOUI.galaxy

// L2288
UserDataGetImagePath("PlayerCommanders", libCOOC_gf_ActiveCommanderForPlayer(lp_player), "PrestigeIcon", 1)

// L2290
UserDataGetImagePath("PlayerCommanders", libCOOC_gf_ActiveCommanderForPlayer(lp_player), "PrestigeIcon", 1)

// L2296
UserDataGetImagePath("PlayerCommanders", libCOOC_gf_ActiveCommanderForPlayer(lp_playerAlly), "PrestigeIcon", 1)

// L2298
UserDataGetImagePath("PlayerCommanders", libCOOC_gf_ActiveCommanderForPlayer(lp_playerAlly), "PrestigeIcon", 1)

// L5252
UserDataGetImagePath("CoopTechTychusSquad", "Tychus", "2D Portrait", 1)

// L5410
UserDataGetImagePath("CoopTechTychusSquad", lp_squadInstance, "2D Portrait", 1)

# mods/voidprologue.sc2mod

— LibA3DDD02B.galaxy

// L1497
UserDataGetImagePath("CampaignTips", libA3DDD02B_gv_pP_MissionTip[lv_index], "Icon", 1)

// L2400
UserDataGetImagePath("CampaignTips", lp_tipData, "Icon", 1)

// L3709
UserDataGetImagePath("Maps", libA3DDD02B_gf_PP_MapUserDataInstance(lp_map), "LoadingScreenVictoryImage", 1)

// L3720
UserDataGetImagePath("Maps", libA3DDD02B_gf_PP_MapUserDataInstance(lp_map), "UI_MissionArchive_Background", 1)

// L7369
UserDataGetImagePath("Scenes", lv_selectedScene, "Archives Image", 1)

// L8025
UserDataGetImagePath("CampaignTips", "Zealot", "Icon", 1)

# mods/warcoop/warcoopdata.sc2mod

— WarCoopData.galaxy

// L882
UserDataGetImagePath("PlayableLegends", lv_currentLegendInstance, "SelectPortrait", 1)

// L1025
UserDataGetImagePath("PlayableLegends", lp_selectedLegendInstance, "SelectPortrait", 1)

// L1027
UserDataGetImagePath("PlayableLegends", lp_selectedLegendInstance, "SelectBackgroundImage", 1)

# mods/warcoop/warmeleeai.sc2mod

— LibW3AI.galaxy

// L105
UserDataGetImagePath(lv_type, lv_entry, "Icon", 1)