SATYR BUILDING & MOVEMENT MODULE GUIDE

Jon S. <jon@bzap.org>
April 3, 2020
http://www.centaur.pw/ | https://www.bzap.org/

INSTALLATION

	Before installing this module, change the #9 shown in the first three lines to the result of:
	
		;toobj(toint(max_object()) + 1)
	
	Below that, change the #10 to the result of:
	
		;toobj(toint(max_object()) + 2)

	To install, paste the full text of mod_build.v to the server while logged in as an administrator.
	
ABOUT THIS GUIDE

	Building & Movement Module - This module adds movement functionality to the database for all users
	and room builiding verbs for administrators.

	Required arguments are enclosed in arrow brackets <>.
	Optional arguments are enclosed in square brackets [].
	
ABOUT MODULES

	Module objects may be placed in a list-type property on a user object, $user.modules
	
	New server commands can be added to a module object as opposed to $admin and $user.

	Administrators can set modules for all and/or individual users.

	If the module is not found in a user's .modules property, the verbs on it will not work for that user.

USER COMMANDS

	NOTE: The movement commands, @look, and @selfdesc do not require this module to be
	listed in a user's .modules property. Only give administrators access to the module.

	north|south|east|west|northeast|northwest|southeast|southwest|up|down
	n|s|e|w|ne|nw|se|sw|u|d
	
		Move through an exit to another room.
		
	@look [object]
	
		By itself, shows the contents of a room, including users, objects and exits.
	
	@selfdesc <description>
	
		Set your description.

ADMINISTRATOR COMMANDS

	@build <name>

		Create a new room.

	@mkexit <full-direction> <destination-object>

		Create an exit in the room to another room. This automatically creates a return exit in <destination-object>
		pointing to the opposite of <full-direction>.
		The room object must exist before the exit is created.

	@rmexit <full-direction>

		Remove an exit in the room. This will not delete the object pointed to.

	@rdesc <description>

		Set the description of the current room.
		This affects the .desc property of that room.

	@desc <object> <description>

		Set the description of an object.
		This affects the .lookdesc property of that object.

FUNCTIONS

	#1:_look()
	
		Displays a description an object. Any object can have a custom _look().
	
	$room:_look()
	
		Displays a room's name, description and contents. Called by @look.
	
	$room:exits()
	
		Returns an array of exits from the room. Elements are object numbers to
		other rooms (or #-1 if nothing.)
	
	$room:notify_content()
	
		Displays a list of users and objects in the room. Called by $room:_look().
	
	$room:notify_exits()
	
		Displays a list of exits in the room. Called by $room:_look().
	
	$capital(str <string>)
	
		Returns <string> in all capital letters.
	
	$line(str <char>, int <length>)
	
		Returns a line <length> characters long composed of <char>.
		<char> should be a single character.