Global Functions

From King Arthur's Gold Wiki
Revision as of 19:23, 13 August 2012 by Shadlington (Talk | contribs)

Jump to: navigation, search

Something here about the general concept of global functions.


Then a big ol' list of the functions, linking to their own articles.

Function Description
Blobs
CreateBlob

Creates a CBlob with the given factory and the given path to a config file defining the CBlob.

Returns a reference to the created CBlob.

getBlob

Returns a reference to the CBlob with the given index in the list of blobs that currently exist.

getBlobByNetworkId

Returns a reference to the CBlob with the given Network ID.

getBlobByName

Returns a reference to the first CBlob with the given name. Probably not very useful.

getPlayingBlobsSize

Returns the number of CBlobs that are currently active and in play - i.e. not settled map blocks or in inventories.

getBlobSize

Returns the number of CBlobs that currently exist.

Inventory
AddRequirement

Pushes the given requirements to a CBitStream, to be read by other requirement methods.

ReadRequirement

Reads requirements from the given CBitStream into variables you provide.

hasRequirements

Checks 1 or 2 inventories to see if they have the given requirements, and writes any missing requirements into a given CBitStream.

Returns true if the requirements are met, otherwise false.

TakeRequirementsCombined

Removes the requirements in the given CBitStream from one of the CInventorys passed to it.

Irrlicht
LoadSkin

Loads a skin config file. See GUI/guiSkin.cfg for example file.

DrawPane

Draws a pane with a shape specified by the given rect.

DrawSunkenPane

Draws a sunken pane with a shape specified by the given rect.

DrawWindow

Draws a window with a shape specified by the given rect.

DrawFramedPane

Draws a framed pane with a shape specified by the given rect.

DrawButton

Draws a button with a shape specified by the given rect.

DrawButtonPressed

Draws a pressed button with a shape specified by the given rect.

DrawButtonHover

Draws a hover-highlighted button with a shape specified by the given rect.

DrawRectangle

Draws a rectangle with a shape specified by the given rect.

DrawProgressBar

Draws a progress bar with a shape specified by the given rect and a given % fill.

DrawIconByName

Draws an icon added by AddIconToken using its token name.

DrawIcon

Draws an icon from the given file.

DrawText

Draws some text.

Misc
AddIconMarker

This defines a token (e.g. $EmptyShop$) for icon replacement in menus and suchlike.

AddColorMarker

This defines a token (e.g. $RED$) for colouring text in menus and suchlike.

CreateGridMenu

Creates a CGridMenu with the given position on-screen, a reference to the owner blob, the grid dimensions and a caption.

Returns a reference to the created CGridMenu.