Module rs3cache::ffi::python

Available on (crate features rs3 or osrs or legacy) and crate feature pyo3 only.

Python bindings for rs3cache.

See the README for help with installing this.

Usage

Usage examples are available in the /rs3cache folder.

All the following can be imported as:

from rs3cache import *

Functions

The following functions are available:

get_location_configs()
get_npc_configs()
get_item_configs()
get_varbit_configs()
get_struct_configs()
get_enum_configs()

Classes

The following classes are available:

MapSquares
CacheIndex

Structs

• PyCacheIndex
  Wrapper over [CacheIndex]. The Python alias for this is Index
• PyCacheIndexIter
  Iterator over all archives in an Index.
• PyFrame
• PyIndexMetadata
• PyIndexMetadataIter
  Iterator over all archives in an Index.
• PyMapSquare
  Obtained from PyMapSquares’s get method.
• PyMapSquares
  Container of PyMapSquares. Accessible with from rs3cache import MapSquares.
• PyMapSquaresIter
  Iterator over all archives in an Index.
• PySprite
  Obtained from PySprites’s get method.
• PySprites
• PySpritesIter
  Iterator over all archives in an Index.

Functions

• get_achievement_configsrs3
  Wrapper for Achievement::dump_all
• get_enum_configs
  Wrapper for Struct::dump_all
• get_item_configs
  Wrapper for NpcConfig::dump_all
• get_location_configs
  Wrapper for LocationConfig::dump_all
• get_npc_configs
  Wrapper for NpcConfig::dump_all
• get_struct_configs
  Wrapper for Struct::dump_all
• get_varbit_configs
  Wrapper for VarbitConfig::dump_all
• hash_djb2
• initializer