UODiamondCodex

Auto-generated from server/scripts/UOD/ by codex/scripts/generate-reference.mjs — do not edit by hand; re-run the generator.

Functions & Commands

306 custom [FUNCTION] definitions. Functions are callable as commands (e.g. .<name>) or invoked from scripts/triggers.

Custom Guildstones

Function Description
f_gmotd Sets the guild message of the day.
f_set_gmotd Prompts for and sets the guild message of the day.
glist Lists your guild's online members.
gmotd Shows your guild's message of the day.
gmsg Sends a message to your online guildmates.
gpanic Sends a panic / help alert to your guild.
gwhere Shows where your online guildmates are.
returnguild Returns your guild name (or N/A).
RETURNMASTER Returns a stone's guild master or town name.

Custom Stones

Function Description
f_check_pvm Records a player's PvM score into the top-10 leaderboard.
f_check_pvm Records a player's PvM score into the top-10 leaderboard.
f_check_pvp Records a player's PvP score into the top-10 leaderboard.
f_check_pvp Records a player's PvP score into the top-10 leaderboard.
f_check_statistics Updates the "most X" record-holder statistics stone.

Custom Types

Function Description
f_newshrink Shrinks a targeted tamed creature into a statue item.
newshrink Targets a tamed creature to shrink into a statue.

Death Menu

Function Description
closest_shrine Finds the shrine nearest the death spot (Felucca).
closest_shrine_xtra Finds the nearest shrine on the extra (non-Felucca) maps.
closest_town Finds the town nearest the death spot (Felucca).
closest_town_xtra Finds the nearest town on the extra maps.
f_closest Builds the death-menu resurrection destinations, then opens it.

Dialogs

Function Description
ADDREG Targets a reagent to add into a reagent book.
F_ADDREG Stores a targeted reagent into a reagent book.
f_security_answer Stores your account security answer.
f_security_question Stores your security question, then asks for the answer.
f_security_verify Challenges a login from a new IP with the security question.
f_security_verify_answer Checks the security answer to unlock a new-IP login.
GETREG Withdraws reagents from a reagent book.

Events

Function Description
pvppvm Saves a player's PvP/PvM points to the database.

Events/Event Bomberman

Function Description
bomber_checkwinner Counts the players still alive in the Bomberman event.
bomber_win Awards the Bomberman winner their prize and sends them home.
bomberjoin Command to join the automated Bomberman event.
ENDEVENT_BMAN Returns Bomberman gear and sends the player home.
f_bomber_join Kits out and teleports a player into the Bomberman arena.
f_bomber_remove Removes Bomberman props and powerups from the arena.
f_bomber_respawn_crate Randomly respawns a crate in the Bomberman arena.
f_GENERATE_ARENA_BOMBER Randomly builds the Bomberman arena rocks and crates.
f_givebomb Gives a player a bomb and brief invulnerability in Bomberman.
f_start_bomber Starts the Bomberman round and arms all players.
f_startautobomber Announces and schedules an automated Bomberman event.
nextbomber Tells you when the next Bomberman event starts.
togglefencebomber Raises or removes the Bomberman arena fence.

Events/Event FFA

Function Description
endevent Returns an FFA fighter's equipment from the holding bag.
f_ffa_join Kits out and teleports a player into the FFA arena.
f_ffa_remove Removes leftover items when clearing the FFA arena.
f_generate_arena Randomly builds the FFA arena walls.
f_start_ffa Starts the FFA round.
f_startautoffa Announces and schedules an automated FFA tournament.
ffa_checkwinner Counts the players still alive in the FFA event.
ffa_win Awards the FFA winner their prize and restores them.
ffajoin Command to join the automated FFA tournament.
nextffa Tells you when the next FFA tournament starts.
togglefenceffa Raises the FFA arena fence.

Events/Event Tourney

Function Description
checkregs Consumes and restocks a fixed set of tournament reagents.
doicome_arena1 Sends a tourney duelist into arena 1 and readies them.
doicome_arena2 Sends a tourney duelist into arena 2 and readies them.
end Returns a tourney fighter's equipment from the holding bag.
togglefence Raises or removes the tourney arena fence.
tourneyrestore Fully restores a tourney fighter (cure/heal/mana).

Events/Monster Bash

Function Description
bashres Auto-resurrects a dead player inside the Monster Bash event.

Events/Monster Defense

Function Description
end_event Clears NPCs and resets the Monster Defense stone.
md_goback Schedules the end of a Monster Defense run.
md_goback_go Ends a Monster Defense run, rewards, and sends to the jail hub.

House Commands

Function Description
DELETEALL Removes every non-multi item and NPC inside a house region.
HOUSEPLACEMENT Finalizes house placement and assigns ownership.
HOUSETARGET Runs the chosen house-menu action (add friend, lock down, secure, eject, ban…) on the target.
isbanneduid Returns 1 if a UID is banned from the house.
iscoowner Returns 1 if you are a co-owner of the house.
iscoowneruid Returns 1 if a UID is a house co-owner.
isfriend Returns 1 if you are a friend of the house.
isfrienduid Returns 1 if a UID is a house friend.
isowner Returns 1 if you own the house.
isowneruid Returns 1 if a UID owns the house.
NOTBUILDABLE Returns 1 if a house cannot be placed at the spot.
redeed Turns a placed house multi back into its deed.
redeed_house Redeeds your house after running safety checks.
rename_house Renames your house.
returnstate Returns a random house-relationship label (demo).
returntime Formats an elapsed time as days/hrs/mins.
REWRITE_COOWNERS Compacts the house co-owner list.
REWRITE_FRIENDS Compacts the house friends list.

Item Bandage

Function Description
checkfordist Equips a distance-check timer item while bandage healing.
healskillgain Rolls a Healing skill gain while bandaging.
newresurrect Equips a resurrection memory on a character (bandage rez).

Item Runebook

Function Description
f_addcharges Adds recall-scroll charges to a runebook.

Moongates

Function Description
Goto Travels via a travel stone for a 100gp fee.

Player Functions

Function Description
bind Sets your home/recall location to your current spot.
drink Uses a potion from your pack by number (.drink command).
email Sets or shows your account's email address.
EVENT The .event command: join events, or (staff) configure the current event.
F_CHECKBUY Flags a rancher/trainer vendor to restock animals.
F_CHECKSALES Schedules a vendor's post-sale restock cooldown.
f_eventname Stores the staff-entered event description.
f_lootme Instantly moves your corpse's loot into your backpack.
f_setitems Binds a pack item to one of your .useitems slots.
fixme Unsticks your character by bouncing through the holding map.
healer Points a dead player toward the nearest healer.
lootme Targets your corpse to instantly loot it.
online Opens the "who's online" web page.
powerhour Shows the time until power hour starts or ends.
regs Opens the reagent-book dialog.
renamebag Targets a bag to rename.
renamebag_f Renames the targeted bag.
security Opens the account security dialog.
SETITEMS Binds a pack item to a .useitems slot (1–5).
toggledetail Toggles item detail tooltips.
USEITEMS Uses (or lists) a bound .useitems slot.
vote Casts a daily vote for the shard (opens the vote page).

Player Items

Function Description
f_bluecream Applies armor cream to boost a piece of armor once.
f_comodity Fills or retrieves items from a commodity deed.
F_HAT_MAGIC Names a magic hat after its random +5% skill bonus.

Prefered

Function Description
prefered_item Buys a "preferred" reward item with privilege points and gold.
prefered_item_1 Preferred-item purchase variant (single-charge item).
prefered_npc Buys a "preferred" reward NPC with privilege points and gold.

PvP/Britain PvP

Function Description
EXITRANDOM Cures, heals and ejects a player from the Britain PvP arena.
PVPBRITAIN_TIMEOUT Times out a lone Britain PvP duelist.
PVPBRITAINGO_FIRST Puts the first duelist into the Britain PvP arena.
PVPBRITAINGO_SECOND Puts the second duelist in and starts the duel.
RAISEWALL Raises stone walls around a PvP duelist.
UNRAISEWALL Removes the raised PvP walls.

Quests/Champion System

Function Description
ENTERCHAMPION Stores a player's gear and skills, then enters the Champion gauntlet.
FIXCHAMPIONSPAWN Tunes champion spawn timers and corpse decay.

Quests/Quest - Khardlin Altar

Function Description
returnaltar Returns how many Khardlin altars you haven't yet done.

Quests/Quest - The Maze

Function Description
f_reset_maze Cleans up maze props when resetting the Maze quest.

Server Functions

Function Description
4454 Clears the movement flag on stray worldgem bits (map cleanup helper).
ADDAGRESSOR Attaches a "harmed by" memory linking an aggressor, for combat tracking.
addtele Spawns a teleporter pad with a sparkle effect at your feet (admin).
afkmessage Prompts for an away-from-keyboard auto-reply to hand out to players.
AOSDMG Announces overkill damage dealt beyond a target's remaining hits.
armorset Spawns a full colored platemail armor set into a character's pack.
cantcastallspells Returns 1 if the character cannot cast every spell (1–64).
checkallgold Logs a character's name and gold total (debug).
CHECKCLIENTVERSION Forces a client-version dialog on players not on 4.0.1.
cls Clears the screen by printing blank system messages.
DELAY Sets a named cooldown timer on a character or item.
do_logout Starts the logout linger sequence, then moves the char off-world.
do_logout_guard Faster logout linger used in guarded areas.
do_logout_map Moves an offline character onto the holding map.
dof Randomly returns the arg or its female "_f" variant.
f Spawns a forge and anvil at your feet (admin smithing helper).
f_afkmessage Targets who receives your AFK auto-reply.
f_afkmessage2 Delivers your AFK auto-reply to the targeted player.
f_fix_hanging Nudges a stuck monster during a monster event.
f_fix_spawns Removes duplicated crafter spawns so they respawn.
f_fixworld Fixes item attrs/types across the world (immovable, doors, fire…).
f_generate_table Spawns a large set of decorative furniture items (setup helper).
f_generate_table_item Spawns one item into your pack (helper for f_generate_table).
F_MONSTER_SETUP Tags an NPC as an event monster.
f_respawn_vendors Removes town-vendor NPCs so they respawn.
f_respawnmobs Removes a spawned mob so its spawner recreates it.
F_SENDMAIL_BUG Emails a player's bug report to the admins.
F_SENDMAIL_SUGG Emails a player's suggestion to the admins.
f_sendpage Files a GM page / help request.
f_verification Checks an account activation code to unlock the character.
F_WIPE Resets a player: skills, gear, gold and starter kit (wipe).
fix_hanging Sweeps the world to unstick hanging monsters.
fix_spawns Sweeps the world to fix duplicated crafter spawns.
FIXCHECK Turns all bank-check items inert (script type).
fixregs Logs spell/reagent mismatches (debug).
FIXWORLD Sweeps the world applying the f_fixworld fixes.
FIXWORLDITEMCOLOR Recolors every instance of a given item id.
givegold Spawns gold (splitting into 64k stacks) into a pack.
giveto Targets an item to give to another player.
giveto_f Targets the recipient for the giveto command.
giveto_f2 Moves the chosen item into the recipient's pack.
ischarvisible Returns 0 if a character is hidden/invisible.
isdamflag Tests a damage-type flag bitmask.
ISGUARDED Returns "Yes"/"No" for whether the region is guarded.
ISGUARDEDCOLOR Returns green/red for a region's guarded state.
isharmedby Returns 1 if a character was harmed by a given UID.
ISMAGICAL Returns Yes/No for an item's magic attribute.
ISMOVABLE Returns 0 if an item cannot be moved.
ISNEWBIE Returns 1 if an item has the newbie flag.
ISNEWBIEB Returns Yes/No for an item's newbie flag.
ISREGIONINVUL Returns 1 if the region is a safe/invulnerable zone.
ISVISIBLE Returns 0 if an item is invisible.
mcolor Sends an overhead message in a chosen hue.
mduel Sends a message in the duel hue.
merror Sends a message in the error hue.
mfriends Sends a message in the friends hue.
mguild Sends a message in the guild hue.
mhouse Sends a message in the house hue.
minfo Sends a message in the info hue.
mitem Sends a message in the item hue.
moveback Steps the character back one tile, opposite its facing.
mskills Sends a message in the skills hue.
msocket Sends a message in the socket hue.
mspecial Sends a message in the special hue.
mstone Sends a message in the stone hue.
mvendor Sends a message in the vendor hue.
newitemcontpack Spawns an item into your backpack.
newitempack Spawns an item into a character's pack.
NOACCENTS Strips accented characters from a string.
NPC_DISTRIBUTE_PVM_POINTS Awards PvM points to a slain monster's attackers.
NPCVENDORSETUP Sets up a standard shop-vendor NPC.
opendoor Opens the nearest door.
paysound Plays the gold / payment sound.
refresh Restores hits/mana/stam (by arg) to max.
refreshall Restores hits, mana and stamina to max.
rename Prompts to rename an item you're carrying.
rename_this Applies the new name to the item being renamed.
replacetile Swaps one item id for another.
respawn_vendors Sweeps the world to respawn town vendors.
respawnmobs Respawns every mob in the region.
RETURN_ARGV0 Returns its first argument.
RETURNMEMBERS Returns a stone's member count.
RETURNSHIELDAR Returns a shield's armor value.
scolor Sends a system message in a chosen hue.
SENDMAIL_BUG Prompts for a bug report to email the admins.
SENDMAIL_SUGG Prompts for a suggestion to email the admins.
sendpage Files a help page (requires an email on file).
sendto Targets an item to move somewhere (admin).
sendto_f Targets the destination for the sendto command.
sendto_f2 Moves the chosen item to the targeted spot.
SENDTOSHIP Teleports a character onto a ship.
shipfix Rebuilds a ship's planks, tiller and hatch after a move.
spawnanim Spawns a small animated spawner effect (admin).
spawnmon Spawns a single-monster spawner.
spawnride Spawns a rideable-creature spawner.
spawnthis Spawns a custom spawner from arguments.
ssocket Sends a system message in the socket hue.
starget Opens a targeting cursor with a prompt.
sysauction Sends a system message in the auction hue.
sysbandage Sends a system message in the bandage hue.
syschat Sends a unicode bridge-chat system message.
sysduel Sends a system message in the duel hue.
syserror Sends a system message in the error hue.
sysfriends Sends a system message in the friends hue.
sysgm Sends a system message in the GM hue.
sysguild Sends a system message in the guild hue.
syshouse Sends a system message in the house hue.
sysinfo Sends a system message in the info hue.
sysitem Sends a system message in the item hue.
sysskills Sends a system message in the skills hue.
sysspecial Sends a system message in the special hue.
sysstone Sends a system message in the stone hue.
system_colors Reference list defining each system-message hue.
sysvendor Sends a system message in the vendor hue.
test_colors Prints test messages in random hues (debug).
transfer Transfers pet ownership via a memory item.
UODWIPE Wipes every character on every account (admin).
UPTIME Returns the server uptime.
VENDORLIST Exports all vendors to a CSV file (admin).

System Bounty

Function Description
f_add_bounty Records a new bounty on the bounty stone.
f_isinbounty Returns 1 if a character is on the bounty list.

System Friends

Function Description
addfriend Adds a character to your personal friends list (first free slot 1–10).
clearfriends Wipes all 10 slots of your friends list.
F_CHECK_FRIEND_SANITY Purges deleted characters from your friends list.
fa Command to add a friend.
fixfiends Backfills friend slots 6–10 on existing friend items.
fl Lists your friends and their online status.
fm Messages all of your friends.
fm1 Messages your friend #1.
fm10 Messages your friend #10.
fm2 Messages your friend #2.
fm3 Messages your friend #3.
fm4 Messages your friend #4.
fm5 Messages your friend #5.
fm6 Messages your friend #6.
fm7 Messages your friend #7.
fm8 Messages your friend #8.
fm9 Messages your friend #9.
fr Removes friend #N from your list.
friend_login Notifies your friends that you logged in.
friend_logoff Notifies your friends that you logged off.
friendfix Logs your friend-list slots (debug).
friendgetmessage Delivers a friend chat message to you.
friendgetmessagelog Delivers a friend login/logout notice to you.
friends Shows the friends-system command help.
isfriendfull Returns 1 if your friends list is full.
numberreturnfriend Returns the UID in your friend slot #N.
onlinestate Returns a friend's formatted online/offline status.
removefriend Clears a specific UID from your friends list.
returnfriendnumber Returns the slot number of a friend UID.

System Lights

Function Description
ResetLights Resets dungeon and area light levels.

System Newbie

Function Description
newbie Removes your temporary newbie protection.
setnewbie Grants 72h of newbie protection.

System Poison

Function Description
F_POISON Targets a weapon to poison with the poisoning skill.
F_POISON_DO Applies poison from a potion onto the targeted weapon.

System Sacrifice

Function Description
f_sac Validates and sacrifices a targeted corpse for a reward.
sac Targets a corpse to sacrifice for a reward.

System Shout

Function Description
f_staff Broadcasts a staff-only chat message.
sh Shortcut to shout.
shout Broadcasts a shout to everyone (with bans and cooldowns).
shoutoff Turns off receiving shouts.
shouton Turns on receiving shouts.
show_shout Displays an incoming shout unless you've muted them.
staff Broadcasts a staff chat to all clients.

System Stuck

Function Description
stuck Frees a stuck player, sending them back to town.

System Treasure Chests

Function Description
FIXTCHEST Removes all treasure chests.

System Vendors

Function Description
f_initvendor Initializes a player-owned vendor NPC.
f_setdefaultprice Puts a vendor item (or container) up for sale.
f_unsetdefaultprice Takes a vendor item (or container) off sale.
f_vendor_opencontainers Opens a vendor's sale containers.
f_vendor_SalesCount Counts the items across a vendor's sale slots.
f_vendor_setprice Prompts an owner to set a vendor item's price.
price_this_item Sets the price on a player-vendor sale item.
rename_this_vendor Applies the new name to your vendor.
rename_vendor Prompts to rename your vendor.
vendor_isadmin Returns 1 if a player may administer the vendor.
vendor_transfer Transfers vendor ownership via a memory item.

Town Stones

Function Description
uod_addmember Adds a member to a town stone.
uod_ismember Returns 1 if a character is a town-stone member.
uod_removemember Removes a member from a town stone and compacts the list.
UOD_TOGGLEABBREV Toggles the town abbreviation shown after your name.
uod_townstone_init Initializes a town stone's tags.