Available Packages:

Back to index

Framehandle

Source

Forces the mouse cursor to stay (caged) inside of the frame

function static framehandle.clearAllPoints()

Source

Frees the frame from any relative or absolute anchor points

function static framehandle.click()

Source

Fires a click a event on the frame

function createFrame(string name) returns framehandle

Source

Creates a non simple frame of the given name (the name of the frame which must be defined in the imported fdf files)

function createFrame(string name, framehandle owner, int priority, int createContext) returns framehandle

Source

Creates a non simple frame: name: the name of the frame which must be defined in the imported fdf files. owner: the parent of the frame priority: unknown createContext: the unique id assigned to the frame and its children (useful for creating multiple frames of the same name)

function createFrame(string typeName, string name, framehandle owner, string inherits, int createContext) returns framehandle

Source

Creates a frame by type: typeName: the name of the type (e.g. "SIMPLEFRAME", "MENU", "BUTTON") name: the name of the created frame owner: the parent of the frame inherits: the name of the frame frome which the created frame will be inhereting (which must be defined in the imported .fdf files) createContext: the unique id assigned to the frame and its children (useful for creating multiple frames of the same name)

function createSimpleFrame(string name) returns framehandle

Source

Creates a simple frame of the given name (the name of the frame which must be defined in the imported fdf files.)

function createSimpleFrame(string name, framehandle owner, int createContext) returns framehandle

Source

Creates a simple frame: name: the name of the frame which must be defined in the imported fdf files. owner: the parent of the frame createContext: the unique id assigned to the frame and its children (useful for creating multiple frames of the same name)

function static framehandle.disable()

Source

Disables the frame

function static framehandle.disable(player p)

Source

Disables the frame for the player p

function disableCursor()

Source

function static framehandle.enable()

Source

Enables the frame

function static framehandle.enable(player p)

Source

Enables the frame for the player p

function enableCursor()

Source

function enableUIAutoPosition(boolean flag)

Source

Enables or disables auto positioning of ui elements

function static framehandle.getAlpha() returns int

Source

Returns the decimal alpha value of the frame (only for specific frames)

function static framehandle.getChild(int index) returns framehandle

Source

Get child frame handle from given index

function static framehandle.getChildrenCount() returns int

Source

Get number of children frames of given frame. Only direct child frames are counted

function getFrame(string name, int createContext) returns framehandle

Source

Returns the framehandle of the given name and createContext index (children inherit the createContext value of their parent)

function getFrame(string name) returns framehandle

Source

Returns the framehandle of the given name

function static framehandle.getHeight() returns real

Source

Returns the frame's height

function static framehandle.getName() returns string

Source

Returns the frame's name

function getOriginFrame(originframetype frameType) returns framehandle

Source

Returns the orgin frame of the given type

function getOriginFrame(originframetype frameType, int index) returns framehandle

Source

Returns the orgin frame of the given type and index

function static framehandle.getParent() returns framehandle

Source

Searches for the frames parent frame. Should be used with caution as getting the parent of any top most frame will lead into a void crash

function static framehandle.getText() returns string

Source

Returns the text value of the text frame

function static framehandle.getTextSizeLimit() returns int

Source

Returns the maximum allowed text size of the text frame

function static framehandle.getValue() returns real

Source

Returns the specific value of the frame (e.g. for sliders)

function static framehandle.getWidth() returns real

Source

Returns the frame's width

function static framehandle.hide()

Source

Hides the frame

function static framehandle.hide(player p)

Source

Hides the frame to the specific player

function hideOriginFrames()

Source

Hides all origin frames except ORIGIN_FRAME_WORLD_FRAME

function static framehandle.isEnabled() returns boolean

Source

Returns the state of the frame

function static framehandle.isEnabled(player p) returns boolean

Source

Returns the state of the frame for given player

function static framehandle.isVisible() returns boolean

Source

Returns whether the frame is visible or not

function static framehandle.isVisible(player p) returns boolean

Source

Returns whether the frame is visible or not for given player

function loadTOCFile(string tocFile) returns boolean

Source

Loads a toc file from the given path, to include custom fdf files from, returns true on success

function static framehandle.remove()

Source

Removes a frame

function static framehandle.setAbsPoint(framepointtype point, real x, real y)

Source

Sets the frame position to an absolute x, y point on the screen. For the the x-axis, the value is between 0 and 0.8 For the the y-axis, the value is between 0 and 0.6

function static framehandle.setAbsPoint(framepointtype point, vec2 pos)

Source

Sets the frame position to an absolute x, y point on the screen. For the the x-axis, the value is between 0 and 0.8 For the the y-axis, the value is between 0 and 0.6

function static framehandle.setAllPoints(framehandle relative)

Source

Copy all the anchor points of the given frame

function static framehandle.setAlpha(int alpha)

Source

Sets the decimal alpha value of the frame (only for specific frames)

function static framehandle.setAlpha(player p, int alpha)

Source

Sets the decimal alpha value of the frame (only for specific frames) to the given player

function static framehandle.setCenter()

Source

Places the frame at the center of the screen

function setCursorEnabled(boolean flag)

Source

function static framehandle.setEnabled(boolean enabled)

Source

Enables or disables the frame

function static framehandle.setFocus(boolean flag)

Source

Enables or disables the user interaction for the frame

function static framehandle.setFocus(player p, boolean flag)

Source

Enables or disables the user interaction for the frame for given player

function static framehandle.setFont(string fileName, real height, int flags)

Source

Sets the text font of the text frame

function static framehandle.setHeight(real height)

Source

Sets the height of the frame (sets the width to its current width)

function static framehandle.setLevel(int level)

Source

If multiple frames cover each other, the one with the highest level will receive mouse events and will be drawn above the others. If several frames have the same level, the last created one is prioritized

function static framehandle.setMinMax(real minValue, real maxValue)

Source

Sets the specific minimum and maximum value of the frame (e.g. for sliders)

function static framehandle.setModel(string modelFile, int cameraIndex)

Source

Sets the model of the model frame

function setMousePos(vec2 pos)

Source

Places the mouse cursor at the given point of the screen. Uses the same coodinate system as framehandles

function static framehandle.setMousePos()

Source

Places the mouse cursor in the center of the frame

function setMousePos(int x, int y)

Source

Places the mouse cursor at the given point of the screen. Uses the window's coordinate system (in pixels) where (0, 0) is top-left corner of the window and positive direction of Y axis is "down"