SW Combine SDK
    Preparing search index...

    Variable ScopesConst

    Scopes: {
        Character: {
            ALL: "character_all";
            AUTH: "character_auth";
            CREDITS: "character_credits";
            CREDITS_WRITE: "character_credits_write";
            EVENTS: "character_events";
            FORCE: "character_force";
            LOCATION: "character_location";
            PRIVILEGES: "character_privileges";
            READ: "character_read";
            SKILLS: "character_skills";
            STATS: "character_stats";
        };
        Faction: {
            ALL: "faction_all";
            BUDGETS_READ: "faction_budgets_read";
            BUDGETS_WRITE: "faction_budgets_write";
            CREDITS_READ: "faction_credits_read";
            CREDITS_WRITE: "faction_credits_write";
            DATACARDS_READ: "faction_datacards_read";
            DATACARDS_WRITE: "faction_datacards_write";
            MEMBERS: "faction_members";
            READ: "faction_read";
            STOCKS: "faction_stocks";
        };
        FactionInventory: {
            CITIES: Record<string, string>;
            CREATURES: Record<string, string>;
            DROIDS: Record<string, string>;
            FACILITIES: Record<string, string>;
            ITEMS: Record<string, string>;
            MATERIALS: {
                ALL: "faction_inv_materials_all";
                MAKEOVER: "faction_inv_materials_makeover";
                READ: "faction_inv_materials_read";
                RENAME: "faction_inv_materials_rename";
                TAGS_READ: "faction_inv_materials_tags_read";
                TAGS_WRITE: "faction_inv_materials_tags_write";
            };
            NPCS: {
                ALL: "faction_inv_npcs_all";
                ASSIGN: "faction_inv_npcs_assign";
                MAKEOVER: "faction_inv_npcs_makeover";
                READ: "faction_inv_npcs_read";
                TAGS_READ: "faction_inv_npcs_tags_read";
                TAGS_WRITE: "faction_inv_npcs_tags_write";
            };
            OVERVIEW: "faction_inv_overview";
            PLANETS: Record<string, string>;
            SHIPS: Record<string, string>;
            STATIONS: Record<string, string>;
            VEHICLES: Record<string, string>;
        };
        Messages: {
            ALL: "messages_all";
            DELETE: "messages_delete";
            READ: "messages_read";
            SEND: "messages_send";
        };
        PersonalInventory: {
            CITIES: Record<string, string>;
            CREATURES: Record<string, string>;
            DROIDS: Record<string, string>;
            FACILITIES: Record<string, string>;
            ITEMS: Record<string, string>;
            MATERIALS: {
                ALL: "personal_inv_materials_all";
                MAKEOVER: "personal_inv_materials_makeover";
                READ: "personal_inv_materials_read";
                RENAME: "personal_inv_materials_rename";
                TAGS_READ: "personal_inv_materials_tags_read";
                TAGS_WRITE: "personal_inv_materials_tags_write";
            };
            NPCS: {
                ALL: "personal_inv_npcs_all";
                ASSIGN: "personal_inv_npcs_assign";
                MAKEOVER: "personal_inv_npcs_makeover";
                READ: "personal_inv_npcs_read";
                TAGS_READ: "personal_inv_npcs_tags_read";
                TAGS_WRITE: "personal_inv_npcs_tags_write";
            };
            OVERVIEW: "personal_inv_overview";
            PLANETS: Record<string, string>;
            SHIPS: Record<string, string>;
            STATIONS: Record<string, string>;
            VEHICLES: Record<string, string>;
        };
    } = ...

    All available scopes organized by category

    Type Declaration

    • ReadonlyCharacter: {
          ALL: "character_all";
          AUTH: "character_auth";
          CREDITS: "character_credits";
          CREDITS_WRITE: "character_credits_write";
          EVENTS: "character_events";
          FORCE: "character_force";
          LOCATION: "character_location";
          PRIVILEGES: "character_privileges";
          READ: "character_read";
          SKILLS: "character_skills";
          STATS: "character_stats";
      }
      • ReadonlyALL: "character_all"

        Access all character information (includes all above)

      • ReadonlyAUTH: "character_auth"

        Solely provides the character name and ID for use by clients who want to verify a character's identity

      • ReadonlyCREDITS: "character_credits"

        Read character credit information

      • ReadonlyCREDITS_WRITE: "character_credits_write"

        Transfer character credits

      • ReadonlyEVENTS: "character_events"

        Read character events

      • ReadonlyFORCE: "character_force"

        Read character force-related information (FP, FXP, regen rate, Force Meter)

      • ReadonlyLOCATION: "character_location"

        Read location information in-game

      • ReadonlyPRIVILEGES: "character_privileges"

        Read character privileges

      • ReadonlyREAD: "character_read"

        Read basic character information (UID, handle, image, race, gender, etc.)

      • ReadonlySKILLS: "character_skills"

        Read character skills

      • ReadonlySTATS: "character_stats"

        Read character HP and XP

    • ReadonlyFaction: {
          ALL: "faction_all";
          BUDGETS_READ: "faction_budgets_read";
          BUDGETS_WRITE: "faction_budgets_write";
          CREDITS_READ: "faction_credits_read";
          CREDITS_WRITE: "faction_credits_write";
          DATACARDS_READ: "faction_datacards_read";
          DATACARDS_WRITE: "faction_datacards_write";
          MEMBERS: "faction_members";
          READ: "faction_read";
          STOCKS: "faction_stocks";
      }
      • ReadonlyALL: "faction_all"

        All faction permissions

      • ReadonlyBUDGETS_READ: "faction_budgets_read"

        Read faction budgets

      • ReadonlyBUDGETS_WRITE: "faction_budgets_write"

        Write faction budgets

      • ReadonlyCREDITS_READ: "faction_credits_read"

        Read faction credits

      • ReadonlyCREDITS_WRITE: "faction_credits_write"

        Write/transfer faction credits

      • ReadonlyDATACARDS_READ: "faction_datacards_read"

        Read faction datacards

      • ReadonlyDATACARDS_WRITE: "faction_datacards_write"

        Write faction datacards

      • ReadonlyMEMBERS: "faction_members"

        Read faction members

      • ReadonlyREAD: "faction_read"

        Read faction information

      • ReadonlySTOCKS: "faction_stocks"

        Read faction stocks

    • ReadonlyFactionInventory: {
          CITIES: Record<string, string>;
          CREATURES: Record<string, string>;
          DROIDS: Record<string, string>;
          FACILITIES: Record<string, string>;
          ITEMS: Record<string, string>;
          MATERIALS: {
              ALL: "faction_inv_materials_all";
              MAKEOVER: "faction_inv_materials_makeover";
              READ: "faction_inv_materials_read";
              RENAME: "faction_inv_materials_rename";
              TAGS_READ: "faction_inv_materials_tags_read";
              TAGS_WRITE: "faction_inv_materials_tags_write";
          };
          NPCS: {
              ALL: "faction_inv_npcs_all";
              ASSIGN: "faction_inv_npcs_assign";
              MAKEOVER: "faction_inv_npcs_makeover";
              READ: "faction_inv_npcs_read";
              TAGS_READ: "faction_inv_npcs_tags_read";
              TAGS_WRITE: "faction_inv_npcs_tags_write";
          };
          OVERVIEW: "faction_inv_overview";
          PLANETS: Record<string, string>;
          SHIPS: Record<string, string>;
          STATIONS: Record<string, string>;
          VEHICLES: Record<string, string>;
      }
      • ReadonlyCITIES: Record<string, string>

        Faction city scopes

      • ReadonlyCREATURES: Record<string, string>

        Faction creature scopes

      • ReadonlyDROIDS: Record<string, string>

        Faction droid scopes

      • ReadonlyFACILITIES: Record<string, string>

        Faction facility scopes

      • ReadonlyITEMS: Record<string, string>

        Faction item scopes

      • ReadonlyMATERIALS: {
            ALL: "faction_inv_materials_all";
            MAKEOVER: "faction_inv_materials_makeover";
            READ: "faction_inv_materials_read";
            RENAME: "faction_inv_materials_rename";
            TAGS_READ: "faction_inv_materials_tags_read";
            TAGS_WRITE: "faction_inv_materials_tags_write";
        }

        Faction material scopes (no ASSIGN)

      • ReadonlyNPCS: {
            ALL: "faction_inv_npcs_all";
            ASSIGN: "faction_inv_npcs_assign";
            MAKEOVER: "faction_inv_npcs_makeover";
            READ: "faction_inv_npcs_read";
            TAGS_READ: "faction_inv_npcs_tags_read";
            TAGS_WRITE: "faction_inv_npcs_tags_write";
        }

        Faction NPC scopes (has MAKEOVER but no RENAME)

      • ReadonlyOVERVIEW: "faction_inv_overview"

        Overview of faction inventory

      • ReadonlyPLANETS: Record<string, string>

        Faction planet scopes (no RENAME/MAKEOVER)

      • ReadonlySHIPS: Record<string, string>

        Faction ship scopes

      • ReadonlySTATIONS: Record<string, string>

        Faction station scopes

      • ReadonlyVEHICLES: Record<string, string>

        Faction vehicle scopes

    • ReadonlyMessages: {
          ALL: "messages_all";
          DELETE: "messages_delete";
          READ: "messages_read";
          SEND: "messages_send";
      }
      • ReadonlyALL: "messages_all"

        All message permissions

      • ReadonlyDELETE: "messages_delete"

        Delete messages

      • ReadonlyREAD: "messages_read"

        Read messages

      • ReadonlySEND: "messages_send"

        Send messages

    • ReadonlyPersonalInventory: {
          CITIES: Record<string, string>;
          CREATURES: Record<string, string>;
          DROIDS: Record<string, string>;
          FACILITIES: Record<string, string>;
          ITEMS: Record<string, string>;
          MATERIALS: {
              ALL: "personal_inv_materials_all";
              MAKEOVER: "personal_inv_materials_makeover";
              READ: "personal_inv_materials_read";
              RENAME: "personal_inv_materials_rename";
              TAGS_READ: "personal_inv_materials_tags_read";
              TAGS_WRITE: "personal_inv_materials_tags_write";
          };
          NPCS: {
              ALL: "personal_inv_npcs_all";
              ASSIGN: "personal_inv_npcs_assign";
              MAKEOVER: "personal_inv_npcs_makeover";
              READ: "personal_inv_npcs_read";
              TAGS_READ: "personal_inv_npcs_tags_read";
              TAGS_WRITE: "personal_inv_npcs_tags_write";
          };
          OVERVIEW: "personal_inv_overview";
          PLANETS: Record<string, string>;
          SHIPS: Record<string, string>;
          STATIONS: Record<string, string>;
          VEHICLES: Record<string, string>;
      }
      • ReadonlyCITIES: Record<string, string>

        Personal city scopes

      • ReadonlyCREATURES: Record<string, string>

        Personal creature scopes

      • ReadonlyDROIDS: Record<string, string>

        Personal droid scopes

      • ReadonlyFACILITIES: Record<string, string>

        Personal facility scopes

      • ReadonlyITEMS: Record<string, string>

        Personal item scopes

      • ReadonlyMATERIALS: {
            ALL: "personal_inv_materials_all";
            MAKEOVER: "personal_inv_materials_makeover";
            READ: "personal_inv_materials_read";
            RENAME: "personal_inv_materials_rename";
            TAGS_READ: "personal_inv_materials_tags_read";
            TAGS_WRITE: "personal_inv_materials_tags_write";
        }

        Personal material scopes (no ASSIGN)

      • ReadonlyNPCS: {
            ALL: "personal_inv_npcs_all";
            ASSIGN: "personal_inv_npcs_assign";
            MAKEOVER: "personal_inv_npcs_makeover";
            READ: "personal_inv_npcs_read";
            TAGS_READ: "personal_inv_npcs_tags_read";
            TAGS_WRITE: "personal_inv_npcs_tags_write";
        }

        Personal NPC scopes (has MAKEOVER but no RENAME)

      • ReadonlyOVERVIEW: "personal_inv_overview"

        Overview of personal inventory

      • ReadonlyPLANETS: Record<string, string>

        Personal planet scopes (no RENAME/MAKEOVER)

      • ReadonlySHIPS: Record<string, string>

        Personal ship scopes

      • ReadonlySTATIONS: Record<string, string>

        Personal station scopes

      • ReadonlyVEHICLES: Record<string, string>

        Personal vehicle scopes