# User Data (Integer)

Grammar — User Data (userType, instance, field, index)
FlagsNative | 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 — int

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

Category: User Data / Get Value

# Examples

# campaigns/swarm.sc2campaign

MapScript.galaxy

// L533
UserDataGetInt("WriterStates", "ZagaraTalkTimes", "Value", 1)
// L555
UserDataGetInt("WriterStates", "ZagaraTalkTimes", "Value", 1)
// L731
UserDataGetInt("WriterStates", "ToshChoice", "Value", 1)
// L533
UserDataGetInt("WriterStates", "ZagaraTalkTimes", "Value", 1)
// L555
UserDataGetInt("WriterStates", "ZagaraTalkTimes", "Value", 1)
// L731
UserDataGetInt("WriterStates", "ToshChoice", "Value", 1)

# campaigns/swarmstory.sc2campaign

SwarmCampaignLib.galaxy

// L1725
UserDataGetInt("StoryStates", "(Mission)ResourcePickedTipPlayed", "value", 1)
// L2104
UserDataGetInt("CampaignTips", lp_tipData, "Created", 1)
// L2110
UserDataGetInt("CampaignTips", lp_tipData, "Created", 1)
// L3545
UserDataGetInt("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "Index", 1)
// L3683
UserDataGetInt("CampaignTips", lp_tipData, "Created", 1)
// L4852
UserDataGetInt("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "AvailableAge", 1)
// L4855
UserDataGetInt("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "CompletedAge", 1)
// L5067
UserDataGetInt("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "BestTime", libSwaC_gf_ZS_DifficultyIndex(lp_difficulty))
// L5235
UserDataGetInt("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "KerriganXP", 1)
// L5243
UserDataGetInt("MissionObjective", libSwaC_gf_ZS_ObjectiveUserDataInstance(lv_indexObjective), "CheatProgress", 1)

# campaigns/swarmstoryutil.sc2mod

Lib281DEC45.galaxy

// L382
UserDataGetInt("WriterStates", "KerriganPrimalColumn", "Value", 1)
// L387
UserDataGetInt("WriterStates", "KerriganFirstTier", "Value", 1)
// L529
UserDataGetInt("Character", lv_character, "Unlocked", 1)
// L531
UserDataGetInt("Character", lv_character, "Ambient", 1)
// L600
UserDataGetInt("WriterStates", lv_indexState, "Value", 1)
// L606
UserDataGetInt("StoryStates", "Kerrigan UI Visited", "value", 1)
// L1344
UserDataGetInt("Planets", UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogLocation, lp_location, "UserReference", 1)), "SortIndex", 1)
// L1721
UserDataGetInt("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "KerriganXP", 1)
// L1724
UserDataGetInt("Maps", libSwaC_gf_ZS_MapUserDataInstance(lp_mission), "KerriganXPProgress", 1)
// L1961
UserDataGetInt("StoryStates", lib281DEC45_gf_ZSS_UIMainBottomButtonClickedState(lib281DEC45_ge_ZSS_UIMainBottomButtonType_BottomButtonEvolution), "value", 1)

# campaigns/void.sc2campaign

MapScript.galaxy

// L256
UserDataGetInt("WriterStates", "TalkedToPossessedRohana", "Value", 1)
// L665
UserDataGetInt("WriterStates", "TalkedToPossessedRohana", "Value", 1)
// L1025
UserDataGetInt("Clickable", "AmonPreserver", "New", 1)
// L3542
UserDataGetInt("StoryStates", "Army Room Visited", "Value", 1)
// L256
UserDataGetInt("WriterStates", "TalkedToPossessedRohana", "Value", 1)
// L665
UserDataGetInt("WriterStates", "TalkedToPossessedRohana", "Value", 1)
// L1025
UserDataGetInt("Clickable", "AmonPreserver", "New", 1)
// L3542
UserDataGetInt("StoryStates", "Army Room Visited", "Value", 1)

# campaigns/voidstory.sc2campaign

VoidCampaignLib.galaxy

// L2041
UserDataGetInt("Locations", libVoiC_gf_PC_LocationUserData(lp_planet), "Available", 1)
// L2374
UserDataGetInt("Maps", lv_userInstance, "RewardShip", 1)
// L2390
UserDataGetInt("Maps", lv_userInstance, "RewardShipSpecial", 1)
// L2399
UserDataGetInt("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "RewardsUnitDynamic", 1)
// L2460
UserDataGetInt("Maps", lv_userInstance, "RewardShipSlot", 1)
// L2525
UserDataGetInt("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "AvailableAge", 1)
// L2528
UserDataGetInt("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "CompletedAge", 1)
// L2816
UserDataGetInt("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), "BestTime", libVoiC_gf_PC_DifficultyIndex(lp_difficulty))
// L2877
UserDataGetInt("Maps", libVoiC_gf_PC_MapUserDataInstance(lp_mission), lv_field, 1)
// L2998
UserDataGetInt("Maps", lp_mission, "RewardArmySlot", lv_slotIndex)

# campaigns/voidstory.sc2campaign

VoidCampaignMissionLib.galaxy

// L2660
UserDataGetInt("CampaignTips", lp_tipData, "Created", 1)
// L2660
UserDataGetInt("CampaignTips", lp_tipData, "Display Limit", 1)
// L2660
UserDataGetInt("CampaignTips", lp_tipData, "Display Limit", 1)
// L2666
UserDataGetInt("CampaignTips", lp_tipData, "Created", 1)

# campaigns/voidstory.sc2campaign

VoidCampaignStoryLib.galaxy

// L376
UserDataGetInt(lv_userType, lv_userInstance, lv_userField, 1)
// L487
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L493
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L499
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L505
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L511
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L517
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L744
UserDataGetInt("Clickable", lv_indexClickable, "Type", 1)
// L815
UserDataGetInt("StoryStates", lv_indexState, "Snapshot", 1)
// L816
UserDataGetInt("StoryStates", lv_indexState, "Value", 1)

# campaigns/voidstory.sc2campaign

VoidCampaignUILib.galaxy

// L742
UserDataGetInt("StoryStates", "Army UI Visited", "Value", 1)
// L2574
UserDataGetInt("StoryStates", "Ship UI Visited", "Value", 1)
// L2592
UserDataGetInt("StoryStates", "Ship UI Visited", "Value", 1)
// L2827
UserDataGetInt("StoryStates", "FenixNameChange", "Value", 1)
// L3114
UserDataGetInt("Locations", UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogLocation, lp_location, "UserReference", 1)), "SortIndex", 1)
// L6636
UserDataGetInt("StoryStates", "Army UI Visited", "Value", 1)
// L6726
UserDataGetInt("StoryStates", "Army UI Visited", "Value", 1)
// L6787
UserDataGetInt("StoryStates", "Army UI Visited", "Value", 1)

# mods/heroesdata.stormmod

GameLib.galaxy

// L183
UserDataGetInt("TheWheelOfCommand", "[Default]", "PingIndex", 1)
// L17943
UserDataGetInt(libGame_gv_wheelCmdUserType, lv_instance, "PingIndex", 1)

# mods/heroesmapmods/battlegroundmapmods/braxisholdout.stormmod

LibSCHO.galaxy

// L1578
UserDataGetInt("BeaconWaves", lv_tier, lv_count, lv_itUserData)
// L3520
UserDataGetInt("AttackWaves", lp_attackWave, "Count", lv_itUserData)

# mods/missionpacks/campaigncommon.sc2mod

LibCMMI.galaxy

// L182
UserDataGetInt("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "Progress", 1)

# mods/missionpacks/campaigncommon.sc2mod

LibComC.galaxy

// L459
UserDataGetInt("Locations", libComC_gf_CC_LocationUserData(lp_location), "Default", 1)
// L504
UserDataGetInt("Locations", libComC_gf_CC_LocationUserData(lp_planet), "Available", 1)
// L670
UserDataGetInt("Maps", libComC_gf_CC_MapUserDataInstance(lp_map), "Internal", 1)
// L743
UserDataGetInt("Maps", libComC_gf_CC_MapUserDataInstance(lp_mission), "AvailableAge", 1)
// L746
UserDataGetInt("Maps", libComC_gf_CC_MapUserDataInstance(lp_mission), "CompletedAge", 1)
// L812
UserDataGetInt("Maps", libComC_gf_CC_MapUserDataInstance(lp_mission), "BestTime", libComC_gf_CC_DifficultyIndex(lp_difficulty))
// L1385
UserDataGetInt("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "Available", 1)
// L1389
UserDataGetInt("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "Complete", 1)
// L1393
UserDataGetInt("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "Available", 1)
// L1393
UserDataGetInt("MissionObjective", libComC_gf_CC_ObjectiveUserDataInstance(lp_objective), "Complete", 1)

# mods/missionpacks/novacampaign.sc2mod

LibNCMI.galaxy

// L2396
UserDataGetInt("CharacterStatus", lp_character, "IsAlive", 1)
// L2877
UserDataGetInt("CampaignTips", lp_tipData, "Created", 1)
// L2877
UserDataGetInt("CampaignTips", lp_tipData, "Display Limit", 1)
// L2877
UserDataGetInt("CampaignTips", lp_tipData, "Display Limit", 1)
// L2883
UserDataGetInt("CampaignTips", lp_tipData, "Created", 1)
// L6280
UserDataGetInt("StoryStates", "NovaHasRevivedBefore", "Value", 1)

# mods/missionpacks/novacampaign.sc2mod

LibNCST.galaxy

// L318
UserDataGetInt(lv_userType, lv_userInstance, lv_userField, 1)
// L432
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L438
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L444
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L450
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L456
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L462
UserDataGetInt((lp_userType), (lp_userInstance), (lp_userField), 1)
// L657
UserDataGetInt("Clickable", lv_indexClickable, "Type", 1)
// L726
UserDataGetInt("StoryStates", lv_indexState, "Snapshot", 1)
// L727
UserDataGetInt("StoryStates", lv_indexState, "Value", 1)

# mods/missionpacks/novacampaign.sc2mod

LibNCUI.galaxy

// L2035
UserDataGetInt("WriterStates", "VisitedArmyUpgradeRoom", "Value", 1)
// L2760
UserDataGetInt("WriterStates", "VisitedEquipmentRoom", "Value", 1)
// L6199
UserDataGetInt("WriterStates", "HaveReigel", "Value", 1)