UOX3 Script Engine

function inRange( pCharacter, objInRange, objType )

function inRange( pCharacter, objInRange, objType )
{
	if( objType == 1 )	// An item came into range
	{
		pCharacter.DoStaticEffect( 0x376A, 9, 0, );	// Make some sparkles!
		if( objInRange.id == 0x1416 )	// Ooh, it's a purty piece of armour
		{
			pCharacter.EmoteMessage( "*ooooooooooooo*" );
		}
	}
}

function onAISliver( npcChar )

function onAISliver( tChar )
{

tChar.DoAction( 111 );
}
//The NPC tChar performs action 111 (dance-animation in 3D UO clients)
//on every NPC ai check, essentially looping the animation =)

function onAttack( pAttacker, pDefender )

function onAttack( pAttacker, pDefender )
{
	pAttacker.TextMessage( "Who lives in that castle?" );
	pDefender.TextMessage( "Help! Help! I'm being repressed!" );
}

function onBuy( pSock, Vendor )

function onBuy( pSock, Vendor )
{
	// If player does not belong to the undead race, vendor wants nothing to do with him!
	if( pSock.currentChar.raceID != 11 )
	{
		Vendor.TextMessage( "Sorry, I don't sell to the likes of you!" );
		return false;
	}
	else
		return true;
}

function onBuyFromVendor( pSock, Vendor, iBought )

function onBuyFromVendor( pSock, Vendor, iBought )
{
	var pUser = pSock.currentChar;
	pUser.TextMessage( "I am buying an item ("+iBought.name+") from a vendor!" );
	Vendor.TextMessage( "I am selling an item!" );
	return true;
}

function onBoughtFromVendor( pSock, Vendor, iBought )

function onBoughtFromVendor( pSock, Vendor, iBought )
{
	var pUser = pSock.currentChar;
	pUser.TextMessage( "I bought an item ("+iBought.name+") from a vendor!" );
	Vendor.TextMessage( "I just sold an item to some random dude!" );
	return true;
}

function onCallback#( socket, target )

function CommandRegistration()
{
	RegisterCommand( "disconnect", 2, true );
}
function command_DISCONNECT( socket, cmdString )
{
	var targMsg = GetDictionaryEntry( 196, socket.Language );
	socket.CustomTarget( 0, targMsg );
}
function onCallback0( socket, ourObj )
{
	if( !socket.GetWord( 1 ) && ourObj.isChar && ourObj.online )
	{
		var targSock = ourObj.socket;
		if( targSock && targSock != socket )
		{
			socket.SysMessage( GetDictionaryEntry( 1029, socket.Language ) );
			targSock.SysMessage( GetDictionaryEntry( 1030, targSock.Language ) );
			targSock.Disconnect();
		}
	}
}

function onCharDoubleClick( pUser, targChar )

function onCharDoubleClick( pUser, targChar )
{
	targChar.TextMessage( "If you think you'll be allowed to see my paperdoll, think again!" );
	return false;
}

function onClick( pUser, iUsed )

function onClick( pUser, iUsed )
{
	pUser.SysMessage("You have clicked on: "+iUsed.name );
}

function onCollide( targSock, pColliding, objCollidedWith )

function onCollide( trgSock, srcChar, trgItem )
{
	srcChar.Teleport( srcChar.x + 5, srcChar.y +5, srcChar.z, 0 );
	srcChar.EmoteMessage( "*Eegads, I am teleported!*" );
	//srcChar.DoStaticEffect( 0x376A, 9, 0, 0 );
}

function onCombatStart( pAttacker, pDefender )

function onCombatStart( pAttacker, pDefender )
{
	pAttacker.TextMessage( "I'm attacking!" );
	pDefender.TextMessage( "I'm being attacked!" );
	return true;
}

function onCombatEnd( currChar, targChar )

function onCombatEnd( pDefender, pAttacker )
{
	if( currChar.health != 0 )
		currChar.TextMessage( "Whee! I survived combat!" );
	if( targChar.health != 0 )
		targChar.TextMessage( "Yay! I survived combat!" );
	return true;
}

function onCombatDamageCalc( attacker, defender, getFightSkill )

function onCombatDamageCalc( pAttacker, pDefender, fightSkill )
{
	var baseDamage = pAttacker.attack;
	var hitLoc = CalculateHitLoc();

	if( baseDamage == -1 )  // No damage if weapon breaks
		return 0;

	var damage = ApplyDamageBonuses( 1, pAttacker, pDefender, fightSkill, hitLoc, baseDamage );

	if( damage < 1 )
		return 0;

	damage = ApplyDefenseModifiers( 1, pAttacker, pDefender, fightSkill, hitLoc, damage, true);

	if( damage <= 0 )
		damage = RandomNumber( 0, 4 );

	if( !pDefender.npc )
		damage /= 2;

	return damage;
}

function onCreateDFN( objMade, objType )

function onCreate( objMade, objType )
{
	if( objType == 1 )
		objMade.SysMessage( "Welcome to Our Unique World(TM)!" );
}
// When this script is setup as "global id" (0) in JSE_FILEASSOCIATIONS.SCP,
// it will send the sysmessage to all NEW characters that enters the world.

function onCreateTile( objMade, objType )

function onCreate( objMade, objType )
{
	objMade.name = "A renamed item";
}
// Only scripts using script-id 0 or ones assigned through harditems.dfn will work with this event.

function onDamage( damaged, attacker, damageValue );

function onDamage( damaged, attacker, damageValue )
{
	damaged.TextMessage( "Ouch, those "+damageValue+" points of damage hurt." );
}

function onDeath( pDead );

function onDeath( pDead )
{
	pDead.Teleport( 1000, 1000, 0 );
}

function onDeathBlow( pKilled, pKiller );

function onDeathBlow( pDead, pKiller )
{
	pDead.health = pDead.health + 10;
	pDead.TextMessage( "But I'm not dead!" );
	return true;
}

function onDecay( iDecaying )

function onDecay( iDecaying )
{
	iDecaying.StaticEffect( 0x376A, 9, 6 );
}

function onDefense( pAttacker, pDefender )

function onDefense( pAttacker, pDefender )
{
	pAttacker.TextMessage( "Who lives in that castle?" );
	pDefender.TextMessage( "Help! Help! I'm being repressed!" );
}

function onDelete( objDestroyed, objType )

function onDelete( objDestroyed, objType )
{
	if( objType == 0 )
		ConsoleMessage( objDestroyed.name+" has been deleted from the world." );
}

function onDispel( objDispelled, objType )

function onDispel( objDispelled, objType )
{
	ConsoleMessage( objDispelled.name+" has been dispelled." );
}

function onDrop( iDropped, pDropper )

function onDrop( iDropped, pDropper )
{
	var pSock = pDropper.socket;

	//Lets fetch the serial of the target-location
	var temp1 = pSock.GetByte( 10 );
	var temp2 = pSock.GetByte( 11 );
	var temp3 = pSock.GetByte( 12 );
	var temp4 = pSock.GetByte( 13 );

	//Check the value of Byte 10 to determine if the target is ground, character or container
	if( temp1 == 0 ) //Target is a character
	{
		var targetChar = CalcCharFromSer( temp1, temp2, temp3, temp4 )
		pDropper.TextMessage( "I've dropped this item on a character named "+targetChar.name+", let's bounce it back." );
		return false;
	}
	if( temp1 == 0xFF ) //Target is ground or another item
	{
		pDropper.TextMessage( "I've dropped this item on the ground or on another item." );
		return;
	}
	if( temp1 <= 0x40 ) //Target is a container
	{
		var targetItem = CalcItemFromItem( temp1, temp2, temp3, temp4 );
		pDropper.TextMessage( "I've dropped this item in/on a container with ID "+targetItem.id+"." );
		return;
	}
}

function onDropItemOnItem( iDropped, cDropper, iDroppedOn )

function onDropItemOnItem( iDropped, cDropper, iDroppedOn )
{
	if( iDropped.id == 0x1f14 ) //If the item being dropped is a recall rune
	{
		if( iDroppedOn.id == 0x0efa ) //If the item being dropped on is a spellbook
		{
			cDropper.TextMessage("I am dropping "+iDropped.name+" on a "+iDroppedOn.name );
		}
	}
	else
	{
		cDropper.TextMessage( "Generic error message!" );
		return 0;
	}
}

function onDropItemOnNpc( pDropper, pDroppedOn, iDropped )

function onDropItemOnNpc( pDropper, pDroppedOn, iDropped )
{
	pDropper.TextMessage("Here, I offer you my this object as a gift of friendship.");
	pDroppedOn.TextMessage("Fudge off!");
	iDropped.colour =13;
	return 0;
}

function onEnterEvadeState( mNPC, enemyChar )

function onEnterEvadeState( mNPC, enemyChar )
{
	mChar.TextMessage( "I've entered the Evade state! My HP will be replenished..." );
	enemyChar.TextMessage( "Oops, I caused the NPC to enter Evade state!" );
}

function onEnterRegion( pEntering, regionEntered )

function onEnterRegion( pEntering, regionEntered )
{
	if( pEntering.raceID != 11 )
	{
		//sound the alarm! non-undead intruder to region
		//spawn undead guards
	}
}

function onEntrance( iEntered, objEntering, objType )

function onEntrance( iEntered, objEntering, objType )
{
	if( objType == 0 )
		objEntering.SysMessage("You have entered "+iEntered.name);
}

function onEquip( pEquipper, iEquipped )

function onEquip( pEquipper, iEquipped )
{
	pEquipper.StaticEffect( 0x376A, 9, 6 );
}

function onFall( pFall, fallDistance )

function onFall( pFall, fallDistance )
{
	if( fallDistance > 20 )
		pFall.SysMessage("Yikes! That was a long fall!");
}

function onFlagChange( pChanging, newStatus, oldStatus );

function onGumpPress( pSock, pButton, gumpData )

function onGumpPress( pSock, pButton, gumpData )
{
	var pUser = pSock.currentChar;
	switch(pButton)
	{
		case 0:
			// abort and do nothing
			break;
		case 1:
			var Text1 = gumpData.getEdit(0);
			pUser.SysMessage( "The first TextEntry was: "+Text1 );
			var Text2 = gumpData.getEdit(1);
			pUser.SysMessage( "The second TextEntry was: "+Text2 )
			var OtherButton = gumpData.getButton(0);
			switch(RadioButton)
			{
				case 0:
					pUser.SysMessage( "You selected RadioButton number: "+OtherButton );
					pUser.DoAction( 15 );
					break;
				case 1:
					pUser.SysMessage( "You selected RadioButton number: "+OtherButton );
					pUser.DoAction( 11 );
					break;
				case 2:
					pUser.SysMessage( "The Checkbox with ID "+OtherButton+" was checked." );
					pUser.DoAction( 18 );
					break;

			}
			break;
	}
}

function onHouseCommand( pSocket, iMulti, cmdID )

function onHouseCommand( pSocket, iMulti, cmdID )
{
	if( ValidateObject( iMulti ) && iMulti.IsInMulti( pSocket.currentChar ))
	{
		switch( cmdID )
		{
			case 34: // Remove Thyself
				pSocket.CustomTarget( 0, "Who do you want to remove from your house?" );
				break;
			default:
				Console.Log( "Unhandled house command detected with cmdID: " + cmdID );
				return false;
		}
	}

	return true;
}

function onHungerChange( pChanging, newStatus );

function onHungerChange( pChanging, newStatus )

{

	TextMessage( pChanging, "ooooo, I feel more hungry" );

	if( newStatus == 0 )

	{

		TextMessage( pChanging, "I'm melting, I'm melting!" );

	}

}

function onIterate( object )

function doStuff( socket, pUser )
{
	socket.SysMessage( "Killing all NPCs" );
	var numKilled = IterateOver( "CHARACTER" );
	socket.SysMessage( "Killed " + NumToString( numKilled ) + " NPCs " );
}

function onIterate( charCheck )
{
	if( !charCheck )
		return false;
	if( charCheck.npc )
		charCheck.Kill();
	return true;
}

function onLeaveRegion( pLeaver, regionLeft )

function onLeaveRegion( pLeaver, regionLeft )
{
	//if pLeaver is not allowed to leave the region
	//turn him into a criminal and spawn guards to go after him!
}

function onLeaving( iLeft, objLeaving, objType )

function onLeaving( iLeft, objLeaving, objType )
{
	if( objType == 0 )
		objLeaving.SysMessage("You have left "+iLeft.name);
}

function onLightChange( object, lightlevel )

function onLightChange( object, lightlevel )
{
	(pseudo-code)
	if( object && object is item )
	{
		if( object.id equals unlit lamppost )
		{
			if( lightlevel > 10 ) //high light levels = dark, low light levels = bright
			{
				object.id = lit lamppost
			}
		}
		else if( object.id equals lit lamppost )
		{
			if( lightlevel < 10 )
			{
				object.id = unlit lamppost
			}
		}
	}
}

function onLogin( sockPlayer, pChar )

function onLogin( sockPlayer, pChar )

{

	pChar.Teleport( 1000, 1000, 0, 0 );

}

function onLogout( sockPlayer, pChar )

function onLogin( sockPlayer, pChar )

{

	sockPlayer.SysMessage ( "Farewell! Come back soon." );

}

function onPacketReceive( socket, packetNum, subCommand )

function PacketRegistration()
{
	RegisterPacket( [packetID], [subCommand] );
}

function onPacketReceive( pSocket, packetNum, subCommand )
{
	var cmd = pSocket.GetByte( 0 );
	if( cmd != packetNum )
		return;

	... // Read packet data here, using ReadBytes, GetByte, GetWord, GetDWord, GetSByte, GetSWord, GetSDWord and GetString socket methods
	return;
}

function onPathfindEnd( tChar, pathfindResult )

function onPathfindEnd( tChar, pathfindResult )
{
	if( ValidateObject( tChar ))
	{
		tChar.TextMessage( "Pathfinding ended! Result of pathfinding was... ");
		switch( pathfindResult )
		{
			case -1: // Pathfinding failed
				tChar.TextMessage( "...a failure! I couldn't move at all." );
				break;
			case 0: // Pathfinding partially succeeded, but didn't make it all the way to target destination
				tChar.TextMessage( "...a partial success! I made it part of the way there." );
				break;
			case 1: // Reached end of the path
				tChar.TextMessage( "...a success! I reached my target location." );
				break;
			default:
				tChar.TextMessage( "...a success? A failure? I have no idea. Result unknown!" );
				break;
		}

	}
}

function onPickup( iPickedUp, pGrabber )

function onPickup( iPickedUp, pGrabber )
{
	var pSock = pGrabber.socket;

	//Check the value of pSock.pickupSpot to determine where the item was picked up from
	switch( pSock.pickupSpot )
	{
		case 0: //nowhere
			pGrabber.TextMessage( "I picked up this item from... NOWHERE!" );
			break;
		case 1: //ground
			pGrabber.TextMessage( "I picked up this item from the ground." );
			break;
		case 2: //ownpack
			pGrabber.TextMessage( "I picked up this item from my own backpack." );
			break;
		case 3: //otherpack
			pGrabber.TextMessage( "I picked up this item from a container." );
			break;
		case 4: //paperdoll
			pGrabber.TextMessage( "I picked up this item from my paperdoll." );
			break;
		case 5: //bank
			pGrabber.TextMessage( "I picked up this item from my bank box." );
			break;
		default:
			pGrabber.TextMessage( "Error. Redo from Start." );
			break;
	}

	//Use return false to disallow the pickup and bounce item
	//return false;
}

function onRessurect( pAlive );

function onResurrect( pAlive )
{
	var ResAmount = pAlive.GetTag( "ResAmount" );
	if( ResAmount && ResAmount < 5 )
	{
		pAlive.SysMessage( "You still have some spirit left... have a good one!" );
		return true;
	}
	else
	{
		pAlive.SysMessage( "You've resurrected too many times already! Have fun in the gray world!" );
		return false;
	}
}

function onScrollCast( pUser, spellID )

function onScrollCast( pUser, spellID )
{
	if( spellID == 18 )
	{
		pUser.TextMessage( "I'm casting a fireball from a fireball-scroll!" );
		return -1;
	}
}

function onSell( pSock, Vendor )

function onSell( pSock, Vendor )
{
	// If player does not belong to the undead race, vendor wants nothing to do with him!
	if( pSock.currentChar.raceID != 11 )
	{
		Vendor.TextMessage( "RIGHT! As if I would buy from you..." );
		return false;
	}
	else
		return true;
}

function onSellToVendor( pSock, Vendor, iSold )

function onSellToVendor( pSock, Vendor, iSold )
{
	var pUser = pSock.currentChar;
	pUser.TextMessage( "I am selling an item ("+iSold.name+") to a vendor!" );
	Vendor.TextMessage( "I am buying an item!" );
	return true;
}

function onSoldToVendor( pSock, Vendor, iSold )

function onSoldToVendor( pSock, Vendor, iSold )
{
	var pUser = pSock.currentChar;
	pUser.TextMessage( "I sold an item ("+iSold.name+") to a vendor!" );
	Vendor.TextMessage( "I just bought an item from some random dude!" );
	return true;
}

function onSkill( objUsing, skillUsed, objType )

function onSkill( objUsing, skillUsed, objType )
{
	switch( skillUsed )
	{
	case 0:
		objUsing.TextMessage("Time to do some alchemy work!");
		break;
	case 1:
		objUsing.TextMessage("Now using Anatomy skill!");
		break;
	case 2:
		objUsing.TextMessage("Animal Lore usage Enabled!");
		break;
	//case etc.:
	}
}

function onSkillChange( pPlayer, skill )

function onSkillChange( pPlayer, skill )
{
	pPlayer.TextMessage( pPlayer, "Oh dear, my skill's changed" );
}

function onSkillCheck( pUser, skillID, lowSkill, highSkill )

function onSkillCheck( pUser, skillID, lowSkill, highSkill )
{
	pUser.TextMessage( "A skillcheck is being done for skill with ID " + skillID + "!" );
}

function onSkillGain( pPlayer, skill )

function onSkillGain( pPlayer, skill )
{
	pPlayer.TextMessage("Wheee! I've gained some skill!");
}

function onSkillLoss( pPlayer, skill )

function onSkillLoss( pPlayer, skill )
{
	pPlayer.TextMessage( "Oh no, I've lost skill!" );
}

function onSkillGump( pUser )

function onSkillGump( pUser )
{
	pUser.SysMessage( "Overriding default skillgump, opening custom one instead..." );
	// Insert custom skillgump here!
}

function onSpellGain( spellBook, spellNum )

function onSpellLoss( spellBook, spellNum )

function onSnooped( pSnooped, pSnooping, bSuccess );

function onSnooped( pSnooped, pSnooping, bSuccess )
{
	pSnooped.TextMessage( "Oi! You! Stop snooping!" );
}

function onSpeech( strSaid, pTalking, pTalkingTo )

function onSpeech( strSaid, pTalking, pTalkingTo )
{
	pTalkingTo.TextMessage( strSaid );
}
// This is a simple mimic NPC.  Everything that someone says to it is quoted back verbatim

function onSpeechInput(pUser, pItem, pSpeech, pSpeechID)

function onUseChecked( pUser, iUsed)
{
	pUser.SysMessage( "What do you want to rename this item to:" );
	pUser.SpeechInput(1, iUsed);
}

function onSpeechInput(pUser, iUsed, pSpeech, pSpeechID)
{
	if(pSpeech == null || pSpeech == " ")
	{
		pUser.SysMessage( "You didn't type anything!" );
		return;
	}
    	switch(pSpeechID)
    	{
	case 1:
		pUser.SysMessage( "You rename the item to: "+pSpeech );
		iUsed.name = pSpeech;
		break;
	}
}

function onSpellCast( pUser, spellID )

function onSpellCast( pUser, spellID )
{
	if( spellID == 18 )
	{
		pUser.CustomTarget( 0, "What do you want to target with your fireball?" );
	        return -1;
	}
}

function onSpellTarget( myTarget, pUser, spellID )

function onSpellTarget( myTarget, pUser, spellID )
{
	if( spellID == 18 )
	{
		myTarget.TextMessage( "AAAAAAaaaaaaa! I've been hit by a fireball!" );
	}
}

function onSpellSuccess( pUser, spellID )

function onSpellSuccess( pUser, spellID )
{
	if( spellID == 18 )
	{
		pUser.TextMessage( "Yes! I managed to cast a fireball!" );
	}
}

function onStatChange( pPlayer, stat )

function onStatChange( pPlayer, stat )
{
	pPlayer.TextMessage("Whee my stats changed!");
}

function onStatGained( pPlayer, stat )

function onStatGained( pPlayer, stat )
{
	pPlayer.TextMessage("Whee I gained some stat!");
}

function onStatLoss( pPlayer, stat )

function onStatLoss( pPlayer, stat )
{
	pPlayer.TextMessage("Awww I lost some stats.");
}

function onSteal( thief, objStolen )

function onSteal( thief, objStolen )
{
	thief.SysMessage( "You attempt to steal the "+objStolen.name );
	ConsoleMessage( objStolen.name+" has been attempted stolen!" );

}

function onStolenFrom( pThief, pVictim, iStolen );

function onStolenFrom( pThief, pVictim, iStolen )

{

	TextMessage( pVictim, "Hey you, get your hands off my banana!" );

	Attack( pVictim, pThief );

	YellMessage( pVictim, "GUARDS!!!!!!!" );

}

function onSwing( iSwung, pSwinging, pSwingAt )

function onSwing( iSwung, pSwinging, pSwingAt )
{
	pSwinging.TextMessage( "Have at thee, knave!" );
}

function onTalk( pTalking, strSaid )

function onTalk( myChar, mySpeech )
{
	if( mySpeech == "'dig")
		myChar.DoAction(11);
	else
		return true;
}
// This is a simple script that will make the character talking perform the digging animation upon saying "'dig".
// (Note: 'DIG won't be displayed as speech, since script intercepts the text before it is spoken out loud)
// If anything else is said, the script returns true so speech can proceed as normal.

function onTempChange( object, temperature )

function onTimer( tChar, timerID )

function onTimer( tChar, timerID )

{

	if( timerID == 0 )

	{

		DoStaticEffect( pCharacter, 0x376A, 9, 0, 0 );	// Make some sparkles!

	}

}

function onTransfer( iTransferred, pSrc, pTrg )

function onTransfer( iTransferred, pSrc, pTrg )
{
	pSrc.TextMessage("Whee I'm transferring this item to you, "+pTrg.name+"!");
	pTrg.TextMessage("Thank you, "+pSrc.name+"!");
}

function onUnequip( pEquipper, iUnequipped )

function onUnequip( pUnequipper, iUnequipped )
{
	pUnequipper.StaticEffect( 0x376A, 9, 6 );
}

function onUseBandageMacro( pSock, targChar, iUsed )

function onUseBandageMacro( pSock, targChar, bandageItem )
{
	targChar.TextMessage( "#0" );
	if( pSock && bandageItem && bandageItem.amount >= 1 )
	{
		var pUser = pSock.currentChar;
		TriggerEvent( 4000, "onUseCheckedTriggered", pUser, targChar, bandageItem );
	}
	return true;
}

...then, in scriptID 4000 - skill\healing.js, add this at the top of the file:

function onUseCheckedTriggered( pUser, targChar, iUsed )
{
	pUser.TextMessage( "#1" );
	if( pUser && iUsed && iUsed.isItem )
	{
		pUser.TextMessage( "#2" );

		var socket = pUser.socket;
		if( socket )
		{
			pUser.TextMessage( "#3" );

			if( pUser.skillsused.healing || pUser.skillsused.veterinary )
			{
				pUser.TextMessage( "#4" );
				socket.SysMessage( "You are too busy to do that." );
			}
			else if( socket.GetTimer( 0 ) <= GetCurrentClock() )
			{
				pUser.TextMessage( "#5" );
				socket.tempObj = iUsed;
				socket.SetTimer( 0, 5000 );
				onCallback1( socket, targChar );
			}
			else
			{
				pUser.TextMessage( "#6" );
				socket.SysMessage( GetDictionaryEntry( 473, socket.Language ) );
			}
		}
	}
	return true;
}

function onUseChecked( pUser, iUsed )

function onUseChecked( pUser, iUsed )
{
	var trgSock = pUser.socket;
	if(pUser.InRange( iUsed, 8 ))
		pUser.OpenBank(trgSock);
	return false;
}

function onUseUnChecked( pUser, iUsed )

function onUseUnChecked( pUser, iUsed )
{
	var trgSock = pUser.socket;
	if(pUser.InRange( iUsed, 8 ))
		pUser.OpenBank(trgSock);
	return false;
}

function onVirtueGumpPress( mChar, tChar, buttonID )

function onWeatherChange( object, weatherType )

function OutOfRange( pChar, objVanish, objType )