Manual:Zone Manual/Zone Source File/Zone information section - Revision history

Papi: /* Zone information section */

2023-12-09T12:34:11Z

Zone information section

Papi: /* Zone information section */

2023-12-09T12:32:46Z

Zone information section

Papi: /* Zone information section */

2023-12-09T12:11:16Z

Zone information section

Nove at 11:24, 26 May 2020

2020-05-26T11:24:30Z

Nove: Created page with "=== Zone information section === The zone information section is the only section that must exist in the source file of your area. With out this section the compiler i..."

2020-05-25T14:09:35Z

Created page with "=== Zone information section === The zone information section is the only section that must exist in the source file of your area. With out this section the compiler i..."

New page

=== Zone information section ===

The zone information section is the only section that must
exist in the source file of your area. With out this section the
compiler is unable to create the zone because frankly it doesn't
know what to call it. It is also the easiest of the sections to
learn because there is only a few possible fields. The Zone-section defines the global parameters for the current
zone. It is usually wise to place this section in the top of the
source file to make it easy to find the zone information when editing the file.
{| class="wikitable"
|+Zone section field descriptions
|-
!Field
!Type
!Description
|-
|creators
|Stringlist
|This field is where you place the creators of the zone. With
this field filled out the Administrators and builders can easily find out who
the zone was written by and be able to contact them if there are problems.
|-
|lifespan
|Number
|This defines the interval between resets for this zone, in minutes.
Default is 60 if this field is left out of the information section.
|-
|notes
|String
|This is a plain text description of the zone for administrators and builders.
It is often a good idea to
include your e-mail address in the notes so you can be
reached easily by the administrators.
|-
|reset
|Number
|This combined with 'lifespan' defines if the zone will be reset. This
field gives the condition that must be met to reset the zones you
should use the defines in the ''vme.h'', RESET_NOT,
RESET_IFEMPTY, and RESET_ANYHOW. Default is RESET_ANYHOW, which
means, the zone will be reset even if players are present within it.
|-
|title
|String
|This is the title of the zone, for example Dragons Nest, Dark
station, and
creators hide out. It is used mainly for the areas command so
players can get a list of all the areas in the game. It can
however be accessed by the 'zoneptr' variable type in DIL. If you
have
a zone that spans across multiple source files you only need to
define the title once. If you put the title in all source files it
will show up multiple times in the area listing. You would also
leave this blank if the zone should not be on the areas list like an
administration zone.
|-
|weather
|Integer
|This field sets the humidity level of the zone. If for example you want
a hot desert like zone you would want to set this to its highest value.
The range of this field is 1000 to -1000. This is an optional field and
will not be covered else where because it is simple to use.
|-
|%zone
|Symbol
|This entry defines the name of the
zone. Default is the preceding component of the current filename,
minus the trailing ".zon". Note, the symbol should be added
after the %zone tag, which should always be put, even if you
do not add a symbol after it.
|}
The only field that must exist when you go to create the zone
information section is the '%zone'. Leaving the '%zone' field out
will cause an error when you try to compile it. We suggest you
not only put the '%zone' field but you also add a symbol or as I
call it a zone name. The following are three legal examples of a Zone information header. You be the judge of
which is more informative.
<nowiki>
/*very bad*/
%zone

/*bad but better than nothing*/
%zone bug_planet

/*The way it should be done!*/
%zone dragonst
lifespan 20
reset RESET_ANYHOW
creators {"whistler"}

notes
"This is the dragon station I shortened it to dragonst for ease in
loading. If you have any questions email me at whistler@valhalla.com"

help
"Not sure what could help you now. You are stuck on one of the
weirdest space stations you have ever seen and you smell burning
sulfur."</nowiki>
If you felt like it you could add a '%end' to the proceeding
examples and compile them. They would create an empty zone so
wouldn't be very exciting but at least its possible. We will not go into any compiling until we have at least one unit
type to compile because it is pretty useless to do.
the next chapters will
define the basic unit building blocks you will use for rooms,
objects, and NPCs and start you off on compiling.

@@ Line 35: / Line 35: @@
 |reset
 |Number
-|This combined with 'lifespan' defines if the zone will be reset.  This
+|This combined with 'lifespan' defines if the zone will be reset.  This	field gives the condition that must be met to reset the zones you should use the defines in the ''vme.h', RESET_NOT (only reset at boot), RESET_IFEMPTY (only reset of players), RESET_ANYHOW (always reset), RESET_NEVER (will never reset, you need to reset programmatically). Default is RESET_ANYHOW, which means, the zone will be reset even if players are present within it.
 |-
 |title

@@ Line 38: / Line 38: @@
 	field gives the condition that must be met to reset the zones you
 	should use the defines in the ''vme.h', RESET_NOT (only reset at boot),
-	RESET_IFEMPTY (only reset of players), RESET_ANYHOW (always reset), RESET_NEVER
+	RESET_IFEMPTY (only reset of players), RESET_ANYHOW (always reset),
-         (will never reset, you need to reset programatically).  Default is RESET_ANYHOW, which
+         RESET_NEVER (will never reset, you need to reset programmatically).
-	means, the zone will be reset even if players are present within it.
+        Default is RESET_ANYHOW, which means, the zone will be reset even if
 |-
 |title

← Older revision		Revision as of 11:24, 26 May 2020
Line 104:		Line 104:
	define the basic unit building blocks you will use for rooms,		define the basic unit building blocks you will use for rooms,
	objects, and NPCs and start you off on compiling.		objects, and NPCs and start you off on compiling.
		+
		+	<div style='padding-top: 30px; padding-bottom: 20px; text-align: left;float:left;width:50%;'>[[Manual:Zone_Manual/Zone_Source_File\|Previous: Zone Source File]]</div>
		+	<div style='padding-top: 30px; padding-bottom: 20px; text-align: right;float:right;width:50%;'>[[Manual:Zone_Manual/Unit_Building_Blocks\|Next: Unit Building Blocks]]</div>