Minecraft Forums

Script Functions - These functions are optional for your scripts, but will help you determine how your spells behave

getExp() - return a decimal value of how much experience the spell is worth for casting; if this is not in your script, it will give 0 exp
getLevelReq() - return an integer value of what magic level is required for the spell; if this is not in your script, it will default to 0
getGlobalDelay() - return the global cooldown for casting this spell - this is the time it takes before you can cast anymore spells; if this is not in your script, it will default to 4000ms
getSpellDelay() - return the spell cooldown for casting this spell - this is the time it takes before you can cast this particular spell again; if this is not in your script, it will default to 4000ms
getRunes() - return a list of runes that the spell requires; if this is not in your script, no runes will be required, essentially forcing the spell to be "free cast"
getSpellName() - return the name of the spell as a String; This is HIGHLY recommend to be in your script, because if it isn't, it will default to "Unknown Spell" and cause problems with other scripts that do not have this implemented
getParticleColors() - return a map of the colors and their weights for the spell's particle effect; if this is not in your script, it defaults to an empty map which results in no particle effect - this is highly recommended for projectile spells, but not so much for other spells
isProjectile() - return a true/false for whether this is a projectile-type spell or not; if this is not in your script, it defaults to false (ie, not a projectile)
shouldSpellBeCast(player, staff, world) - return a true/false for whether or not the player can cast this spell, such as if the player has a certain skill level or certain item in their inventory; if this is not in your script, it defaults to true (ie player can always cast the spell)
onSpellCast(player, world, staff) - what to do when the spell is cast, probably the single most important function for non-projectile spells; if this is not in your script, why are you even making one??
onImpactBlock(player, world, staff, i, j, k) - what to do when a projectile hits a block in the world, not entirely important, but could be nice for 'splosions; if this is not in your script, nothing will happen and the spell will just 'die'
onImpactLiving(player, living, world, staff) - what to do when a projectile hits a living entity (mobs or other players), important for applying damage to the living entity, teleporting it, etc; if this is not in your script, nothing will happen and the spell will just 'die'

Information on selected functionality
All of the Main functions are location in the same package, so it only requires a single import at the top of your script. More advanced stuff (like checking item prices, tagging items with extra data, etc) will require more imports from GuffCore - more on that in the real scripting guide.

Due to Minecraft's obfuscation, direct translation from the spell scripts to the mod is not possible, because when the mod references change, the scripts do not. To get around this, wrapper classes are presented for Entities (and by extension mobs and players) and the World, as well as ItemStacks (again, more on that stuff later). In this code section, I will discuss some of the functions that are used in the Entity wrappers to give the community some ideas on what sort of spells they might want to make and inspire them to come up with MORE functions for the library.

EntityWrapper:

getX(), getY(), getZ() - return the entity's x, y, or z coordinate
setLocation(x, y, z) - set the entity's x, y, and z coordinates (move the player, useful for teleports)
getNearbyEntities(radius) - return a list of EntityWrappers within the radius
isLiving() - return whether the entity is living or not
isPlayer() - return whether the entity is a player or not

LivingWrapper:
applyDamage(amount) - hurt the entity by the amount of half hearts specified
heal(amount) - heal the entity by the amount of half hearts specified
setHeldItem(item) - set the held item of the entity
setHelmet(item) - set the helmet of the entity
setChest(item) - set the chest armor of the entity
setLegs(item) - set the leg armor of the entity
setBoots(item) - the the boots of the entity

PlayerWrapper:
getSkill(name) - return the Skill by the name specified
getItemInSlot(slot) - return the ItemStack in the inventory slot; 0-8 is the hotbar, 9-35 is the rest
hasItem(item) - return true/false if the player has the specified ItemStack; must be the same item ID, same metadata, and greater than or equal to stack size
giveItem(item) - give an ItemStack to the player; if the player can't receive the item, drops it into the world by the player
consumeItem(item) - remove one of the specified ItemStack from the player's inventory
consumeItemAmount(item) - remove all of the specified ItemStack based on the amount of the stack

glassMake.js - This is a script I put together to imitate the spell Superglass Make from RuneScape:
 
//Import the java.util package and scripting package from the mod
importPackage(java.util);
importPackage(com.mod.rsmc.scripting);

//Give the spell a name
function getSpellName()
{
return 'Superglass Make';
}
//Spell will require level 77 Magic to cast
function getLevelReq()
{
return 77;
}
//Build a list of required runes for the spell - the final list is 2 astral, 6 air, 10 fire
function getRunes()
{
l = new ArrayList();
l.add(ItemWrapper.getItemStack("rune", "astral", 2));
l.add(ItemWrapper.getItemStack("rune", "fire", 6));
l.add(ItemWrapper.getItemStack("rune", "air", 10));
return l;
}
//Very important function here. Creates and ItemStack to store data for 16 sand, then consume all of the sand and give the player 16 //glass blocks in its place.
function onSpellCast(player, world, staff)
{
sand = ItemWrapper.getItemStack(12, 16, 0);
if(player.hasItem(sand))
{
player.consumeItemAmount(sand);
player.giveItem(ItemWrapper.getItemStack(20, 16, 0));
player.getSkill('crafting').addXP(160.0);
}
}
//The player can cast this spell if they have at least 16 sand blocks in their inventory
function shouldSpellBeCast(player, staff, world)
{
return player.hasItem(ItemWrapper.getItemStack(12, 16, 0));
}
//Award 87 magic exp for casting this spell
function getExp()
{
return 87.0;
}