@ianlucas/cs2-lib
    Preparing search index...

    Class CS2InventoryItem

    Hierarchy (View Summary)

    Implements

    • Interface<
          Omit<
              CS2BaseInventoryItem,
              "keychains"
              | "patches"
              | "stickers"
              | "storage",
          >,
      >
    Index

    Constructors

    constructor

    Properties

    altName base baseId category collection collectionDesc collectionImage collectionName containerId containerType def desc economy equipped equippedCT equippedT free id image index item keychains keys language legacy legacyStickerOffsetXMax legacyStickerOffsetXMin legacyStickerOffsetYMax legacyStickerOffsetYMin legacyStickerSchemaCount model name nameTag paintMaterial patches playerModel rarity seed specialsImage statTrak statTrakless statTrakOnly stickerId stickerOffsetXMax stickerOffsetXMin stickerOffsetYMax stickerOffsetYMin stickers stickerSchemaCount storage tint tournamentDesc type uid updatedAt wear wearMax wearMin

    Accessors

    contents parent rawContents rawSpecials specials teams wrappedSticker

    Methods

    allKeychains allPatches allStickers asBase edit expectAgent expectContainer expectKey expectKeychain expectNameTag expectPatch expectStatTrakSwapTool expectSticker expectStorageUnit getCollectionImage getImage getKeychainsCount getKeychainSeed getMaximumSeed getMaximumStickerOffsetX getMaximumStickerOffsetY getMaximumWear getMinimumSeed getMinimumStickerOffsetX getMinimumStickerOffsetY getMinimumWear getModelData getPaintMaterial getPatchesCount getPlayerModel getSpecialsImage getStickerSchemaCount getStickersCount getStickerWear getWear groupContents hasKeychains hasNameTag hasPatches hasSeed hasStatTrak hasStickers hasWear isAgent isC4 isCollectible isContainer isContract isEquipment isGloves isGraffiti isGraffitiBox isHeavy isInContainers isInDisplay isInEquipments isInGraphicArts isInMidTiers isInMisc isInRifles isKey isKeychain isMachinegun isMelee isMusicKit isNameTag isPaintable isPatch isPistol isRifle isSMG isSniperRifle isSouvenirCase isStatTrakSwapTool isSticker isStickerCapsule isStorageUnit isStub isTool isWeapon isWeaponCase listContents someKeychains somePatches someStickers unlockContainer stickersFromArray stickersToArray

    Constructors

    Properties

    altName: string | undefined
    base: boolean | undefined
    baseId: number | undefined
    category: string | undefined
    collection: string | undefined
    collectionDesc: string | undefined
    collectionImage: string | undefined
    collectionName: string | undefined
    containerId: number | undefined
    containerType: CS2ContainerType | undefined
    def: number | undefined
    desc: string | undefined
    economy: CS2EconomyInstance
    equipped: boolean | undefined
    equippedCT: boolean | undefined
    equippedT: boolean | undefined
    free: boolean | undefined
    id: number = ...
    image: string | undefined
    index: number | undefined
    item: CS2Item
    keychains:
        | Map<
            number,
            { id: number; seed?: number; x?: number; y?: number; z?: number },
        >
        | undefined
    keys: number[] | undefined
    language: CS2ItemTranslation
    legacy: boolean | undefined
    legacyStickerOffsetXMax: number | undefined
    legacyStickerOffsetXMin: number | undefined
    legacyStickerOffsetYMax: number | undefined
    legacyStickerOffsetYMin: number | undefined
    legacyStickerSchemaCount: number | undefined
    model: string | undefined
    name: string = ...
    nameTag: string | undefined
    paintMaterial: string | undefined
    patches: Map<number, number> | undefined
    playerModel: string | undefined
    rarity: CS2RarityColor = ...
    seed: number | undefined
    specialsImage: string | undefined
    statTrak: number | undefined
    statTrakless: boolean | undefined
    statTrakOnly: boolean | undefined
    stickerId: number | undefined
    stickerOffsetXMax: number | undefined
    stickerOffsetXMin: number | undefined
    stickerOffsetYMax: number | undefined
    stickerOffsetYMin: number | undefined
    stickers:
        | Map<
            number,
            {
                id: number;
                rotation?: number;
                schema?: number;
                wear?: number;
                x?: number;
                y?: number;
            },
        >
        | undefined
    stickerSchemaCount: number | undefined
    storage: Map<number, CS2InventoryItem> | undefined
    tint: number | undefined
    tournamentDesc: string | undefined
    type: CS2ItemType = ...
    uid: number
    updatedAt: number | undefined
    wear: number | undefined
    wearMax: number | undefined
    wearMin: number | undefined

    Accessors

    • get rawContents(): number[] | undefined

      Returns number[] | undefined

    • get rawSpecials(): number[] | undefined

      Returns number[] | undefined

    • get specials(): CS2EconomyItem[] | undefined

      Returns CS2EconomyItem[] | undefined

    • set specials(value: number[] | undefined): void

      Parameters

      • value: number[] | undefined

      Returns void

    Methods

    • Returns [
          number,
          | { id: number; seed?: number; x?: number; y?: number; z?: number }
          | undefined,
      ][]

    • Returns [number, number | undefined][]

    • Returns [
          number,
          {
              id: number;
              rotation?: number;
              schema?: number;
              wear?: number;
              x?: number;
              y?: number;
          },
      ][]

    • Parameters

      • slot: number

      Returns number

    • Count of sticker schemas (StickerMarkup anchors) the model defines; valid schema is [0, count). Independent of the 5-deep stack (CS2_MAX_STICKERS), so a model with fewer schemas than stickers shares anchors.

      Returns number

    • Parameters

      • slot: number

      Returns number

    • Returns [number, { id: number; seed?: number; x?: number; y?: number; z?: number }][]

    • Returns [number, number][]

    • Returns [
          number,
          {
              id: number;
              rotation?: number;
              schema?: number;
              wear?: number;
              x?: number;
              y?: number;
          },
      ][]

    • Parameters

      • Optionaloptions: {
            computeOdds?: (
                rarities: (
                    | "common"
                    | "uncommon"
                    | "rare"
                    | "mythical"
                    | "legendary"
                    | "ancient"
                    | "immortal"
                    | "special"
                )[],
            ) => number[]
            | undefined;
        }

      Returns CS2UnlockedItem

    • Parameters

      • stickers: {
            id: number;
            rotation?: number;
            schema?: number;
            wear?: number;
            x?: number;
            y?: number;
        }[]
        • id: number
        • Optionalrotation?: number
        • Optionalschema?: number

          Physical anchor: a StickerMarkup index in [0, CS2EconomyItem.getStickerSchemaCount()).

        • Optionalwear?: number
        • Optionalx?: number
        • Optionaly?: number

      Returns
          | Record<
              string,
              {
                  id: number;
                  rotation?: number;
                  schema?: number;
                  wear?: number;
                  x?: number;
                  y?: number;
              },
          >
          | undefined

    • Parameters

      • stickers:
            | Record<
                string,
                {
                    id: number;
                    rotation?: number;
                    schema?: number;
                    wear?: number;
                    x?: number;
                    y?: number;
                },
            >
            | undefined
      • OptionalschemaCount: number

      Returns {
          id: number;
          rotation?: number;
          schema?: number;
          wear?: number;
          x?: number;
          y?: number;
      }[]

      • id: number
      • Optionalrotation?: number
      • Optionalschema?: number

        Physical anchor: a StickerMarkup index in [0, CS2EconomyItem.getStickerSchemaCount()).

      • Optionalwear?: number
      • Optionalx?: number
      • Optionaly?: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    allKeychainsallPatchesallStickersasBaseeditexpectAgentexpectContainerexpectKeyexpectKeychainexpectNameTagexpectPatchexpectStatTrakSwapToolexpectStickerexpectStorageUnitgetCollectionImagegetImagegetKeychainsCountgetKeychainSeedgetMaximumSeedgetMaximumStickerOffsetXgetMaximumStickerOffsetYgetMaximumWeargetMinimumSeedgetMinimumStickerOffsetXgetMinimumStickerOffsetYgetMinimumWeargetModelDatagetPaintMaterialgetPatchesCountgetPlayerModelgetSpecialsImagegetStickerSchemaCountgetStickersCountgetStickerWeargetWeargroupContentshasKeychainshasNameTaghasPatcheshasSeedhasStatTrakhasStickershasWearisAgentisC4isCollectibleisContainerisContractisEquipmentisGlovesisGraffitiisGraffitiBoxisHeavyisInContainersisInDisplayisInEquipmentsisInGraphicArtsisInMidTiersisInMiscisInRiflesisKeyisKeychainisMachinegunisMeleeisMusicKitisNameTagisPaintableisPatchisPistolisRifleisSMGisSniperRifleisSouvenirCaseisStatTrakSwapToolisStickerisStickerCapsuleisStorageUnitisStubisToolisWeaponisWeaponCaselistContentssomeKeychainssomePatchessomeStickersunlockContainerstickersFromArraystickersToArray