Skip to content

Pack Objects

Mark7625 edited this page Apr 30, 2024 · 1 revision

Pack Objects

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

Usage

Parameters:

  • packMode: A PackConfig enum pointing to what thing you want to pack.
  • ojectsDirectory: A File object pointing to the directory that contains the toml Definitions.
  packConfig(PackMode.OBJECTS, File(""))

Object Configuration Properties:

  • id: The Unique identifier for the configuration.

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

  • decorDisplacement: Displacement value for decor purposes, used to adjust the item's default position. Default is 16.

  • isHollow: Indicates whether the item is hollow. Default is false.

  • objectModels: A mutable list of model identifiers for the item. null by default.

  • objectTypes: A mutable list of type identifiers for the item. null by default.

  • recolorToFind: A mutable list of color codes that are targeted for recoloring. null by default.

  • mapAreaId: Identifier for the map area where the item is located. Default is -1.

  • retextureToReplace: A mutable list of texture identifiers that are targeted for replacement. null by default.

  • sizeX, sizeY: Dimensions of the item along the X and Y axes. Defaults are 1.

  • soundDistance: The maximum distance at which the item's sound can be heard. Default is 0.

  • soundRetain: Duration for which the sound should be retained. Default is 0.

  • ambientSoundIds: A mutable list of ambient sound identifiers associated with the item. null by default.

  • offsetX, offsetY, offsetZ: Offset adjustments for the item's position along the X, Y, and Z axes. Defaults are 0.

  • nonFlatShading: Indicates whether the shading of the item should be non-flat. Default is false.

  • interactive: Level of interactivity assigned to the item. Default is -1.

  • animationId: Identifier for the animation associated with the item. Default is -1.

  • varbitId, varpId: Identifiers for variable bits and variable players used for dynamic item states. Defaults are -1.

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

  • actions: A mutable list of custom action strings available for interaction with the item. Defaults are null.

  • solid: Indicates the solidity of the item, affecting collision properties. Default is 2.

  • mapSceneID: Identifier for the map scene associated with the item. Default is -1.

  • clipMask: Clipping mask for the item, determining how other objects interact with it spatially. Default is 0.

  • recolorToReplace: List of color codes targeted for replacement. null by default.

  • clipped: Indicates whether the item should be considered in collision calculations. Default is true.

  • modelSizeX, modelSizeY, modelSizeZ: Dimensions of the item's model along the X, Y, and Z axes. Defaults are 128.

  • obstructive: Indicates whether the item should obstruct movement or sight. Default is false.

  • randomizeAnimStart: Indicates whether the start of the item's animation should be randomized. Default is true.

  • clipType: Type of clipping applied to the item, affecting its interaction with other objects. Default is -1.

  • category: Category identifier for sorting or classifying the item. Default is -1.

  • supportsItems: Indicates whether the item can support other items being placed on or near it. Default is -1.

  • configs: Array of configuration identifiers that might affect the item's behavior or appearance. null by default.

  • isRotated: Indicates whether the item is rotated from its default orientation. Default is false.

  • modelClipped: Indicates whether the item's model should be considered in collision calculations. Default is false.

  • soundMin, soundMax: Minimum and maximum sound levels associated with the item. Defaults are 0.

  • delayAnimationUpdate: Indicates whether updates to the item's animation should be delayed to avoid abrupt changes. Default is false.

  • impenetrable: Indicates whether the item is completely impenetrable, affecting its interaction with other objects. Default is true.

  • option1 to option5: Customizable interaction options for the item. All are null by default.

Example

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

Documentation

Clone this wiki locally