OSRS Plugin API
    Preparing search index...

    Namespace Engine

    This section is for the information handled by the games engine, or information that is pre-set (non-changing, such as an NPC’s starting stat) in the Old School Runescape game. Have you ever wondered what the base stats for a specific NPC are or what all the options you can take when clicking on an item are? By using the functions found under this section you can get all of that information plus more.

    Lets say you wanted to get the pre-set information on a NPC currently in the game. All you would need to do is get the id and type of that npc. Under the ClientOp section, there is a function that lets you get an NPC ID (ClientOp.npcUid). You can use that id in another function that can determine the NPC’s type (decodeNpcType). This function will return that NPC type. A type is what holds all the information about that specific NPC, such as its category, name, ID, stats (NPCStats), available in-game options (OpTable), and much more.

    Now lets say you want to get all of the available options a player can choose to do on an in-game object. In the ClientOp namespace section, you can find the function to get an object’s type (ClientOp.objTypeId). You can use that number to determine the Object’s ID with the (decodeObjType) function. This function will return an ObjType object, which holds all of the information pre-set into that specific type of object. Inside each object type (osrs.ObjType) there will be a table of choices called an OpTable (OpTable), which contains all of the in-game options a player can choose to do with that object.

    Using these tools, you will be able to get important pre-set information on all objects, NPCs, and locations.

    Interfaces

    Camera
    ConfigDecoders
    MousePickingHelper

    Type Aliases

    DBRowType
    LocParamTable
    NpcParamTable
    NPCStats
    ObjParamTable
    OpTable

    References

    Decoders → ConfigDecoders