Global

Members

Type: ConfigType

# constant ConfigType

Properties:

Name	Type	Description
`UNDERLAY`	`ConfigType`	Underlay
`UNKNOWN2`	`ConfigType`
`IDENTKIT`	`ConfigType`	Kit
`OVERLAY`	`ConfigType`	Overlay
`INV`	`ConfigType`	Inventory
`OBJECT`	`ConfigType`	Objects
`UNKNOWN7`	`ConfigType`
`ENUM`	`ConfigType`	Enum
`NPC`	`ConfigType`	NPC
`ITEM`	`ConfigType`	Items
`PARAMS`	`ConfigType`	Params
`SEQUENCE`	`ConfigType`	Sequence
`SPOTANIM`	`ConfigType`	Spot anim
`VARBIT`	`ConfigType`	Varbit
`VARCLIENTSTRING`	`ConfigType`
`VARPLAYER`	`ConfigType`	Varp
`UNKNOWN18`	`ConfigType`
`VARCLIENT`	`ConfigType`	Varc
`UNKNOWN20`	`ConfigType`
`UNKNOWN22`	`ConfigType`
`UNKNOWN24`	`ConfigType`
`UNKNOWN25`	`ConfigType`
`UNKNOWN26`	`ConfigType`
`UNKNOWN27`	`ConfigType`
`UNKNOWN28`	`ConfigType`
`UNKNOWN29`	`ConfigType`
`UNKNOWN30`	`ConfigType`
`UNKNOWN31`	`ConfigType`
`HITSPLAT`	`ConfigType`	Hitsplats
`HEALTHBAR`	`ConfigType`	Healthbars
`STRUCT`	`ConfigType`	Struct
`AREA`	`ConfigType`	Area
`UNKNOWN47`	`ConfigType`	Possible scripts?
`UNKNOWN54`	`ConfigType`	Possible scripts?
`UNKNOWN70`	`ConfigType`

View Source cacheTypes/ConfigType.js, line 14

Type: IndexType

# constant IndexType

Properties:

Name	Type	Description
`FRAMES`	`IndexType`	Animations
`FRAMEMAPS`	`IndexType`	Skeletons
`CONFIGS`	`IndexType`	Configs
`INTERFACES`	`IndexType`	Interfaces
`SOUNDEFFECTS`	`IndexType`	Sound FX
`MAPS`	`IndexType`	Maps
`TRACK1`	`IndexType`	Music Tracks
`MODELS`	`IndexType`	Models
`SPRITES`	`IndexType`	Sprites
`TEXTURES`	`IndexType`	Textures
`BINARY`	`IndexType`	Title screen & Huffman?
`TRACK2`	`IndexType`	Music Jingles
`CLIENTSCRIPT`	`IndexType`	Interface Scripts
`FONTS`	`IndexType`	Interface Fonts
`VORBIS`	`IndexType`	Music Samples
`INSTRUMENTS`	`IndexType`	Music Patches
`WORLDMAP`	`IndexType`	World Locations
`UKNOWN1`	`IndexType`	Sprite IDs?
`UKNOWN2`	`IndexType`	World Map Geography?
`UKNOWN3`	`IndexType`	World Map?
`UKNOWN4`	`IndexType`	World Map Ground?

View Source cacheTypes/IndexType.js, line 12

Type Definitions

# AnimationData

Properties:

Name	Type	Description
`vertexData`	`Array.<Vector3>`	Vector3 is an array with 3 numbers
`lengths`	`Array.<number>`	Animation frame length

View Source loaders/ModelLoader.js, line 5

# Location

Properties:

Name	Type	Description
`id`	`number`	ObjectDefinition ID
`type`	`number`
`orientation`	`number`	Rotation
`position`	`Object`

View Source loaders/MapLoader.js, line 12

# Tile

Properties:

Name	Type	Description
`height`	`number`	Used to construct a heightmap
`attrOpcode`	`number`
`overlayId`	`number`	Overlay Definition ID
`overlayPath`	`number`
`overlayRotation`	`number`
`settings`	`number`
`underlayId`	`number`	Underlay Definition ID

View Source loaders/MapLoader.js, line 1

# options

Properties:

Name	Type	Description
`threaded`	`boolean`	Use a Web Worker to read from the cache. Slower than non-threaded since threading overhead is big. Useful for web apps to have a responsive UI
`isAnimaya`	`boolean`	Used while loading animations. Uses a different loading method for Animaya animations. OSRSCacheReader sets this internally on it's own if using ModelDefinition's loadAnimation method
`earlyStop`	`boolean`	Used while loading Animaya animations. Stops the reader early to just get the skeleton info
`loadSprites`	`boolean`	Used while loading Texture defs. Automatically grabs the corresponding sprite file
`cacheResults`	`boolean`	Save def on archive file after decompressing contents. Useful for quicker loading if loading the same thing multiple times but also can increase memory usage

View Source RSCache.js, line 12