newspeoplefor developersdocumentationdownloads

nGuiServer Script Interface

nguiserver:

Super Class:

C++ Class:

Info

Handle user interfaces.

Commands:


setrootpath

Command Input:
s(RootPath)
Command Output:
v
Command Description:
Set the root path in Nebula's object hierarchy. Default is "/res/gui". This is where all the windows live.

getrootpath

Command Input:
v
Command Output:
s(RootPath)
Command Description:
Get the root path.

setrootwindow

Command Input:
s(RootWindow)
Command Output:
v
Command Description:
Set a new root window. An empty window identifier implies the null window.

getrootwindow

Command Input:
v
Command Output:
s(RootWindow)
Command Description:
Get current root window.

addsystemfont

Command Input:
s(FontName), s(TypeFace), i(Height), b(Bold), b(Italic), b(Underline)
Command Output:
v
Command Description:
Add a font definition using a standard system font.

addcustomfont

Command Input:
s(FontName), s(FontFile), s(TypeFace), i(Height), b(Bold), b(Italic), b(Underline)
Command Output:
v
Command Description:
Add a font definition using a custom font.

ismouseovergui

Command Input:
v
Command Output:
b(MouseOverGui)
Command Description:
Returns true if mouse is currently over a GUI element.

newwindow

Command Input:
s(ClassName), b(Visible)
Command Output:
o(Window)
Command Description:
Create a new window of the given class.

newskin

Command Input:
s(SkinName)
Command Output:
o(SkinObject)
Command Description:
Create a new skin of the given name.

setskin

Command Input:
o(SkinObject)
Command Output:
v
Command Description:
Set the current skin by object (as returned by newskin).

getskin

Command Input:
v
Command Output:
o(SkinObject)
Command Description:
Return the current skin object.

setsystemskin

Command Input:
o(SkinObject)
Command Output:
v
Command Description:
Set the system skin to use for the Nebula system GUI. This will be activated when ToggleSystemGui() is called.

getsystemskin

Command Input:
v
Command Output:
o(SkinObject)
Command Description:
Return the system skin object.

togglesystemgui

Command Input:
v
Command Output:
v
Command Description:
Toggle Nebula's system GUI.

computescreenspacebrushsize

Command Input:
s (brush name)
Command Output:
ff (x,y size)
Command Description:
Computes the screen space size of a brush if a 1:1 mapping is assumed between brush texels and screen pixels.

runcommand

Command Input:
os (widget object, command string)
Command Output:
b
Command Description:
Run given script to nGuiWidget.
27-Aug-04 kims created.


putevent

Command Input:
os (widget object, event type)
Command Output:
v
Command Description:
put an event to given widget object.
27-Aug-04 kims created.


setdragbox

Command Input:
o(DragBoxObject)
Command Output:
v
Command Description:
Set pointer to optional global nGuiDragBox object.

getdragbox

Command Input:
v
Command Output:
o(DragBoxObject)
Command Description:
Get pointer to optional global nGuiDragBox object.

setdisplaysize

Command Input:
i (x size), i (y size)
Command Output:
v
Command Description:
Set the gui server's display size to the given dimensions.
29-Sep-04 Rafael created.


Copyright © 1999-2005 by the contributing authors. Ideas, requests, problems: Send feedback.