Pack Items

Pack Items

This task is responsible for packing item definitions into an OSRS game cache.

Usage

Parameters:

• packMode: A PackConfig enum pointing to what thing you want to pack.
• itemDirectory: A File object pointing to the directory that contains the toml Definitions.

  packConfig(PackMode.ITEMS, File(""))

Item Configuration Properties:

• id: The Unique identifier for the configuration.

• inherit: ID of another configuration this one should inherit properties from. Default is -1. Optional.

• name: The name of the item. Defaults to "null" if not set.

• description: A description of the item. Defaults to "null" if not set.

• originalColours: A mutable list of original color codes. null by default, implying no colors are set unless specified.

• modifiedColours: A mutable list of modified color codes post-processing. null by default.

• originalTextureColours: A mutable list of original texture color codes. null by default.

• modifiedTextureColours: A mutable list of modified texture color codes. null by default.

• params: A map containing additional integer-keyed parameters. null by default, which implies no additional parameters unless explicitly set.

• resizeX: The resize dimension on the X-axis. Default is 128.

• resizeY: The resize dimension on the Y-axis. Default is 128.

• resizeZ: The resize dimension on the Z-axis. Default is 128.

• xan2d, yan2d, zan2d: 2D transformations (possibly rotations) along the X, Y, and Z axes. All default to 0.

• wearPos1, wearPos2, wearPos3: Indices representing where the item can be worn. Defaults to 0.

• weight: The weight of the item. Default is 0.0.

• cost: The cost of the item in the game's currency. Default is 1.

• isTradeable: Indicates whether the item can be traded. Default is false.

• stacks: The number of times this item can stack in inventory. Default is 0.

• inventoryModel: The model ID used in the inventory. Default is 0.

• members: Boolean indicating whether the item is available only to members. Default is false.

• zoom2d: The zoom level for the item in a 2D view. Default is 2000.

• xOffset2d, yOffset2d: Offsets in the 2D view for the X and Y axes. Both default to 0.

• ambient, contrast: Ambient and contrast settings for the item's appearance. Defaults are 0.

• countCo, countObj: Mutable lists for counting operations, each initialized with 10 zeros.

• maleModel0, maleModel1, maleModel2: Model IDs for male versions of the item. All default to -1.

• femaleModel0, femaleModel1, femaleModel2: Model IDs for female versions of the item. All default to -1.

• noteLinkId, noteTemplateId, unnotedId, notedId, placeholderLink, placeholderTemplate: Identifiers for various item states such as noted, unnoted, and placeholders. All default to -1.

• option1 to option5: Customizable ground interaction options for the item, such as "Take". null by default

• ioption1 to ioption5: Customizable interface interaction options for the item, such as "Drop". null by default

Example

id= 3434
inherit= 995
name = "WowCoins"
ioption2 = "Claim"