Room Program Commands

Room programs have access to 157 commands. Most are shared with other script types and are documented in the Shared Commands Reference. This page provides a brief index of all shared commands with links, plus full documentation for room-specific behavior.

All commands use the room prefix: room echo, room transfer, room alterexit, etc.

Table of Contents

Comments in scripts use the ** prefix. Place comments on their own line:

** This is a comment
room echo This is a command.

Commands Not Available to Rooms

The following commands exist for other entity types but are not available in room programs:

Command Available To Why Not Room
appear mob Mob visibility toggle
assist mob Mob combat join
cast mob, obj Mob/obj spellcasting
disappear mob Mob visibility toggle
gdamage mob, obj, token Group damage
goto mob, obj, token Entity self-movement (rooms don’t move)
hunt mob Mob tracking AI
junk mob, obj, token Inventory destruction (rooms have no inventory)
kill mob Mob combat initiation
makeinstanced instance, dungeon Instance conversion
quest mob Quest system (use questaccept etc. instead)
raisedead mob, token Resurrection
scriptwait mob, obj, token Script pause
selfdestruct mob, obj Self-destruction (rooms persist)
stageevent mob Event staging
teleport mob Teleport all in room (use transfer instead)
wildsanchor mob Wilderness anchor
wildsvlink mob Wilderness virtual link

Room-Specific Command Behavior

Several shared commands have special behavior or are particularly relevant when used in room programs.

alterexit 

room alterexit <direction> <field> <value>

Modify properties of a room exit. This is one of the most important room prog commands for puzzles, locked doors, and dynamic pathways.

Directions: north, south, east, west, up, down (or n, s, e, w, u, d)

Fields:

Field Description Example Values
door Door state open, closed, locked
flags Exit flags isdoor, closed, locked, hidden, nopass
key Key vnum required Object vnum
dest Destination room Room vnum
name Exit name/keyword Text string

Examples:

** Open the north door
room alterexit north door open

** Lock the south door
room alterexit south door locked

** Create a hidden exit
room alterexit east flags hidden

** Change where east leads
room alterexit east dest 3500

alterroom 

room alterroom <field> <value>

Modify properties of the current room.

Fields:

Field Description Example Values
flags Room flags dark, norecall, nomob, safe, indoors
sector Sector/terrain type inside, city, forest, water, air
name Room name/title Text string
desc Room description Text string
heal HP regen modifier Numeric value
mana Mana regen modifier Numeric value

Examples:

** Make the room dark
room alterroom flags dark

** Change sector to underwater
room alterroom sector underwater

** Set a custom room name
room alterroom name {CThe Crystal Chamber — Illuminated{x

room link <direction> <destination_vnum>

Create or modify an exit linking this room to another. Room programs have a dedicated handler for this command.

Example:

** Open a new passage east
room link east 3500
room echo {GA hidden passage reveals itself to the east!{x

cloneroom 

room cloneroom <source_vnum>

Create a dynamic clone of a room template. Used in dungeon and instance systems for procedural generation.

Example:

room cloneroom 5000

destroyroom 

room destroyroom <vnum>

Remove a dynamically created (cloned) room. Only works on rooms created with cloneroom.

resetroom 

room resetroom [room_vnum]

Reset a room to its default template state. Without a vnum, resets the current room.

Example:

** On area reset, restore the puzzle room
room resetroom

purge 

room purge [target]

Remove entities from the room. Without a target, purges all non-player entities. With a target, purges the matching mob or object.

Examples:

** Remove all mobs and objects
room purge

** Remove a specific mob
room purge guard

** Remove a specific object
room purge rusty_key

altermob 

room altermob <target> <field> <value>

Modify properties of a mobile in the room. Room programs have a dedicated handler for this.

remove 

room remove <target> <object>

Remove (unequip and extract) an object from a character. Room programs have a dedicated handler.

group / ungroup 

room group <character1> <character2>
room ungroup <character>

Force grouping/ungrouping. Room programs have a dedicated group handler.

Shared Commands Quick Reference

All shared commands below work identically in room programs as in other script types. Each links to the full documentation in the Shared Commands Reference.

Output Commands

Command Syntax Description
echo room echo <message> Message to all in room
echoat room echoat <target> <message> Message to one character
echoaround room echoaround <target> <message> Message to all except target
echonotvict room echonotvict <victim> <message> Synonym for echoaround
echoroom room echoroom <vnum> <message> Message to a specific room
echobattlespam room echobattlespam <message> Combat-filtered message
echochurch room echochurch <message> Message to church members
echogroupat room echogroupat <target> <message> Message to target’s group
echogrouparound room echogrouparound <target> <message> Message to room except group
echoleadat room echoleadat <message> Message to group leader
echoleadaround room echoleadaround <message> Message to all except leader
gecho room gecho <message> Global message (all players)
zecho room zecho <message> Zone/area-wide message
asound room asound <message> Message to adjacent rooms
crier room crier <message> Town crier announcement
pageat room pageat <target> <message> Paged message to target
prompt room prompt <target> <text> Custom prompt display
mail room mail <player> <subject> <body> Send in-game mail
wiznet room wiznet <message> Message to immortals

Movement and Transfer

Command Syntax Description
transfer room transfer <target> [vnum] Move character to a room
gtransfer room gtransfer <target> <vnum> Move entire group to a room
otransfer room otransfer <object> <dest> Move object to location
at room at <vnum> <command> Execute command at another room
flee room flee Force flee from combat

Entity Loading and Destruction

Command Syntax Description
mload room mload <mob_vnum> Spawn a mobile in the room
oload room oload <obj_vnum> Load an object in the room
purge room purge [target] Remove entities from room
cloneroom room cloneroom <vnum> Clone a room template
destroyroom room destroyroom <vnum> Destroy a cloned room
resetroom room resetroom [vnum] Reset room to template
loadinstanced room loadinstanced <vnum> Load entity for instance
remove room remove <target> <obj> Unequip and extract object
usecatalyst room usecatalyst <char> <name> Consume a catalyst

Combat

Command Syntax Description
damage room damage <target> <amount> Deal direct damage
entercombat room entercombat <char1> <char2> Force two into combat
startcombat room startcombat <char1> <char2> Initiate combat
stopcombat room stopcombat <target> End combat for character
peace room peace Stop all combat in room
breathe room breathe <target> Breath weapon attack
rawkill room rawkill <target> Instant kill (no processing)
interrupt room interrupt <target> Interrupt casting/action
zot room zot <target> <amount> Divine punishment damage

Affects and Auras

Command Syntax Description
addaffect room addaffect <target> <skill#> [dur] [mod] Apply affect by skill number
addaffectname room addaffectname <target> <name> [dur] [mod] Apply affect by name
stripaffect room stripaffect <target> <skill#> Remove affect by skill number
stripaffectname room stripaffectname <target> <name> Remove affect by name
alteraffect room alteraffect <target> <idx> <field> <val> Modify existing affect
fixaffects room fixaffects <target> Recalculate all affects
addaura room addaura <target> <type> [power] Add aura effect
remaura room remaura <target> <type> Remove aura effect
applytoxin room applytoxin <target> <type> [severity] Apply poison/toxin

Entity Modification

Command Syntax Description
alterexit room alterexit <dir> <field> <value> Modify room exit
alterroom room alterroom <field> <value> Modify room properties
altermob room altermob <target> <field> <value> Modify a mobile
alterobj room alterobj <target> <field> <value> Modify an object
stringmob room stringmob <target> <field> <text> Change mob string fields
stringobj room stringobj <target> <field> <text> Change obj string fields
ed room ed <key> <description> Add/modify extra description
condition room condition <target> <value> Set condition/durability
link room link <dir> <dest_vnum> Create/modify exit link
lockadd room lockadd <dir\|obj> <key_vnum> Add a lock
lockremove room lockremove <dir\|obj> Remove a lock
setposition room setposition <target> <pos> Set character position
resetdice room resetdice <object> Reset dice values

Variables and Persistence

Command Syntax Description
varset room varset <name> <value> Set a variable
varseton room varseton <target> <name> <value> Set variable on entity
varclear room varclear <name> Clear a variable
varclearon room varclearon <target> <name> Clear variable on entity
varcopy room varcopy <old_name> <new_name> Copy variable
varsave room varsave <name> Persist variable to disk
varsaveon room varsaveon <target> <name> Persist variable on entity
persist room persist <name> <value> Mark variable persistent

Script Control and Timing

Command Syntax Description
call room call <script_vnum> [args] Call another script
xcall room xcall <target> <script> [args] Cross-entity script call
delay room delay <pulses> Set delay timer
cancel room cancel Cancel delay timer
queue room queue <pulses> <script> [args] Schedule delayed script
dequeue room dequeue Cancel queued events
input room input <command> Queue script input
inputstring room inputstring <raw_input> Queue raw input
settimer room settimer <name> <ms> Set countdown timer

Script Entity Management

Command Syntax Description
attach room attach <script_vnum> [args] Attach script to entity
detach room detach <script_vnum> Remove script from entity
remember room remember <target> Store target in memory
forget room forget Clear remembered target
showroom room showroom <player> <vnum> Show remote room description

Skills, Classes, and Traits

Command Syntax Description
addspell room addspell <target> <spell> Grant a spell
remspell room remspell <target> <spell> Remove a spell
grantskill room grantskill <target> <skill> Grant a skill
revokeskill room revokeskill <target> <skill> Revoke a skill
grantclass room grantclass <target> <class> Grant class access
revokeclass room revokeclass <target> <class> Revoke class access
grantsong room grantsong <target> <song> Grant a bard song
revokesong room revokesong <target> <song> Revoke a bard song
setclass room setclass <target> <class> Set character class
setclasslevel room setclasslevel <target> <class> <lvl> Set class level
setrace room setrace <target> <race> Set character race
settrait room settrait <target> <trait> <value> Set trait value
addtrait room addtrait <target> <trait> [value] Add a trait
adjusttrait room adjusttrait <target> <trait> <adj> Adjust trait value
removetrait room removetrait <target> <trait> Remove a trait
skimprove room skimprove <target> <skill> [amt] Trigger skill improvement

Character Resources and Economy

Command Syntax Description
award room award <target> <amount> <type> Award XP, gold, QP, etc.
deduct room deduct <target> <type> <amount> Deduct resources
chargebank room chargebank <target> <amount> Deduct from bank
wiretransfer room wiretransfer <from> <to> <amount> Transfer between accounts
restore room restore <target> Full HP/mana/move restore

Quest System

Command Syntax Description
questaccept room questaccept <target> <quest> Start a quest
questcomplete room questcomplete <target> <quest> Complete a quest
questcancel room questcancel <target> <quest> Cancel a quest
questgenerate room questgenerate <target> [template] Generate random quest
questscroll room questscroll <target> <quest> Create quest scroll
questpartcustom room questpartcustom <quest> <text> Custom quest objective
questpartgetitem room questpartgetitem <quest> <vnum> <qty> Collect item objective
questpartgoto room questpartgoto <quest> <location> Go-to-location objective
questpartrescue room questpartrescue <quest> <npc> Rescue NPC objective
questpartslay room questpartslay <quest> <mob> <qty> Slay mob objective
questsetindex room questsetindex <template> <step> Set quest step index

Dungeon and Instance

Command Syntax Description
spawndungeon room spawndungeon <vnum> [seed] Create dungeon instance
dungeoncommence room dungeoncommence <dungeon> Start dungeon encounter
dungeoncomplete room dungeoncomplete [dungeon] Mark dungeon completed
dungeonfailure room dungeonfailure [dungeon] Mark dungeon failed
instancecomplete room instancecomplete Mark instance completed
instancefailure room instancefailure Mark instance failed
checkpoint room checkpoint <vnum> Set dungeon checkpoint
sendfloor room sendfloor <floor> Dungeon floor transition
specialkey room specialkey <player> <key> [area] Create special key
unlockarea room unlockarea <area> Unlock a locked area
unlockdungeon room unlockdungeon <dungeon> Unlock a dungeon
loadinstanced room loadinstanced <vnum> Load instance entity

Events and World Systems

Command Syntax Description
event room event <op> <event_id> [params] Interact with events
startevent room startevent <event> Start a world event
stopevent room stopevent <event> Stop a world event
phaseevent room phaseevent <event> Advance event phase
reckoning room reckoning <op> [target] [value] Reckoning event system
startreckoning room startreckoning <type> [params] Start reckoning event
stopreckoning room stopreckoning Stop reckoning event

Player Management

Command Syntax Description
force room force <target> <command> Force character to act
gforce room gforce <leader> <command> Force entire group
vforce room vforce <mob_vnum> <command> Force all mobs of vnum
mute room mute <target> Silence a character
unmute room unmute <target> Un-silence a character
remort room remort <target> [class] Force remort
saveplayer room saveplayer <target> Force save to disk
showcommand room showcommand <target> <cmd> Display command output
group room group <char1> <char2> Force grouping
ungroup room ungroup <target> Force ungrouping

Appearance and Cosmetics

Command Syntax Description
fade room fade <target> Fade out effect
addstache room addstache <target> <type> Add cosmetic
remstache room remstache <target> Remove cosmetic

Wilderness

Command Syntax Description
wildernessmap room wildernessmap <op> [params] Wilderness map operations
wildsoverlay room wildsoverlay <name> [params] Apply tile overlay
wildstile room wildstile <x> <y> <type> Set wilderness tile
treasuremap room treasuremap <target> <map> [loc] Create treasure map

Religion and Commerce

Command Syntax Description
churchannouncetheft room churchannouncetheft <thief> <item> Announce theft
shop room shop <op> [params] Shop system operations
setrecall room setrecall <target> <vnum> Set recall point

Command Count Summary

Category Count
Output 19
Movement and Transfer 5
Entity Loading and Destruction 9
Combat 9
Affects and Auras 9
Entity Modification 13
Variables and Persistence 8
Script Control and Timing 9
Script Entity Management 5
Skills, Classes, and Traits 16
Character Resources and Economy 5
Quest System 11
Dungeon and Instance 12
Events and World Systems 7
Player Management 10
Appearance and Cosmetics 3
Wilderness 4
Religion and Commerce 3
Total 157