Acumen
8dd3a61a3a
* Added a simple "Game is Paused" text message to the Pause hotkey. This was SVN commit r3672.
134 lines
4.4 KiB
JavaScript
Executable File
134 lines
4.4 KiB
JavaScript
Executable File
/*
|
|
DESCRIPTION : Utility functions that manipulate GUI objects.
|
|
NOTES :
|
|
*/
|
|
|
|
// ====================================================================
|
|
|
|
// Hide GUI object.
|
|
function guiHide (objectName)
|
|
{
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
if( guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined" )
|
|
console.write ("guiHide(): GUI Object not found: " + objectName);
|
|
if( !guiObject.hidden )
|
|
guiObject.hidden = true;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Reveal GUI object.
|
|
function guiUnHide (objectName)
|
|
{
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
if (guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined")
|
|
console.write ("guiUnHide(): GUI Object not found: " + objectName);
|
|
if( guiObject.hidden )
|
|
guiObject.hidden = false;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Toggle visibility of GUI object.
|
|
function guiToggle (objectName)
|
|
{
|
|
// Get our GUI object
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
|
|
if (guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined")
|
|
console.write ("guiToggle(): GUI Object not found: " + objectName);
|
|
|
|
// Toggle it
|
|
guiObject.hidden = !guiObject.hidden;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Enable GUI object.
|
|
function guiEnable (objectName)
|
|
{
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
if (guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined")
|
|
console.write ("guiEnable(): GUI Object not found: " + objectName);
|
|
guiObject.enabled = true;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Disable GUI object.
|
|
function guiDisable (objectName)
|
|
{
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
if (guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined")
|
|
console.write ("guiDisable(): GUI Object not found: " + objectName);
|
|
guiObject.enabled = false;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Change caption of GUI object and then make it visible.
|
|
function guiRenameAndReveal (objectName, objectCaption)
|
|
{
|
|
// Get our GUI object
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
|
|
if (guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined")
|
|
console.write ("guiRenameAndReveal(): GUI Object not found: " + objectName);
|
|
|
|
// Rename it
|
|
guiObject.caption = objectCaption;
|
|
|
|
// Toggle it
|
|
guiObject.hidden = false;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Increment/decrement the numeric caption of a GUI object.
|
|
function guiModifyCaption (objectName, objectModifier, objectPlaces)
|
|
{
|
|
// Adds a modifier to a GUI object's caption (eg increase a number by 1).
|
|
// Obviously don't use this unless you're sure the caption contains a number.
|
|
// objectPlaces specifies the number of decimal places to use for a floating point number.
|
|
// If not specified, it defaults to zero (whole number).
|
|
|
|
// Get our GUI object
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
|
|
if (guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined")
|
|
console.write ("guiModifyCaption(): GUI Object not found: " + objectName);
|
|
|
|
if (!objectPlaces)
|
|
objectPlaces = 0;
|
|
objectPlaces = Math.pow (10, objectPlaces);
|
|
|
|
guiObject.caption = (Math.round (objectPlaces * guiObject.caption)
|
|
+ Math.round (objectPlaces * objectModifier) ) / objectPlaces;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Set caption of a GUI object.
|
|
function guiSetCaption (objectName, objectCaption)
|
|
{
|
|
// Sets an object's caption to the specified value.
|
|
|
|
// Get our GUI object
|
|
var guiObject = getGUIObjectByName (objectName);
|
|
|
|
if (guiObject == "" || guiObject == null || guiObject == undefined || guiObject == "undefined")
|
|
console.write ("guiSetCaption(): GUI Object not found: " + objectName);
|
|
|
|
guiObject.caption = objectCaption;
|
|
}
|
|
|
|
// ====================================================================
|
|
|
|
// Helper function that closes a given window (usually the current parent) and opens another one.
|
|
function guiSwitch (closeWindowName, openWindowName)
|
|
{
|
|
guiHide (closeWindowName);
|
|
guiUnHide (openWindowName);
|
|
}
|
|
|
|
// ====================================================================
|