Pack Npcs

Pack Npcs

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

Usage

Parameters:

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

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

Npc Configuration Properties:

• id: The Unique identifier for the configuration.

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

• size: Default size or scale of the entity. Default is 1.

• category: Category identifier for classifying the entity. Default is -1.

• models: A mutable list of model identifiers for the entity. null by default.

• chatheadModels: A mutable list of chat head model identifiers. null by default.

• standAnim: Animation identifier for the standing pose. Default is -1.

• rotateLeftAnim: Animation identifier for rotating left. Default is -1.

• rotateRightAnim: Animation identifier for rotating right. Default is -1.

• walkAnim: Animation identifier for walking. Default is -1.

• rotateBackAnim: Animation identifier for rotating back. Default is -1.

• walkLeftAnim: Animation identifier for walking left. Default is -1.

• walkRightAnim: Animation identifier for walking right. Default is -1.

• actions: A mutable list of custom interaction options for the entity. All entries are null by default.

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

• modifiedColours: A mutable list of modified color codes after 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.

• varbit: Variable bit identifier for additional configuration based on game logic. Default is -1.

• varp: Variable player identifier for configuration based on player-specific conditions. Default is -1.

• transforms: A mutable list of transformation identifiers. null by default.

• isMinimapVisible: Indicates whether the entity is visible on the minimap. Default is true.

• combatLevel: Combat level of the entity. Default is -1.

• widthScale, heightScale: Scaling factors for the entity's width and height. Defaults are 128.

• hasRenderPriority: Indicates whether the entity should be rendered with priority over others. Default is false.

• ambient: Ambient light setting affecting the entity's appearance. Default is 0.

• contrast: Contrast setting for the entity's appearance. Default is 0.

• headIconArchiveIds: A mutable list of archive identifiers for head icons. null by default.

• headIconSpriteIndex: A mutable list of sprite indices for head icons. null by default.

• rotation: Default rotation setting for the entity when initialized. Default is 32.

• isInteractable: Indicates whether the entity can interact with players or other entities. Default is true.

• isClickable: Indicates whether the entity can be clicked on by the user. Default is true.

• lowPriorityFollowerOps: Indicates whether follower operations for the entity are of low priority. Default is false.

• isFollower: Indicates whether the entity acts as a follower. Default is false.

• runSequence, runBackSequence, runRightSequence, runLeftSequence: Animation sequences for running in various directions. All default to -1.

• crawlSequence, crawlBackSequence, crawlRightSequence, crawlLeftSequence: Animation sequences for crawling in various directions. All default to -1.

• params: A map of integer keys to any type of values for additional parameters. null by default.

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

Example

id= 3434
inherit= 1
name = "Man"
ioption2 = "Smack"