From OtherSpace: Encyclopedia Galactica
(→Borders) |
(→Colors) |
||
| Line 38: | Line 38: | ||
===Colors=== | ===Colors=== | ||
| − | + | All colors must be [[ANSI]] codes compatible with the MUSH. It's possible to use [[MXP]] colors as well, but that isn't supported by the room parent at this time. | |
| − | :COLOR`BORDER | + | |
| − | :COLOR`ROOMNAME | + | *COLOR`BASE |
| − | :COLOR`ZONENAME | + | :The Background / Default Ansi Color used for the entire room description. Background colors might not work consistently for all players, depending on their client and settings. |
| − | :COLOR`DBREF | + | *COLOR`BORDER |
| − | :COLOR`DESC | + | :Color used for all borders which do not have a specific color set using BORDER`_COLOR_X. Useful if you want all borders to be the same color, since you don't have to set each one individually. |
| − | :COLOR`TAG | + | *COLOR`ROOMNAME |
| − | :COLOR`NOTE | + | :Color used for the name of the Room, in the first line of the description. |
| − | :COLOR`TIME | + | *COLOR`ZONENAME |
| − | :COLOR`LABELS | + | :Color used for the name of the Zone, in the first line of the description. |
| − | :COLOR`PLAYERNAME | + | *COLOR`DBREF |
| − | :COLOR`PLAYERTITLE | + | :Color used for the room's DBREF, which is shown to staffer characters. |
| − | :COLOR`THINGNAME | + | *COLOR`DESC |
| − | :COLOR`THINGTITLE | + | :Color used for the text Description of the room. |
| − | :COLOR`ADDON | + | *COLOR`TAG |
| − | :COLOR`EXITNAME | + | :Color used for any Tag set on the room. |
| − | :COLOR`EXITALIAS | + | *COLOR`NOTE |
| − | :COLOR`EXITBRACKET | + | :Color used for any Note set on the room. |
| − | :COLOR`MODE_RP | + | *COLOR`TIME |
| − | :COLOR`MODE_NEW | + | :Color used for the Time display, immediately below the body of the description. |
| − | :COLOR`MODE_ADMIN | + | *COLOR`LABELS |
| − | :COLOR`MODE_DARK | + | :Color used for the Objects: and Exits: labels in the room content list. |
| + | *COLOR`PLAYERNAME | ||
| + | :Color used for the names of players in the room. | ||
| + | *COLOR`PLAYERTITLE | ||
| + | :Color used for the title of players; by default, will be the same as the name color. | ||
| + | *COLOR`THINGNAME | ||
| + | :Color used for the name of objects in the room. | ||
| + | *COLOR`THINGTITLE | ||
| + | :Color used for the Title of objects in the room (if they have any). | ||
| + | *COLOR`ADDON | ||
| + | :Color used for the Addon of any players/objects. | ||
| + | *COLOR`EXITNAME | ||
| + | :Color used for the name of exits in the room. | ||
| + | *COLOR`EXITALIAS | ||
| + | :Color used for the alias of exits in the room; by default, same as the name. | ||
| + | *COLOR`EXITBRACKET | ||
| + | :Color used for the Bracket <> characters on either side of the alias. | ||
| + | *COLOR`MODE_RP | ||
| + | :Color used for the <RP> tag when characters are IC. | ||
| + | *COLOR`MODE_NEW | ||
| + | :Color used for the <NEW> tag on guests and unregistered characters. | ||
| + | *COLOR`MODE_ADMIN | ||
| + | :Color used for the <ADM> tag on staffer characters. | ||
| + | *COLOR`MODE_DARK | ||
| + | :Color used for the <DK> tag on dark players / objects / exits. Only visible to staffers. | ||
===Time=== | ===Time=== | ||
Revision as of 22:04, 4 September 2011
Otherspace uses a custom room parent with lots of configurable options. These can be changed on a per-room basis by setting attributes directly on the room, or across a group of rooms using parenting chains.
Contents
List of Room Parents
- #3 - Basic Room Parent, which all rooms are parented to by default.
- #33 - Hiverspace Room Parent, currently identical to the basic parent.
- #34 - Palisade Room Parent, with the Chiarascuro color scheme.
- #333 - Normalspace V1 Room Parent, with the Variant 1 Color Scheme.
Basic Formatting Options
General
- DESC`ZONE
- The Zone Name for the room, which will be displayed in the top bar following the Room Name (using the formatting in FORMAT`ZONE)
- DESC`ALIGN
- The Alignment that will be used for text in the body of the description. This is LEFT aligned by default; you can change it to RIGHT or CENTER in
- DESC`SORT
- The Sort Type that will be used for the Player, Thing, and Exit lists. By default, this is a NAME sort. Other options are as in help sorting. Regardless of the sort type, the room will show Players first, then Objects.
- DESC`NOTE
- A note set on the room, which will be displayed in a highlight color underneath the description itself.
Borders
Settings for Horizontal (Top, Bottom, Middle) and Vertical (Left, Right) borders.
- Top Horizontal Border
- BORDER`STRING_T - Fill String
- BORDER`COLOR_T - Ansi Color
- Bottom Horizontal Border
- BORDER`STRING_B - Fill String
- BORDER`COLOR_B - Ansi Color
- Middle Horizontal Border
- BORDER`STRING_M - Fill String
- BORDER`COLOR_M - Ansi Color
- Left Vertical Border
- BORDER`STRING_L - Fill String
- BORDER`COLOR_L - Ansi Color
- Right Vertical Border
- BORDER`STRING_R - Fill String
- BORDER`COLOR_R - Ansi Color
Colors
All colors must be ANSI codes compatible with the MUSH. It's possible to use MXP colors as well, but that isn't supported by the room parent at this time.
- COLOR`BASE
- The Background / Default Ansi Color used for the entire room description. Background colors might not work consistently for all players, depending on their client and settings.
- COLOR`BORDER
- Color used for all borders which do not have a specific color set using BORDER`_COLOR_X. Useful if you want all borders to be the same color, since you don't have to set each one individually.
- COLOR`ROOMNAME
- Color used for the name of the Room, in the first line of the description.
- COLOR`ZONENAME
- Color used for the name of the Zone, in the first line of the description.
- COLOR`DBREF
- Color used for the room's DBREF, which is shown to staffer characters.
- COLOR`DESC
- Color used for the text Description of the room.
- COLOR`TAG
- Color used for any Tag set on the room.
- COLOR`NOTE
- Color used for any Note set on the room.
- COLOR`TIME
- Color used for the Time display, immediately below the body of the description.
- COLOR`LABELS
- Color used for the Objects: and Exits: labels in the room content list.
- COLOR`PLAYERNAME
- Color used for the names of players in the room.
- COLOR`PLAYERTITLE
- Color used for the title of players; by default, will be the same as the name color.
- COLOR`THINGNAME
- Color used for the name of objects in the room.
- COLOR`THINGTITLE
- Color used for the Title of objects in the room (if they have any).
- COLOR`ADDON
- Color used for the Addon of any players/objects.
- COLOR`EXITNAME
- Color used for the name of exits in the room.
- COLOR`EXITALIAS
- Color used for the alias of exits in the room; by default, same as the name.
- COLOR`EXITBRACKET
- Color used for the Bracket <> characters on either side of the alias.
- COLOR`MODE_RP
- Color used for the
- COLOR`MODE_NEW
- Color used for the <NEW> tag on guests and unregistered characters.
- COLOR`MODE_ADMIN
- Color used for the <ADM> tag on staffer characters.
- COLOR`MODE_DARK
- Color used for the <DK> tag on dark players / objects / exits. Only visible to staffers.
Time
- TIME`ZONE
- TIME`YEAR
- TIME`CALENDAR
Advanced Formatting Options
- FORMAT`BODY
- FORMAT`TIME
- FORMAT`VOBJ
- FORMAT`CONTENTS
- FORMAT`PLAYER
- FORMAT`THING
- FORMAT`EXIT
- NAMEFORMAT
- DESCFORMAT
- CONFORMAT
- EXITFORMAT
Obsolete Formatting Options
- DESC`BODY
- The test of the description, i.e. the description itself. This is obsolete - it still works (as does &desc1) but the code has been moved int descformat, allowing the room to be @desced as normal.
- DESC`TAG
- The Tag set on the room. Don't change this manually, or you'll break future tags. Use the &tag attribute, or the +tag command instead.