# User Instance From Reference

Grammar — User instance from reference
Flags — Native | Function

Returns the user instance associated with a user reference value stored in catalog data.

# Arguments

  • string — Reference

Returns — string<userinstance>

native string UserDataInstanceFromReference(string inRef);

Category: User Data / Utility

# Examples

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:5189

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogMap, (lp_map), "UserReference", 1));
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:5994

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogObjective, (lp_objective), "UserReference", 1));
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:6546

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogLocation, (lp_planet), "UserReference", c_playerAny));
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:10089

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyCategory, (lp_armyCategory), "UserReference", 1));
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:10547

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyUpgrade, (lp_armyUpgrade), "UserReference", 1));
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:10639

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyUnit, (lp_armyUnit), "UserReference", 1));
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:12079

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogHeroAbil, (lp_ability), "UserReference", c_playerAny));
}

campaigns/swarmstoryutil.sc2mod — base.sc2data/Lib281DEC45.galaxy:477

    lib281DEC45_gf_ZSS_LoadConversations(lv_storyBank, "StoryConversations");
    lv__SectionName = "Debug";
    lib281DEC45_gv_zSSX_DebugStoryScene = UserDataInstanceFromReference(BankValueGetAsString(lv_storyBank, lv__SectionName, "DebugStoryScene"));
    if ((lib281DEC45_gf_ZSS_InNewStorymodeInstance() == true)) {
        if ((libSwaC_gf_MissionStatusCheck("ZChar1", libSwaC_ge_MissionStatus_Completed) == true)) {

campaigns/swarmstoryutil.sc2mod — base.sc2data/Lib281DEC45.galaxy:966

    }
    else if ((DataTableGetInt(true, lib281DEC45_gf_ZSS_UIArchivesDataTypeString(BattleReportPanelGetSelectedBattleReport(1))) == lib281DEC45_ge_ZSS_UIArchivesType_Scene)) {
        lv_scene = UserDataInstanceFromReference(DataTableGetString(true, lib281DEC45_gf_ZSS_UIArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
        DialogControlSetVisible(lib281DEC45_gv_zSS_UIArchivesScenePanel, PlayerGroupAll(), true);
        DialogControlSetVisible(lib281DEC45_gv_zSS_UIArchivesMissionPanel, PlayerGroupAll(), false);

campaigns/swarmstoryutil.sc2mod — base.sc2data/Lib281DEC45.galaxy:1344

int lib281DEC45_gf_ZSS_UITravelPlanetSortIndex (string lp_location) {
    // Implementation
    return UserDataGetInt("Planets", UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogLocation, lp_location, "UserReference", 1)), "SortIndex", 1);
}

campaigns/swarmstoryutil.sc2mod — base.sc2data/Lib281DEC45.galaxy:1715

string lib281DEC45_gf_ZS_MapUserDataInstance (string lp_map) {
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogMap, (lp_map), "UserReference", 1));
}

campaigns/swarmstoryutil.sc2mod — base.sc2data/Lib281DEC45.galaxy:6203

    }

    lv_scene = UserDataInstanceFromReference(DataTableGetString(true, lib281DEC45_gf_ZSS_UIArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
    UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeBattleReportPanel, false);
    libSwaC_gf_PlayCinematic(lv_scene, true);

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:1975

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogLocation, (lp_planet), "UserReference", c_playerAny));
}

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:2822

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogMap, (lp_map), "UserReference", 1));
}

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:3815

    lv_index = DataTableGetInt(true, ("PObjIndex_" + (lp_objective)));
    if ((lv_index == 0)) {
        lv_objectiveInstance = UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogObjective, (lp_objective), "UserReference", 1));
        autoFCDD7321_ae = UserDataInstanceCount("MissionObjective");
        lv_index = 1;

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:4459

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyCategory, (lp_armyCategory), "UserReference", 1));
}

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:4953

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyUnit, (lp_armyUnit), "UserReference", 1));
}

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:3758

    // Implementation
    if ((DataTableGetString(true, (libVCST_gv_pSC_REDIRECTPREFIX + (lp_character))) != "")) {
        return UserDataInstanceFromReference(DataTableGetString(true, (libVCST_gv_pSC_REDIRECTPREFIX + (lp_character))));
    }

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:1539

    }
    else if ((DataTableGetInt(true, libVCUI_gf_PU_ArchivesDataTypeString(BattleReportPanelGetSelectedBattleReport(1))) == libVCUI_ge_PU_ArchivesType_Scene)) {
        lv_selectedScene = UserDataInstanceFromReference(DataTableGetString(true, libVCUI_gf_PU_ArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
        DialogControlSetVisible(libVCUI_gv_pU_ArchivesScenePanel, PlayerGroupAll(), true);
        DialogControlSetVisible(libVCUI_gv_pU_ArchivesMissionPanel, PlayerGroupAll(), false);

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:1646

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(DataTableGetString(true, libVCUI_gf_PU_ArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
}

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:3114

    // Automatic Variable Declarations
    // Implementation
    return UserDataGetInt("Locations", UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogLocation, lp_location, "UserReference", 1)), "SortIndex", 1);
}

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:464

string libComC_gf_CC_LocationUserData (string lp_planet) {
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogLocation, (lp_planet), "UserReference", c_playerAny));
}

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:817

string libComC_gf_CC_MapUserDataInstance (string lp_map) {
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogMap, (lp_map), "UserReference", 1));
}

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:1470

    lv_index = DataTableGetInt(true, ("PObjIndex_" + (lp_objective)));
    if ((lv_index == 0)) {
        lv_objectiveInstance = UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogObjective, (lp_objective), "UserReference", 1));
        auto6FC17B41_ae = UserDataInstanceCount("MissionObjective");
        auto6FC17B41_ai = 1;

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:1997

string libComC_gf_NC_TechUnitOfArmyCategory (string lp_armyCategory) {
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyCategory, (lp_armyCategory), "UserReference", 1));
}

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:2276

string libComC_gf_NC_TechUnitOfArmyUnit (string lp_armyUnit) {
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyUnit, (lp_armyUnit), "UserReference", 1));
}

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCST.galaxy:3227

    // Implementation
    if ((DataTableGetString(true, (libNCST_gv_nSC_REDIRECTPREFIX + (lp_character))) != "")) {
        return UserDataInstanceFromReference(DataTableGetString(true, (libNCST_gv_nSC_REDIRECTPREFIX + (lp_character))));
    }

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCUI.galaxy:667

    }
    else if ((DataTableGetInt(true, libNCUI_gf_NU_ArchivesDataTypeString(BattleReportPanelGetSelectedBattleReport(1))) == libNCUI_ge_NU_ArchivesType_Scene)) {
        lv_selectedScene = UserDataInstanceFromReference(DataTableGetString(true, libNCUI_gf_NU_ArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
        DialogControlSetVisible(libNCUI_gv_nU_ArchivesScenePanel, PlayerGroupAll(), true);
        DialogControlSetVisible(libNCUI_gv_nU_ArchivesMissionPanel, PlayerGroupAll(), false);

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCUI.galaxy:808

string libNCUI_gf_NU_ArchivesSelectedScene () {
    // Implementation
    return UserDataInstanceFromReference(DataTableGetString(true, libNCUI_gf_NU_ArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
}

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:333

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogMap, (lp_map), "UserReference", libCOOC_gv_cCC_DISREGARDPLAYER));
}

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:606

    lv_index = DataTableGetInt(true, ("PObjIndex_" + (lp_objective)));
    if ((lv_index == 0)) {
        lv_objectiveInstance = UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogObjective, (lp_objective), "UserReference", libCOOC_gv_cCC_DISREGARDPLAYER));
        autoFCDD7321_ae = UserDataInstanceCount("MissionObjective");
        lv_index = 1;

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:1419

    }

    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogCommander, (lp_commander), "UserReference", libCOOC_gv_cCC_DISREGARDPLAYER));
}

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:2549

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyCategory, (lp_armyCategory), "UserReference", libCOOC_gv_cCC_DISREGARDPLAYER));
}

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:2965

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyUpgrade, (lp_armyUpgrade), "UserReference", libCOOC_gv_cCC_DISREGARDPLAYER));
}

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:3016

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyUnit, (lp_armyUnit), "UserReference", libCOOC_gv_cCC_DISREGARDPLAYER));
}

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:4042

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogMap, (lp_map), "UserReference", 1));
}

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:4565

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogObjective, (lp_objective), "UserReference", 1));
}

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:5620

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(CatalogFieldValueGet(c_gameCatalogArmyCategory, (lp_armyCategory), "UserReference", 1));
}

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:7366

    }
    else if ((DataTableGetInt(true, libA3DDD02B_gf_PP_ArchivesDataTypeString(BattleReportPanelGetSelectedBattleReport(1))) == libA3DDD02B_ge_PP_ArchivesType_Scene)) {
        lv_selectedScene = UserDataInstanceFromReference(DataTableGetString(true, libA3DDD02B_gf_PP_ArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
        DialogControlSetVisible(libA3DDD02B_gv_pP_ArchivesScenePanel, PlayerGroupAll(), true);
        DialogControlSetVisible(libA3DDD02B_gv_pP_ArchivesMissionPanel, PlayerGroupAll(), false);

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:7400

    // Automatic Variable Declarations
    // Implementation
    return UserDataInstanceFromReference(DataTableGetString(true, libA3DDD02B_gf_PP_ArchivesDataString(BattleReportPanelGetSelectedBattleReport(1))));
}