Class IfType

Represents a single component in an IfGroup. IfTypes can be "static" meaning they are created at design time and deserialized from dat files, or "dynamic" meaning they are created at runtime by script. The IfType class is monolithic, and contains the entire set of data fields used by all IfType.IfTypes, although fields will be ignored if they are not relevant for a given type.

Constructors

constructor

new IfType(): osrs.IfType
Returns osrs.IfType

Properties

aspectRatio

aspectRatio: Vector2

TBD docs.

baseOpName

baseOpName: string

The name of the subject that the ops belonging to this IfType act on.

Example

-- Prints out sidebar nouns (XP Tracker, Loot Tools, Hiscores)
local ifType = osrs.IfType.retrieveIfType(728, 6)
local table = ifType:getChildren()
 for index, value in ipairs(table) do
     osrs.print(value.baseOpName)
end

blendMode

blendMode: BlendMode

TBD docs/examples.

children

children: ROArrayType<osrs.IfType>

All the direct children of this IfType. Note that only LAYER-type IfTypes have children. EXPENSIVE. Please cache the return value before iterating. TBD example.

colour

colour: osrs.Colour

TBD docs/examples.

colour2

colour2: osrs.Colour

TBD docs/examples.

colourOver

colourOver: osrs.Colour

TBD docs/examples.

componentIndex

componentIndex: number

The index of the ultimate static parent component of this IFType in its interface group. TBD example: RetrieveIfType.

dataHeight

dataHeight: number

TBD docs

dataWidth

dataWidth: number

TBD docs

dataX

dataX: number

TBD docs

dataY

dataY: number

TBD docs

diagonalStartAtBottom

diagonalStartAtBottom: boolean

TBD docs/examples.

event

event: number

TBD docs.

eventCode

eventCode: number

TBD docs.

fill

fill: boolean

TBD docs/examples.

graphic

graphic: number

The id number of the sprite displayed by a GRAPHIC type IfType.

Example

for indexCount= 0,20 do
     local ifType = osrs.IfType.retrieveIfType(162, indexCount)
     if(ifType.type == osrs.IfType.IfTypes.GRAPHIC) then
         osrs.print("IF TYPE GRAPHIC: " .. ifType.graphic)
     end
end

graphic2

graphic2: number

id number of additional graphic sprite. TBD more details and examples.

graphicURL

graphicURL: string

TBD docs/examples (read-only).

height

height: number

The height of the IfType.

Example

local ifType = osrs.IfType.retrieveIfType(728, 6)
if(ifType.type == osrs.IfType.IfTypes.LAYER) then
     local table = ifType:getChildren()
     for index, ifTypeChild in ipairs(table) do
         osrs.print(ifTypeChild.graphic)
         osrs.print("WIDTH: " .. ifTypeChild.width .. ", Height: " .. ifTypeChild.height)
     end
end

hFlip

hFlip: boolean

TBD docs/examples

hidden

hidden: boolean

Boolean indicating whether to display the IfType and its children.

Example

local ifType = osrs.IfType.retrieveIfType(728, 6)
local popoutBarIcons = ifType:getChildren()
-- Hides Loot Tools Icon
popoutBarIcons[2].hidden  = true;

id

id: number

the id of the interface group this IFType belongs to. TBD example.

isEntityOverlay

isEntityOverlay: number

Is this IfType part of the Entity Overlay system? TBD: add details once Entity Overlay system is exposed.

isIf3

isIf3: boolean

TBD docs. Not expected to be of much use for plugin API.

isRendering

isRendering: boolean

Returns true if the IfType is currently rendering to the screen. There is no event to monitor this, so you will have to poll it to detect changes. TBD example.

isStatic

isStatic: boolean

Returns true if the IfType is a static component (equivalent to subId==-1). TBD: example.

lastProcess

lastProcess: number

TBD docs.

layerId

layerId: number

This is an opaque identifier for this IfType's direct parent, or -1 if it is a top-level static layer. Read-only.

layerIdXMax

layerIdXMax: number

See layerIdXMin.

layerIdXMin

layerIdXMin: number

Dynamic layers will have this filled out. It denotes the range of subids in the ultimate static parent that might belong to us. Likely low relevance to PluginAPI.

linkObjNumber

linkObjNumber: number

TBD docs/examples.

linkObjType

linkObjType: number

TBD docs/examples. (Will be one of osrs.gamevals.objtypes). This will tell you what's in each inventory cell.

modeHeight

modeHeight: SizeMode

model1Id

model1Id: number

TBD docs/examples.

model1Type

model1Type: ModelTypes

TBD docs/examples.

model2Id

model2Id: number

TBD docs/examples.

model2Type

model2Type: ModelTypes

TBD docs/examples.

modelAnim

modelAnim: number

TBD docs/examples.

modelAnim2

modelAnim2: number

TBD docs/examples.

modelHei

modelHei: number

TBD docs/examples.

modelSpin

modelSpin: number

TBD docs/examples.

modelWid

modelWid: number

TBD docs/examples.

modelXAn

modelXAn: number

TBD docs/examples.

modelXOf

modelXOf: number

TBD docs/examples.

modelYAn

modelYAn: number

TBD docs/examples.

modelYOf

modelYOf: number

TBD docs/examples.

modelZAn

modelZAn: number

TBD docs/examples.

modelZoom

modelZoom: number

TBD docs/examples.

modeWidth

modeWidth: SizeMode

modeX

modeX: AlignMode

Represents the alignment of the X-Coordinate of the IfType.

modeY

modeY: AlignMode

Represents the alignment of the Y-Coordinate of the IfType.

opNames

opNames: string[]

The list of ops belonging to this IfType.

Example

local ifType = osrs.IfType.retrieveIfType(728, 6)
local table = ifType:getChildren()
for index, ifTypeChild in ipairs(table) do
     local opNameList = ifTypeChild.opNames
     for index, opName in ipairs(opNameList) do
         osrs.print(opName .. " " .. ifTypeChild.baseOpName )
     end
end

orthog

orthog: boolean

TBD docs/examples (this may refer to orthographic rendering of the model).

outline

outline: number

TBD docs/examples.

overlayId

overlayId: number

TBD docs. Read-only.

overlayType

overlayType: OverlayTypes

TBD docs. Read-only.

parent

parent: osrs.IfType

Gets this IfType's direct parent. If this IfType is a static component, returns nil.

rotate

rotate: number

TBD docs/examples.

screenCoords

screenCoords: Vector2

Returns the screen coordinates of the upper left corner of this IfType. This value is computed every time it is accessed (by summing the offsets of all parents).

scrollPos

scrollPos: Vector2

TBD docs. Read-only.

scrollSize

scrollSize: Vector2

TBD docs. Read-only.

shadowColour

shadowColour: osrs.Colour

TBD docs/examples

sourceName

sourceName: string

The label of the IfType descriptor, if top-level IfType. Otherwise, is empty. TBD: Confirm that this is available in retail builds.

Example

-- Retrieves the popout bar
local ifType = osrs.IfType.retrieveIfType(728, 6)
-- Prints "popout"
osrs.print(ifType.sourceName)

startAngle

startAngle: number

TBD docs/examples (0-65535 range)

staticParent

staticParent: osrs.IfType

Gets this IfType's ultimate static parent, or itself if it is static.

stopAngle

stopAngle: number

TBD docs/examples (0-65535 range)

strokeWidth

strokeWidth: number

TBD docs/examples

subId

subId: number

-1 for static components. For dynamic components, this is the array index into the ultimate static parent component's children array.

text

text: string

The string to display by a TEXT type IfType.

Example

for indexCount= 0,20 do
     local ifType = osrs.IfType.retrieveIfType(162, indexCount)
     if(ifType.type == osrs.IfType.IfTypes.TEXT) then
         osrs.print("IF TYPE TEXT: " .. ifType.text)
     end
end

text2

text2: string

Secondary text string. TBD: example.

tiling

tiling: boolean

TBD docs/examples.

transparency

transparency: number

How transparent the IfType should be. 0 - Fully Opaque, 255 - Transparent

Example

local changePerSecond = 4
local ifType = osrs.IfType.retrieveIfType(728, 6)
local table = ifType:getChildren()
local lastChange = 0
local transparencyValue = 0

-- Gradually makes the sidebar icons transparent 
local loopTransparent = function()
     local currentTime = osrs.getTime()
     if (currentTime - lastChange >= (1/changePerSecond)) then
         for index, value in ipairs(table) do
             value.transparency = transparencyValue
         end
         transparencyValue = transparencyValue + 5
         osrs.print("Transparency Value: " .. transparencyValue)
         lastChange = currentTime
         if(transparencyValue > 255) then
             return false
         end
     end
     return true
end

drawToken = osrs.setInterval(loopTransparent, 0, drawToken)

type

type: IfTypes

The category of IfType this object belongs to.

Example

local ifTypeLayer = osrs.IfType.retrieveIfType(728, 6)
local ifTypeGraphic = osrs.IfType.retrieveIfType(728, 17)
osrs.print(ifTypeLayer.type)
osrs.print(ifTypeGraphic.type)
if(ifTypeLayer.type == osrs.IfType.IfTypes.LAYER) then
     osrs.print("This IfType is a Layer.")
end

vFlip

vFlip: boolean

TBD docs/examples

width

width: number

The width of the IfType.

Example

local ifType = osrs.IfType.retrieveIfType(728, 6)
if(ifType.type == osrs.IfType.IfTypes.LAYER) then
     local table = ifType:getChildren()
     for index, ifTypeChild in ipairs(table) do
         osrs.print(ifTypeChild.graphic)
         osrs.print("WIDTH: " .. ifTypeChild.width .. ", Height: " .. ifTypeChild.height)
     end
end

x

x: number

The x-coordinate of the IfType, relative to its parent.

Example

local ifType = osrs.IfType.retrieveIfType(728, 6)
if(ifType.type == osrs.IfType.IfTypes.LAYER) then
     local table = ifType:getChildren()
     for index, ifTypeChild in ipairs(table) do
         osrs.print(ifTypeChild.graphic)
         osrs.print("X: " .. ifTypeChild.x .. ", Y: " .. ifTypeChild.y)
     end
end

y

y: number

The y-coordinate of the IfType, relative to its parent.

Example

local ifType = osrs.IfType.retrieveIfType(728, 6)
if(ifType.type == osrs.IfType.IfTypes.LAYER) then
     local table = ifType:getChildren()
     for index, ifTypeChild in ipairs(table) do
         osrs.print(ifTypeChild.graphic)
         osrs.print("X: " .. ifTypeChild.x .. ", Y: " .. ifTypeChild.y)
     end
end

Methods

subscribe(callback: EventCallbackPolytype, event: number): boolean
Subscribe to a UI event. It is legal for the same function to be subscribed to DIFFERENT events, but double-subscribing to the same even will fail, and return false.
Parameters
- callback: EventCallbackPolytype
  the callback that will be invoked. The exact callback type is dependent on the event.
- event: number
  The Id of the event to subscribe to.
Returns boolean
true if the subscription succeeded (can fail because of double-registration, or because event doesn't exist--check debug console).
- Defined in iftype.d.ts:423

unsubscribe

unsubscribe(callback: EventCallbackPolytype, event: number): boolean
Unsubscribe from a UI Event.
Parameters
- callback: EventCallbackPolytype
  The same callback you used to register for the event.
- event: number
  The event the callback was registered for.
Returns boolean
true if the subscription was successfully found and removed.
- Defined in iftype.d.ts:430

Class IfType

Index

Documents

Constructors

Properties

Methods

Constructors

constructor

Returns osrs.IfType

Properties

aspectRatio

baseOpName

Example

blendMode

children

colour

colour2

colourOver

componentIndex

dataHeight

dataWidth

dataX

dataY

diagonalStartAtBottom

event

eventCode

fill

graphic

Example

graphic2

graphicURL

height

Example

hFlip

hidden

Example

id

isEntityOverlay

isIf3

isRendering

isStatic

lastProcess

layerId

layerIdXMax

layerIdXMin

linkObjNumber

linkObjType

modeHeight

model1Id

model1Type

model2Id

model2Type

modelAnim

modelAnim2

modelHei

modelSpin

modelWid

modelXAn

modelXOf

modelYAn

modelYOf

modelZAn

modelZoom

modeWidth

modeX

modeY

opNames

Example

orthog

outline

overlayId

overlayType

parent

rotate

screenCoords

scrollPos

scrollSize

shadowColour

sourceName

Example