Torque2D/engine/source/platform/platform_ScriptBinding.h

//-----------------------------------------------------------------------------
// Copyright (c) 2013 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

/*! @defgroup PlatformFunctions Platform
	@ingroup TorqueScriptFunctions
	@{
*/

/*! Use the setMouseLock function to un/lock the mouse.
    @param isLocked A boolean value.
    @return No return value
*/
ConsoleFunctionWithDocs( setMouseLock, ConsoleVoid, 2, 2, ( isLocked ))
{
    Platform::setMouseLock(dAtob(argv[1]));
}

//-----------------------------------------------------------------------------

/*! Use the getRealTime function to the computer time in milliseconds.
    @return Returns the current real time in milliseconds.
    @sa getSimTime
*/
ConsoleFunctionWithDocs( getRealTime, ConsoleInt, 1, 1, ())
{
    return Platform::getRealMilliseconds();
}

//-----------------------------------------------------------------------------

/*! Get the local time
    @return the local time formatted as: monthday/month/year hour/minute/second
*/
ConsoleFunctionWithDocs( getLocalTime, ConsoleString, 1, 1, ())
{
    char* buf = Con::getReturnBuffer(128);

    Platform::LocalTime lt;
    Platform::getLocalTime(lt);

    dSprintf(buf, 128, "%d/%d/%d %02d:%02d:%02d",
        lt.monthday,
        lt.month + 1,
        lt.year + 1900,
        lt.hour,
        lt.min,
        lt.sec);

    return buf;
}

/*! Use the getClipboard function to get the contents of the GUI clipboard.
	@return Returns a string equal to the current contents of the copy the clipboard, or a NULL strain if the copy clipboard is empty.
	@sa setClipboard
*/
ConsoleFunctionWithDocs( getClipboard, ConsoleString, 1, 1, ())
{
    return Platform::getClipboard();
};

/*!  Use the setClipboard function to Set value on clipboard to string.
	@param string The new value to place in the GUI clipboard.
	@return Returns true if successful, false otherwise.
	@sa getClipoard")
*/
ConsoleFunctionWithDocs( setClipboard, ConsoleBool, 2, 2, ( string ))
{
    return Platform::setClipboard(argv[1]);
};

/*! Creates a UUID string.
*/
ConsoleFunctionWithDocs( createUUID, ConsoleString, 1, 1, () )
{
    return Platform::createUUID();
}

/*! @} */ // group PlatformFunctions