Difference between revisions of "Area File Layout"
(3 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
There are | There are 11 kinds of blocks: | ||
*The Area Header]] | *The [[Area Header|Area Header]] | ||
*The Helps Block]] | *The [[Help Record|Helps Block]] | ||
*The Mobiles Block]] | *The [[Mob Record|Mobiles Block]] | ||
*The Objects Block]] | *The [[Object Record|Objects Block]] | ||
*The Rooms Block]] | *The [[Room Record|Rooms Block]] | ||
*The Resets Block]] | *The [[STRINGS|Strings Block]] | ||
*The Shops Block]] | *The [[Reset Record|Resets Block]] | ||
*The Specials Block | *The [[Shop Record|Shops Block]] | ||
*The | *The Specials Block | ||
*The | *The Rspecs Block | ||
*The Triggers Block | |||
Line 24: | Line 25: | ||
An area file is laid out like this, then: | An area file is laid out like this, then: | ||
<nowiki># | [[Area Header|<nowiki>#AREA</nowiki>]] { 1 2} Author Area_Name~ F 1<BR><BR> | ||
[[Help Record|<nowiki>#HELPS</nowiki>]]<BR> | |||
help record 1<br> | help record 1<br> | ||
help record 2<br> | help record 2<br> | ||
Line 33: | Line 34: | ||
<nowiki>0 $~</nowiki><BR><BR> | <nowiki>0 $~</nowiki><BR><BR> | ||
<nowiki>#MOBILES</nowiki><br> | [[Mob Record|<nowiki>#MOBILES</nowiki>]]<br> | ||
mob record 1<br> | mob record 1<br> | ||
mob record 2<br> | mob record 2<br> | ||
Line 39: | Line 40: | ||
<nowiki>#0</nowiki> <BR><BR> | <nowiki>#0</nowiki> <BR><BR> | ||
<nowiki>#OBJECTS</nowiki><br> | [[Object Record|<nowiki>#OBJECTS</nowiki>]]<br> | ||
obj record 1<br> | obj record 1<br> | ||
obj record 2<br> | obj record 2<br> | ||
Line 45: | Line 46: | ||
<nowiki>#0</nowiki><BR><BR> | <nowiki>#0</nowiki><BR><BR> | ||
<nowiki>#ROOMS</nowiki><br> | [[Room Record|<nowiki>#ROOMS</nowiki>]]<br> | ||
room record 1<br> | room record 1<br> | ||
room record 2<br> | room record 2<br> | ||
Line 51: | Line 52: | ||
<nowiki>#0</nowiki><BR><BR> | <nowiki>#0</nowiki><BR><BR> | ||
<nowiki>#RESETS</nowiki><br> | [[STRINGS|<nowiki>#STRINGS</nowiki>]]<br> | ||
string record 1<br> | |||
string record 2<br> | |||
...<br> | |||
<nowiki>#0</nowiki><BR><BR> | |||
[[Reset Record|<nowiki>#RESETS</nowiki>]]<br> | |||
reset record 1<br> | reset record 1<br> | ||
reset record 2<br> | reset record 2<br> | ||
Line 57: | Line 64: | ||
S<BR><BR> | S<BR><BR> | ||
<nowiki>#SHOPS</nowiki><br> | [[Shop Record|<nowiki>#SHOPS</nowiki>]]<br> | ||
shop record 1<br> | shop record 1<br> | ||
shop record 2<br> | shop record 2<br> | ||
Line 66: | Line 73: | ||
specfun record 1<br> | specfun record 1<br> | ||
specfun record 2<br> | specfun record 2<br> | ||
...<br> | |||
S<BR><BR> | |||
<nowiki>#RSPECS</nowiki><br> | |||
rspec record 1<br> | |||
rspec record 2<br> | |||
...<br> | ...<br> | ||
S<BR><BR> | S<BR><BR> | ||
Line 72: | Line 85: | ||
trigger record 1<br> | trigger record 1<br> | ||
trigger record 2<br> | trigger record 2<br> | ||
...<br> | ...<br> | ||
S<BR><BR> | S<BR><BR> | ||
<nowiki>#$</nowiki> | <nowiki>#$</nowiki> | ||
[[Category:Area Development]] | [[Category:Area Development]] |
Latest revision as of 22:00, 4 February 2015
An area file is laid out using a series of BLOCKS. Each block starts with a control structure that tells the MUD what kind of data is contained in the block. Following the control structure are the records holding the data. After the final record in a block, a control marker occurs indicating the block is finished.
All blocks are optional, and you may have only ONE of each type. However, some blocks force the use of other blocks. For example, if you have a block of mobs or objects, you are forced to have a block of the resets to load them into the area. Or if you have rooms in the file, you MUST have an area header block.
There are 11 kinds of blocks:
- The Area Header
- The Helps Block
- The Mobiles Block
- The Objects Block
- The Rooms Block
- The Strings Block
- The Resets Block
- The Shops Block
- The Specials Block
- The Rspecs Block
- The Triggers Block
For ease of reading, they MUST be used in the order listed above.
Following all the blocks, the last line of the area file must contain the control marker signifying the "end of file". This is the string "#$" on a line all by itself. If this is omitted, the area will NOT load.
An area file is laid out like this, then:
#AREA { 1 2} Author Area_Name~ F 1
#HELPS
help record 1
help record 2
...
0 $~
#MOBILES
mob record 1
mob record 2
...
#0
#OBJECTS
obj record 1
obj record 2
...
#0
#ROOMS
room record 1
room record 2
...
#0
#STRINGS
string record 1
string record 2
...
#0
#RESETS
reset record 1
reset record 2
...
S
#SHOPS
shop record 1
shop record 2
...
0
#SPECIALS
specfun record 1
specfun record 2
...
S
#RSPECS
rspec record 1
rspec record 2
...
S
#TRIGGERS
trigger record 1
trigger record 2
...
S
#$