Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
S
 Sample Config File
 saveas(<filename$>), map[]
 Scope
 search(<value>,<start>), <name>[].<fieldtype>[]
 search_object
 search_persona
 search_player
 search_replica
 search_replica_room
 search_replica_room@
 search_room
 search_verb
 second, game
 send_memory
 send_prompt
 Sending colored output
 Sending MXP Tags
 Set Config Options
 shift
 shift$
 size
 sort@
 split@
 splitc@
 SQL Functions
 stamp2time
 Statement Termination
 stats$, game
 status, node[]
 String Functions
 string$
 switch..case..break
 system
T
 Task Functions
 taskobject, game
 Tasks
 tasks$, game
 The Key File
 The main()Procedure
 The Preprocessor
 tick, game
 time, game
 time2stamp$
 timeout, game
 timestamp$, game
 Transport Protocol
 ttype@, node[]
 Tutorial
 Types
U
 unshift
 upper$
 User Defined Databases
 Using Databases
 utick, game
V
 val
 valid, map[]
 valid_message
 valid_task
 Variables
 Vector Functions
 Verbs
W
 wait_for_input
 weekday, game
 while..do
 width
 words
 words$
 words@
X
 XTerm 256 Colors
 xterm256, node[]
Y
 y[<y>], map[].x[<x>]
 year, game
Write the map into the given file.
Each variable has a specified scope when it is declared.
This allows you to search the database for a given value, starting with the record immediately following the specified start record.
Find an object with the given name.
Find a persona with the given name.
Find an online player with the given name.
Locate a replica using an object name.
Search for a replica in a given room, with a given object.
Search for a replica in a given room, with a given object.
Find a room with the given name.
Lookup a potential command and return its numeric verb handle.
This returns the current second (0-59).
Quickly write the contents of a memory block to a node.
Send some text to a node followed by the prompt sentinel.
While it is possible to send colored output to a node by manually crafting the escape sequence in game code, Rapture provides two recommended methods of displaying colored output.
To send an MXP tag, surround the MXP tag text with the ASCII characters ETX and EOT (characters with byte values 3 and 4, respectively).
To set the options via a config files, simply create an empty text file (using your favorite text editor) and set the options, one per line.
Remove the first element in a vector and return its value as an integer.
Remove the first element in a vector and return its value as a string.
Get how many elements are in the vector.
Sorts the vector using string comparison.
Break a string into parts using a substring delimiter.
Separate a string using a set of character delimiters.
The SQL functionality for the time being is limited only to MySQL connectivity.
Convert a ‘timestamp’ string into a UTC (universal coordinated time) seconds from Epoch value.
Statements are much like they are in any modern programming language.
This provides an informational string describing the internal state and statistics of the Rapture engine at runtime.
Each node has a status associated with it.
This returns the value of an integer as a string.
Test a single variable for multiple possible values, allowing for the value of the variable to control program flow through one or more blocks of code.
Shell out to the system and execute a command.
When a task is called, this is set to the value provided when the task was scheduled.
Yet another form of special subroutine.
This provides an up-to-date listing of all currently scheduled tasks and when they are due to fire.
Upon startup, the Rapture Runtime Environment looks for a valid key file in the current directory named rapture.key (or elsewhere if the KeyFile option has been specified).
In order to tell Rapture where to begin executing, you provide a subroutine named main() in your executable somewhere, Rapture finds this and begins execution there.
The pre-processor is the first stage of the compilation process.
This returns the current tick value (a tick occurs every 1/100th of a second) since Rapture was started.
This returns the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds.
Convert a UTC seconds value into a timestamp representation.
This is the value (in seconds) that Rapture will allow an executable to run before deciding the code is in an infinite loop and generating an error.
This returns a string describing the current date and time in the format: “YYYY/MM/DD HH:MM:SS”.
This protocol needed to be compliant and invisible to existing TELNET standards because the primary client of choice is still simply a TELNET-compatible one (such as ZMud).
Stores the terminal types the client supports.
To be done...
Rapture has three built in data types currently (ignoring the types in databases).
Insert a new integer on the front of a vector.
Make an uppercase copy of a string.
Databases are specific resources that are dedicated purely to holding data and searching the database for specific values.
Returns the current microsecond (0-999999).
Return the numeric value of a string.
This indicates that the map has been created with map.new() and has not been deleted.
Check whether a compiled message number is valid (exists).
Checks whether a task with the given name has been defined.
Variables store data.
Verbs are special forms of subroutines.
Wait until some input or node activity is detected.
This returns the current day of the week (0-6, 0=Sunday).
A pre-condition looping construct.
Return the width of the map (read-only).
Width specifies how many characters to send on a line before performing automatic word wrapping of output.
Return the number of words in a string.
Extract one or more words from a string.
Extract the words of a string into a vector.
As of version 2.3.4, Rapture supports the 256-color extension to the ANSI colors standard, allowing a MUD server to send control codes to a user’s client to display more than the 16 standard ANSI colors.
256-color support has been enabled for this node.
Access one element of the map using two dimentional coordinates.
This returns the current year.