|
|
|
|
|
World Resolutions
The world provides access to world/server level information and can only be
accessed by retrieving a world pointed via %getWorldPtr() or %world() as a
convenient shorthand. Following are the world fields that can currently be
retrieved and set via the resolution operator. Each description is prefixed
with either [G] gettable, [S] settable,
or [G,S] gettable and settable. Resolutions are case
sensitive. |
General Information
|
Various fields to retrieve and set world information.
|
@world->profile
| [G] The current load profile for the world.
Generally this will be '' (empty string) or 'testport'.
|
@world->bootId
| [G] A unique server boot ID that is captured via
the clock when the server first starts up. This can be used to
constrain activities to a specific boot ID where longer term
storage crosses reboot instances.
|
@world->mudName
| [G] A shorter, more casual name of the MUD as
might be used in a reference to the game and that doesn't require a
salutation. Currently 'Carnage'.
|
@world->mudNameLong
| [G] A longer fuller name of the MUD as might be
used in in reference to the game. This version may require the use
of the configured salutation. Currently 'Worlds of Carnage'.
|
@world->mudSalutation
| [G] The salutation for the MUD which may or may
not be necessary when creating a reference using the long name. The
current value is 'the'. When put together with the long name we get
'the Worlds of Carnage'. For some types of names the salutation may
be empty.
|
@world->mudSalutationUc
| [G] The salutation for the MUD with the
appropriate first letter upper-cased. The current value is 'The'.
When put together with the long name we get 'The Worlds of Carnage'.
|
@world->pulse
| [G] The number of game pulses that have occurred
since boot. Pulses are moments in time when activity is processed
in the game. Internally the game fires some events after X pulses,
and others after Y pulses, and so on. Not every activity happens on
every pulse.
|
@world->ticks
| [G] The number of game ticks that have occurred
since boot. Ticks are synonymous with in-game hours. The general
length of a tick can be determined by the following caculation:
@world->pulsesPerTick / @world->pulsesPerTick. The duration of a
tick can be stretched if activity processing in a pulse takes
longer than the configured pulse duration.
|
@world->pulsesPerTick
| [G] This determines how many pulses make up a
tick. The current value is 600.
|
@world->pulsesPerSecond
| [G] This determines the approximate number of
pulses that will be fired per second. A pulse can take longer than
the cnofigured value if activity processing takes longer than
expected. The current value is 10.
|
@world->maxConnections
| [G] The maximum number of connections to mud that
are allowed at any given moment in time. The current value is 100.
|
@world->allowMortals
| [G] Determines whether mortals are allowed to log
in. This is generally set to true on the main server and false on
the builder server.
|
@world->allowNewMortals
| [G] Determines whether new accounts can be
created. This is generally set to true on the main server and false
on the builder server.
|
@world->allowUnstableAreas
| [G] Determines whether the mud will allow an
unstable area to be loaded into the game. Unstable areas are
usually areas that are in development. This is generally set to
false on the main server and true on the builder server.
|
@world->realTime
| [G] The current server real time in Unix time
(seconds since the epoch). Value is dependent on timezone.
|
@world->realTimeBoot
| [G] The Unix time when the server was started.
|
@world->uptime
| [G] The number of seconds that the server has been
running. This is retained if the mud is restarted intentionally. In
other worlds, only a crash will reset this to 0.
|
@world->memory
| [G] The ammount of memory currently being consumed
by the game. For performance reasons the MUD retains a lot of data
in memory and so on the production server with all areas and zones
active this can hit 500M. Memory is cheap :)
|
@world->cpuCurrent
| [G] The current load placed on the CPU by the MUD engine.
|
@world->cpuAverage
| [G] The recent average load placed on the CPU by the MUD engine.
| |
Areas
|
Fields for retrieving information about any areas in the world.
|
@world->areas
| [G] Returns an array of area pointers currently in the
world. Entries are indexed sequentially from 1 onward.
|
@world->areas->total
| [G] Returns the number of areas in the world.
|
@world->areas->count
| [G] An alias for @world->areas->total
|
@world->areas->first
| [G] Returns a pointer to the first area in the world.
|
@world->areas->last
| [G] Returns a pointer to the last area in the
world.
|
@world->areas->head
| [G] An alias for @world->areas->first
|
@world->areas->tail
| [G] An alias for @world->areas->last
| |
Zones
|
Fields for retrieving information about any zones in the world.
|
@world->zones
| [G] Returns an array of zone pointers currently in the
world. Entries are indexed sequentially from 1 onward.
|
@world->zones->total
| [G] Returns the number of zones in the world.
|
@world->zones->count
| [G] An alias for @world->zones->total
|
@world->zones->first
| [G] Returns a pointer to the first zone in the world.
|
@world->zones->last
| [G] Returns a pointer to the last zone in the
world.
|
@world->zones->head
| [G] An alias for @world->zones->first
|
@world->zones->tail
| [G] An alias for @world->zones->last
| |
Rooms
|
Fields for retrieving information about any rooms in the world.
|
@world->rooms
| [G] Returns an array of room pointers currently in the
world. Entries are indexed sequentially from 1 onward.
|
@world->rooms->total
| [G] Returns the number of rooms in the world.
|
@world->rooms->count
| [G] An alias for @world->rooms->total
|
@world->rooms->first
| [G] Returns a pointer to the first room in the world.
|
@world->rooms->last
| [G] Returns a pointer to the last room in the
world.
|
@world->rooms->head
| [G] An alias for @world->rooms->first
|
@world->rooms->tail
| [G] An alias for @world->rooms->last
| |
Mobiles
|
Fields for retrieving information about any mobiles in the world.
|
@world->mobiles
| [G] Returns an array of mobile pointers currently in the world. Entries
are indexed sequentially from 1 onward.
|
@world->mobiles->total
| [G] Returns the number of mobiles in the world.
|
@world->mobiles->count
| [G] An alias for @world->mobiles->total
|
@world->mobiles->first
| [G] Returns a pointer to the first mobile in the world.
|
@world->mobiles->last
| [G] Returns a pointer to the last mobile in the world.
|
@world->mobiles->head
| [G] An alias for @world->mobiles->first
|
@world->mobiles->tail
| [G] An alias for @world->mobiles->last
| |
Mobiles (PC)
|
Fields for retrieving information about any PCs in the world.
|
@world->pcs
| [G] Returns an array of PC pointers currently in the world. Entries
are indexed sequentially from 1 onward.
|
@world->pcs->total
| [G] Returns the number of PCs in the world.
|
@world->pcs->count
| [G] An alias for @world->pcs->total
|
@world->pcs->first
| [G] Returns a pointer to the first PC in the world.
|
@world->pcs->last
| [G] Returns a pointer to the last PC in the world.
|
@world->pcs->head
| [G] An alias for @world->pcs->first
|
@world->pcs->tail
| [G] An alias for @world->pcs->last
| |
Mobiles (NPC)
|
Fields for retrieving information about any NPCs in the world.
|
@world->npcs
| [G] Returns an array of NPC pointers currently in the world. Entries
are indexed sequentially from 1 onward.
|
@world->npcs->total
| [G] Returns the number of NPCs in the world.
|
@world->npcs->count
| [G] An alias for @world->npcs->total
|
@world->npcs->first
| [G] Returns a pointer to the first NPC in the world.
|
@world->npcs->last
| [G] Returns a pointer to the last NPC in the world.
|
@world->npcs->head
| [G] An alias for @world->npcs->first
|
@world->npcs->tail
| [G] An alias for @world->npcs->last
| |
Items
|
Fields for retrieving information about any items in the world.
|
@world->items
| [G] Returns an array of item pointers currently in the world. Entries
are indexed sequentially from 1 onward.
|
@world->items->total
| [G] Returns the number of items in the world.
|
@world->items->count
| [G] An alias for @world->items->total
|
@world->items->first
| [G] Returns a pointer to the first item in the world.
|
@world->items->last
| [G] Returns a pointer to the last item in the world.
|
@world->items->head
| [G] Alias for @world->items->first
|
@world->items->tail
| [G] Alias for @world->items->last
| |
Items (deprecated aliases)
|
Fields for retrieving information about any items in the world.
This style is deprecated since the term "object" can be confused
with object oriented programming terminology.
|
@world->objects
| [G] DEPRECATED. Alias for @world->items
|
@world->objects->total
| [G] DEPRECATED. Alias for @world->items->total
|
@world->objects->count
| [G] DEPRECATED. Alias for @world->items->count
|
@world->objects->first
| [G] DEPRECATED. Alias for @world->items->first
|
@world->objects->last
| [G] DEPRECATED. Alias for @world->items->last
|
@world->objects->head
| [G] DEPRECATED. Alias for @world->items->head
|
@world->objects->tail
| [G] DEPRECATED. Alias for @world->items->tail
| |
Inventory (mobiles and objects)
|
These fields are used to retrieve the world's contents with
respect to mobiles and objects. Using these fields for retrieval
provides an aggregation of the mobiles and objects found in the
world with mobiles taking precedence in any returned results.
Additionally, using these meta fields allows indiscriminate
movement of items and mobiles into the world.
|
@world->inventory
| [G] Returns an aggregate array of mobile and item pointers currently
in the world. Entries are indexed sequentially from 1 onward.
mobiles are listed first.
|
@world->inventory->total
| [G] Returns the combined total number of mobiles
and items in the world.
|
@world->inventory->count
| [G] An alias for @world->inventory->total
|
@world->inventory->first
| [G] Returns the first mobile in the world, or if
there are none, then the first object.
|
@world->inventory->last
| [G] Returns the last object in the world, or if
there are none, then the last mobile.
|
@world->inventory->head
| [G] Alias for @world->inventory->first
|
@world->inventory->tail
| [G] Alias for @world->inventory->last
| |
Inventory (mobiles and objects -- short alias)
|
Exactly the same as the inventory field counterparts except less
typing is involved :)
|
@world->inv
| [G] Alias for @world->inventory
|
@world->inv->total
| [G] An alias for @world->inventory->total
|
@world->inv->count
| [G] An alias for @world->inventory->count
|
@world->inv->first
| [G] Alias for @world->inventory->first
|
@world->inv->last
| [G] Alias for @world->inventory->last
|
@world->inv->head
| [G] Alias for @world->inventory->head
|
@world->inv->tail
| [G] Alias for @world->inventory->tail
| |
|
|
|
|
|
|
|