[APPROVED] Miscellaneous Custom Commands (v1.07 - June 21st 2005)

[Xuri]

This script takes advantage of a recent feature-addition in UOX3 which allows one to easily add custom commands. You'll need version 0.98.1 or newer (currently only available in the CVS).

To set the script up, you need to follow the following steps, if your script-files don't already contain the required parts:

1) Open JSE_FILEASSOCIATIONS.SCP and scroll to the very bottom. Add the following lines after the last } bracket, but before the EOS line(if that section is already present, just add the SCRIPT= line):

Code: [Select all] [Expand/Collapse]

[COMMAND_SCRIPTS]
{
SCRIPT=command/misc-cmd.js
}

GeSHi © Codebox Plus Extension

2) Create a new sub-folder in the JS folder, called COMMAND. Copy the script listed below, and paste it into an empty text file (in notepad?) which you then save as misc-cmd.js in the UOX3\JS\COMMAND folder. Make sure the file-extension is ".js" and not ".txt" or ".js.txt"

3) Login, and use either of these commands at your pleasure:
'RENAME <string> // Rename target object to <string>
'REFRESH // Resends the objects that are onscreen, updates screen.
'FREEZE // Freezes targeted object to the ground
'UNFREEZE // Unfreezes targeted object
'BROWSE <url> // Opens <url> in the users' default browser
'INVUL <value> // Either makes target invulnerable (if "true" or 1), or vulnerable (if "false" or "0" );
'SETTAG <tagname>,<tagvalue> // Sets the tag <tagname> with value <tagvalue> on target object. Seperated by comma!
'GETTAG <tagname> // Retrieves the tagvalue of the specified tag from targeted object.
'NODECAY //Will turn off decay for the targeted item.
'DECAY //Will turn on decay for the targeted item.
'XSAY //Targeted charcter or item will say specified text out loud

Code: [Select all] [Expand/Collapse]

// Miscellaneous Custom Commands || by Xuri (xuri at sensewave.com)
// v1.07
// Last Updated: 21. June 2005
//
// This script contains some commands I scripted after the command-reorganization in the UOX3 source code,
// as well as some I've "invented" on my own.
// Updates:
// 10. July 2004 - added SETTAG and GETTAG commands
// 11. July 2004 - Allowed setting tags with value "null" to delete tags.
// 5. June 2005 - Added DECAY and NODECAY commands
// 21. June 2005 - Added XSAY command

function CommandRegistration()
{
    RegisterCommand( "rename", 2, true ); //Lets GMs rename items/characters.
    RegisterCommand( "refresh", 0, true ); //Lets players refresh their screen to resend items/chars that have vanished from view.
    RegisterCommand( "freeze", 2, true ); //Will "freeze" any targeted char, and will make any targeted item immovable (i.e. locked down by GM)
    RegisterCommand( "unfreeze", 2, true ); //Will "unfreeze" any targeted char, and will make any targeted item movable if previously immovable
    RegisterCommand( "browse", 0, true ); //WIll let users open a webpage in their default browser from within the UO client. BROWSE <url>
    RegisterCommand( "invul", 2, true ); //Will make the targeted character invulnerable or not, depending on the argument provided (true/false, 1/0)
    RegisterCommand( "addpack", 2, true ); //Will add a backpack to the targeted character, if it has none. Will add specified item-id(addpack <item-id> or hex id (addpack hex <hexid>) to backpack.
    RegisterCommand( "settag", 2, true ); //used to specify a value for a specified tag on a targeted object
    RegisterCommand( "gettag", 2, true ); //Used to retrieve the value of a specified tag from a targeted object
    RegisterCommand( "nodecay", 2, true ); //Will turn off decay for the targeted item.
    RegisterCommand( "decay", 2, true ); //Will turn on decay for the targeted item.
    RegisterCommand( "xsay", 2, true ); //Targeted charcter or item will say specified text out loud
}

function command_RENAME( pSock, execString )
{
    var pUser = pSock.currentChar;
    if( !execString == "" )
    {
        pSock.xText = execString;
        pSock.CustomTarget( 0, "What do you wish to rename to '"+execString+"'?" );
    }
    else
        pUser.SysMessage( "You need to enter a new name!" );
}

function command_REFRESH( pSock, execString )
{
    var pUser = pSock.currentChar;
    pUser.Teleport( pUser.x, pUser.y, pUser.z );
}

function command_FREEZE( pSock, execString )
{
    pSock.CustomTarget( 1, "What do you wish to freeze to the ground'?" );
}

function command_UNFREEZE( pSock, execString )
{
    pSock.CustomTarget( 2, "What do you wish to unfreeze'?" );
}

//Open a specified webpage in default browser
function command_BROWSE( pSock, execString )
{
    if( execString != "" )
        pSock.OpenURL( execString );
    else
        pUser.SysMessage( "That's not a valid URL." );
}

function command_INVUL( pSock, execString )
{
    if( execString == "" )
    {
        pSock.SysMessage( "You need to provide an argument with this command! Either true or false, 1 or 0!" );
        return;
    }
    if( execString == "true" || execString == 1 )
        pSock.CustomTarget( 3, "Whom do you wish to make invulnerable?" );
    else if ( execString == "false" || execString == 0 )
        pSock.CustomTarget( 4, "Whom do you wish to make vulnerable?" );
}

function command_ADDPACK( pSock, execString )
{
    var pUser = pSock.currentChar;
    if( execString == "" )
    {
        var pUser = pSock.currentChar;
        pSock.CustomTarget( 5, "On what character/at what location do you wish to add a backpack?" );
    }
    else
    {
        if( !isNaN(execString)) //Add from DFN-id
        {
            pSock.xText = execString;
            pSock.CustomTarget( 6, "On what character do you wish to add the item "+execString+"?" );          
        }
        else //Add from Hex-Id
        {
            var Word = execString.split(" ");
            if( Word[0] == "hex" )
            {
                pSock.xText = Word[1];
                pUser.SetTag( "AddFromHex", "Yep" );
                pSock.CustomTarget( 6, "On what character do you wish to add the item "+Word[1]+"?" );
            }
            else
                pUser.SysMessage( "Erroneous parameter specified! Try 'ADDPACK hex <hexid> or 'ADDPACK <item-id from dfn>" );
        }
    }
}

function command_SETTAG( pSock, execString )
{
    var pUser = pSock.currentChar;
    if( execString == "" || execString == null )
    {
        pUser.SysMessage( "You need to specify a tag and a value for the tag, seperated by a comma." );
        return;
    }
    var Word = execString.split(",");
    if( Word[0] == null || Word[0] == "" || Word[0] == " " || Word[1] == "" || Word[1] == null )
    {
        pUser.SysMessage( "You need to specify a tag and a value for the tag, seperated by a comma." );
        return;
    }
    pUser.SetTag( "Word0", Word[0] );
    pUser.SetTag( "Word1", Word[1] );
    pUser.CustomTarget( 8, "Apply tag to which object?" );
}

function command_GETTAG( pSock, execString )
{
    var pUser = pSock.currentChar;
    if( execString == null || execString == "" )
    {
        pUser.SysMessage( "You need to specify a tagname to retrieve the value for" );
        return;
    }
    pUser.SetTag( "TempTag", execString );
    pUser.CustomTarget( 9, "Retrieve tag from which object?" );
}

function command_NODECAY( pSock, execString )
{
    var pUser = pSock.currentChar;
    pUser.CustomTarget( 10, "Select an item to set as NOT decayable:" );   
}

function command_DECAY( pSock, execString )
{
    var pUser = pSock.currentChar;
    pUser.CustomTarget( 11, "Select an item to set as decayable:" );
}

function command_XSAY( pSock, execString )
{
    var pUser = pSock.currentChar;
    if( execString )
    {
        pSock.xText = execString;      
        pUser.CustomTarget( 12, "Select object for remote speech:" );
    }
    else
        pUser.SysMessage( "You forgot to write some text to go with this command." );
}

//Rename
function onCallback0( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var NewName = pSock.xText;
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 )
    {
        pUser.SysMessage( "'"+myTarget.name+"' has been renamed to '"+NewName+"'." );
        myTarget.name = NewName;
    }
    else
    {
        pUser.SysMessage( "You cannot rename that!" );
    }
    pUser.SetTag( "RenameCmdText", null );
}

//Freeze
function onCallback1( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 && myTarget.isChar  )
    {
        myTarget.frozen = true;
        pUser.SysMessage( "The selected character has been frozen." );
        return;
    }
    if( StrangeByte == 0 && !myTarget.isChar  )
    {
        myTarget.movable = 2;
        pUser.SysMessage( "The selected item has been frozen." );
        return;
    }
    pUser.SysMessage( "You cannot freeze that." );
}

//Unfreeze
function onCallback2( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 && myTarget.isChar  )
    {
        if( myTarget.frozen == true )
        {
            myTarget.frozen = false;
            pUser.SysMessage( "The selected item has been unfrozen." );
        }
        else
            pUser.SysMessage( "That character isn't frozen! Can't unfreeze!" );
        return;
    }
    if( StrangeByte == 0 && !myTarget.isChar  )
    {
        if( myTarget.movable <= 1 )
            pUser.SysMessage( "That item isn't frozen! Can't unfreeze!" );
        else
        {
            myTarget.movable = 1;
            pUser.SysMessage( "The selected item has been unfrozen." );
        }
        return;
    }
    pUser.SysMessage( "You cannot unfreeze that." );
}

function onCallback3( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 && myTarget.isChar  )
    {
        if( myTarget.vulnerable == false )
        {
            pUser.SysMessage( "Error! That target is already invulnerable!" );
            return;
        }
        pUser.SysMessage( "The selected target has been made invulnerable." );
        myTarget.vulnerable = false;
        return;
    }
    pUser.SysMessage( "That is not a character. Try again." );
}
function onCallback4( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 && myTarget.isChar  )
    {
        if( myTarget.vulnerable == true )
        {
            pUser.SysMessage( "Error! That target is already vulnerable!" );
            return;
        }
        pUser.SysMessage( "The selected target has been made vulnerable." );
        myTarget.vulnerable = true;
        return;
    }
    pUser.SysMessage( "That is not a character. Try again." );
}

//Addpack without parameters
function onCallback5( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var targX = pSock.GetWord( 11 );
    var targY = pSock.GetWord( 13 );
    var targZ = pSock.GetByte( 16 );
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 && myTarget.isChar  )
    {
        var tempObj = myTarget.FindItemLayer(21);
        if( tempObj == null )
        {
            var newPack = CreateDFNItem( pUser.socket, pUser, "0x09b2", 1, "ITEM", false );
            newPack.container = pUser;
            newPack.layer = 21;
            newPack.weight = 0;
        }
        else
            pUser.SysMessage( "That character already has a backpack. No new backpack added." );
        return;
    }
    else
    {
        var newPack = CreateDFNItem( pUser.socket, pUser, "0x09b2", 1, "ITEM", false );
        newPack.x = targX;
        newPack.y = targY;
        newPack.z = targZ;
    }
}

// ADDPACK callback function
function onCallback6( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var TempItemID = pSock.xText;
    pUser.SysMessage( TempItemID );
    var Word1 = pSock.xText;
    var Word1 = Number(Word1);
    var AddFromHex = pUser.GetTag( "AddFromHex" );
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 && myTarget.isChar  )
    {
        var tempObj = myTarget.FindItemLayer(21);
        if( tempObj != null )
        {
            if( AddFromHex != "Yep" )
                var tempItem = CreateDFNItem( pUser.socket, pUser, TempItemID, 1, "ITEM", true );              
            else
                var tempItem = CreateBlankItem( pSock, pUser, 1, "#", Word1, 0x0, "ITEM", true );
        }
        else
        {
            pUser.SysMessage( "That character has no backpack! Backpack being added before new item..." );
            var newPack = CreateDFNItem( pUser.socket, pUser, "0x09b2", 1, "ITEM", false );
            newPack.container = pUser;
            newPack.layer = 21;
            newPack.weight = 0;
            if( AddFromHex != "Yep" )
                var tempItem = CreateDFNItem( pUser.socket, pUser, TempItemID, 1, "ITEM", false );             
            else
                var tempItem = CreateBlankItem( pSock, pUser, 1, "#", Word1, 0x0, "ITEM", false );         
        }
        pUser.SetTag( "AddFromHex", null );
        return;
    }
    else
        pUser.SysMessage( "That is no character. Try again." );
    pUser.SetTag( "AddFromHex", null );
}
// Set Tag
function onCallback8( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var Word0 = pUser.GetTag( "Word0" );
    var Word1 = pUser.GetTag( "Word1" );
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 )
    {
        if( Word1 == "null" )
            myTarget.SetTag( Word0, null );
        else
            myTarget.SetTag( Word0, Word1 );
        pUser.SysMessage( "You have set a tag named '"+Word0+"' with a value of '"+Word1+"' on the targeted object." );
    }
    else
    {
        pUser.SysMessage( "You need to target a dynamic object (item or character)." );
    }
    pUser.SetTag( "Word0", null );
    pUser.SetTag( "Word1", null );
}

// Get Tag
function onCallback9( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var TempTagName = pUser.GetTag( "TempTag" );
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 )
    {
        var TagData = myTarget.GetTag( TempTagName );
        pUser.SysMessage( "The value of the targeted object's '"+TempTagName+"'-tag is: "+TagData );
    }
    else
    {
        pUser.SysMessage( "You need to target a dynamic object (item or character)." );
    }
    pUser.SetTag( "TempTag", null );
}

// Nodecay
function onCallback10( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 )
    {
        if( myTarget.isItem )
        {
            myTarget.decayable = false;
            pUser.SysMessage( "Item successfully set as NOT decayable." );
        }
        else
            pUser.SysMessage( "This command can only be applied to items." );
    }
    else
        pUser.SysMessage( "You need to target a dynamic item." );  
}

// Decay
function onCallback11( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var StrangeByte = pSock.GetWord( 1 );
    if( StrangeByte == 0 )
    {
        if( myTarget.isItem )
        {
            myTarget.decayable = true;
            pUser.SysMessage( "Item successfully set as decayable." );
        }
        else
            pUser.SysMessage( "This command can only be applied to items." );
    }
    else
        pUser.SysMessage( "You need to target a dynamic item." );  
}

// XSAY
function onCallback12( pSock, myTarget )
{
    var pUser = pSock.currentChar;
    var StrangeByte   = pSock.GetWord( 1 );
    if( StrangeByte == 0 && ( myTarget.isChar || myTarget.isItem ))
    {
        myTarget.sayColour = pUser.sayColour;
        myTarget.TextMessage( pSock.xText );
    }
    else
        pUser.SysMessage( "You must target either a character or a dynamic item." );
}

GeSHi © Codebox Plus Extension

[Maarc]

That's some nice work, Mr. X

[giwo]

Very nice, Xu, keep 'em comin (ultimately that's the goal for most all commands... no more hardcoding).

And if you hit any bumps in the road with functionality on them, let me know, I'll have a look at it

giwo