UI - Meteor 2 Scripting Functions

vector2 getScreenSize()

Get the screen size in pixels

// Example 1:
print("Screen size is " + getScreenSize().x + " by " + getScreenSize().y);

// Example 2 (see comments):
print("Screen size is " + SCREEN_W + " by " + SCREEN_H);

Two static float variables SCREEN_W and SCREEN_H are also available.

void screenToWorld(vector2 screenPos)

Convert screen pixel coordinates to a world position.

// print world position at middle of screen
print(screenToWorld(vector2(SCREEN_W * 0.5, SCREEN_H * 0.5)));

Result may be outside of world/map bounds.

worldToScreen getScreenSize getWorldRenderScale

void worldToScreen(vector2 screenPos)

Convert a world position to screen pixel coordinates.

// print screen position of player
print(worldToScreen(getPos(getPlayer())));

Result may be outside of screen bounds.

screenToWorld getScreenSize getWorldRenderScale

float getWorldRenderScale()

Get the current world render scale (zoom level).

// print screen position of player
print(getWorldRenderScale());

screenToWorld getScreenSize

string colToHTML(unsigned char r, unsigned char g, unsigned char b, unsigned char a)

Convert a unsigned byte colour in the format RGBA to HTML style string.

// #ffffffff (white)
print(colToHTML(255,255,255,255));

// #ffffffc0 (transparent white)
print(colToHTML(255,255,255,128));

// #ff0000ff (red)
print(colToHTML(255,0,0,255));

// #00ff00ff (green)
print(colToHTML(0,255,0,128));

// #0000ffff (blue)
print(colToHTML(0,0,255,255));

void gameMessage(string text)

Display a game message (local only).

gameMessage("This is a game message");

none

introMessage messageBox print logPrint

void introMessage(string text)

Display an intro message (local only).

introMessage("This is a intro message");

Intro messages are displayed near the bottom of the screen and fade out after around 8 seconds.

gameMessage messageBox print logPrint

void messageBox(string text)

Display a message box (local only).

messageBox("This is a message box");

none

gameMessage confirmBox

bool confirmBox(string text)

Display a confirmation box with message (local only).

if(confirmBox("Are you sure?"))
{
print("You are sure");
}

none

messageBox stringInputBox

bool stringInputBox(string str, int maxLen, string message)

Display a string input box with message (local only).

string name = "";
if(stringInputBox(name, 32, "Enter your name"))
{
print("Your name is " + name);
}

none

messageBox stringInputBox

bool createToolbar(int toolbarNumber, string title, vector2 screenPos, bool docked)

Create a toolbar ( (local only).

createToolbar(0, "Test Toolbar", vector2(10, 10), false);

toolbarNumber should simply be unique number that refers to this toolbar.
docked toolbars cannot be moved.
See base\maps\examples\Text_Toolbar.as for a working example.

deleteToolbar addToolbarButton

void deleteToolbar(int toolbarNumber, bool localOnly)

Delete a toolbar and all associated buttons (local only).

deleteToolbar(0);

createToolbar addToolbarButton

void addToolbarButton(int toolbarNumber, string caption, string imageFilename, string triggerText)

Add a button to an existing toolbar (local only).

addToolbarButton(0, "Sheep", "objects\\sheep01_01.png", "print(\"You pressed the sheep button\");");

toolbarNumber is the unique toolbar number to add the button to.
imageFilename must be image filename from within an INI file from the images folder.

addToolbarSeparator createToolbar

void addToolbarSeparator(int toolbarNumber)

Add a separator to an existing toolbar (local only).

addToolbarSeparator(0);

addToolbarButton createToolbar

void openInteractionMenu(int menuIndex)

Open specified interaction menu.

// open root interaction menu
openInteractionMenu(0);