FutureMUD Type Help Reference

Accent

Property	Return Type	Property Help
id	Number
name	Text
language	Language
suffix	Text
vague	Text
difficulty	Number
group	Text
description	Text

ClanAppointment

Property	Return Type	Property Help
id	Number	The Id of the appointment
name	Text	The name of the appointment
paygrade	Paygrade	The paygrade associated with the appointment (can be null)
minrank	Rank	The minimum rank required to hold the appointment (can be null)
minappointer	Rank	The minimum rank required to appoint to this appointment (can be null)
parent	Appointment	The parent rank controlling appointments to this appointment (can be null)
holders	Number	A list of all the current holders of this appointment
maxholders	Number	The maximum number of simultaneous holders (0 if unlimited)
onlinemembers	Character Collection	A list of all online characters with this appointment

Area

Property	Return Type	Property Help
id	Number	The ID of the area
name	Text	The name of the area
type	Text	Returns the name of the framework item type, for example, character or gameitem or clan
effects	Effect Collection	A collection of effects on this area
rooms	Location Collection	A collection of the rooms in this area
now	MudDateTime	The current datetime in this area
characters	Character Collection	The characters in this area
items	Item Collection	The items in this area
timeofday	Text	The current time of day in this area

Bank

Property	Return Type	Property Help
id	Number	The ID of the bank
name	Text	The name of the bank
code	Text	The code the bank uses in transfers
accounttypes	BankAccountType Collection	A collection of all the bank account types
accounts	BankAccount Collection	A collection of all the bank accounts
branches	Location Collection	A collection of the locations that this bank uses as branches
currency	Currency	The currency in which the bank operates

BankAccount

Property	Return Type	Property Help
id	Number	The ID of the bank account
name	Text	The name of the bank account
status	Text	The status of the bank account; Active, Locked, Suspended or Closed
bank	Bank	The bank this account is with
balance	Number	The current balance of this account
accounttype	BankAccountType	The account type for this account
accountnumber	Number	The account number to access this bank account

BankAccountType

Property	Return Type	Property Help
id	Number	The ID of the bank account
name	Text	The name of the bank account
bank	Bank	The bank this account is with

Boolean

Property	Return Type	Property Help

Calendar

Property	Return Type	Property Help
id	Number
name	Text
date	MudDateTime
clock	Clock

Character

Property	Return Type	Property Help
id	Number	The id of the character
effects	Effect Collection	A collection of all effects on the character
name	Text	Their real first name
type	Text
simplefullname	Text	The simple version of their real full name
fullname	Text	Their real full name
surname	Text	Their real surname
csimplefullname	Text	The simple version of their current alias' full name
cfullname	Text	Their current alias' full name
csurname	Text	Their current alias' surname
cname	Text	Their current alias' first name
gender	Gender	Their real gender
height	Number	Their height in base units (cm)
weight	Number	Their weight in base units (grams)
location	Location	The room that they are in
age	Number	Their age in years
agecategory	Text	Their age category as text
race	Race	Their race
culture	Culture	Their culture
currency	Currency	The currency they are using in transactions
ethnicity	Ethnicity	Their ethnicity
zone	Zone	The zone that they are in
shard	Shard	The shard that they are in
inventory	Item Collection	A collection of all items in their inventory
helditems	Item Collection	A collection of all items they're holding
wieldeditems	Item Collection	A collection of all items they're wielding
wornitems	Item Collection	A collection of all items they're wearing
visiblewornitems	Item Collection	A collection of all uncovered or partially exposed worn items
clans	Clan Collection	A collection of all the clans they're a member of
skills	Trait Collection	A collection of skills that they have a value in
class	Text	Their class role, if any (can be null)
subclass	Text	Their subclass role, if any (can be null)
ingroup	Boolean	True if they are currently in a group
groupmembers	Character Collection	A collection of all the member of their group
npc	Boolean	True if they are an NPC
pc	Boolean	True if they are a PC
accents	Accent Collection	A collection of all of the assets that they have familiarity with
languages	Language Collection	A collection of all the languages that they know
guest	Boolean	True if they are a guest
linewidth	Number	Their account's line width setting, in characters
innerlinewidth	Number	Their account's inner line width setting, in characters
language	Language	The language they are currently speaking (can be null)
accent	Accent	The accent they are currently speaking (can be null)
merits	Merit Collection	A collection of all of their merits and flaws
applicablemerits	Merit Collection	A collection of all of their merits and flaws currently active
roles	Role Collection	A collection of all of their roles
playtime	Number	Their total playtime in minutes
incombat	Boolean	True if they are currently in combat
combattarget	Perceiver	Who or what they are currently targeting in combat (can be null)
combattargetchar	Character	Who they are currently targeting in combat (can be null)
preferredintentions	Text Collection	A collection of text representing the intentions they prefer in selecting combat moves
requiredintentions	Text Collection	A collection of text representing the intentions they require in selecting combat moves
forbiddenintentions	Text Collection	A collection of text representing the intentions they forbid in selecting combat moves
drugs	Drug Collection	A collection of drugs currently affecting them
drugamounts	Number Collection	A collection of the grams of each drug. Items match order of drugs property
latentdrugs	Drug Collection	A collection of drugs not yet affecting them but in their system
latentdrugamounts	Number Collection	A collection of the grams of each latent drug. Items match order of latentdrugs property
outfits	Outfit Collection	A collection of outfits associated with this character
layer	Text	A text representation of the current layer this character is in
isnewplayer	Boolean	True if character has the (New Player) tag
knowledges	Knowledge Collection	Returns a collection of knowledges the character has
scripts	Script Collection	A collection of the known scripts for this character
script	Script	The script they are currently writing with (can be null)
writings	Writing Collection	A collection of all writings this character is the author or true author of

Chargen

Property	Return Type	Property Help
id	Number
name	Text
simplefullname	Text
fullname	Text
surname	Text
race	Race
culture	Culture
ethnicity	Ethnicity
age	Number
agecategory	Text
height	Number
weight	Number
gender	Gender
skills	Trait Collection
accents	Accent Collection
class	Text
subclass	Text
npc	Boolean
guest	Boolean
pc	Boolean
merits	Merit Collection
applicablemerits	Merit Collection
roles	Role Collection
special	Boolean
simple	Boolean

Clan

Property	Return Type	Property Help
id	Number	The Id of the clan
name	Text	The name of the clan
alias	Text	The alias of the clan
description	Text	The full description of the clan
ranks	Rank Collection	An ordered list of the ranks in the clan
paygrades	Paygrade Collection	A list of all of the paygrades in the clan
appointments	Appointment Collection	A list of all of the appointments in the clan
onlinemembers	Character Collection	A list of all of the online characters who are clan members
bankaccount	BankAccount	The bank account for the clan, if one is set. Otherwise null.

Clock

Property	Return Type	Property Help
id	Number
name	Text

Crime

Property	Return Type	Property Help
id	Number	The ID of the crime
name	Text	The name of the law which this crime is against
law	Law	The law which this crime is against
authority	LegalAuthority	The legal authority that this crime belongs to
crimename	Text	The generic name of the crime
crimetype	Number	The numerical ID of the crime that this law governs
isviolentcrime	Boolean	Whether or not this crime type is considered a violent crime
ismoralcrime	Boolean	Whether or not this crime type is considered a moral crime
ismajorcrime	Boolean	Whether or not this crime type is considered a major crime
isarrestable	Boolean	Whether or not this crime can lead to the individual being arrested
iskillable	Boolean	Whether or not this crime attracts a lethal force response

Culture

Property	Return Type	Property Help
id	Number	The ID of the culture
name	Text	The name of the culture
namecultures	Text Collection	A collection of the name cultures for this culture, if present
tempfloor	Number	The modifier to the floor of tolerable temperatures
tempceiling	Number	The modifier to the ceiling of tolerable temperatures

Currency

Property	Return Type	Property Help
id	Number	The database ID of the currency
name	Text	The name of the currency
conversion	Number	The conversion rate of this currency to a global base currency

DateTime

Property	Return Type	Property Help
year	Number
month	Number
day	Number
hour	Number
minute	Number
second	Number

Drug

Property	Return Type	Property Help
id	Number	The unique database id of the drug
name	Text	The name of the drug
intensitypergram	Number	The hard-coded intensity of the drug per gram ingested. Has different effects per drug type
metabolisationrate	Text Collection	The relative rate at which the drug is metabolised (removed) by the body
metabolizationrate	Number	An alias for the metabolisationrate property
vectors	Text Collection	The potential vectors for the drug affecting someone
types	Text Collection	The drug effect types contained in this drug
intensities	Number Collection	The intensities for each drug type, ordered the same way as the 'types' property

Effect

Property	Return Type	Property Help
id	Number
name	Text
type	Text
owner	Perceivable

Ethnicity

Property	Return Type	Property Help
id	Number	The Id of the ethnicity
name	Text	The name of the ethnicity
group	Text	The ethnic group to which this ethnicity belongs
subgroup	Text	The ethnic sub group to which this ethnicity belongs
ethnicgroup	Text	An alias for the GROUP property
ethnicsubgroup	Text	An alias for the SUBGROUP property
parentrace	Race	Which race this ethnicity belongs to
namecultures	Text Collection	A collection of the name cultures for this ethnicity, if present
tempfloor	Number	The modifier to the floor of tolerable temperatures
tempceiling	Number	The modifier to the ceiling of tolerable temperatures

Exit

Property	Return Type	Property Help
origin	Location	The origin room for this exit
destination	Location	The destination room for this exit
keyword	Text	The best keyword for targeting the exit. A direction for cardinal exits and a keyword for non cardinal exits.
direction	Text	A text conversion of the cardinal direction
opposite	Exit	The corresponding exit from the destination room's perspective
door	Item	If not null, the door item in this exit
acceptsdoor	Boolean	True if this exit can have a door
isclimbexit	Boolean	True if this exit is a climb exit
isfallexit	Boolean	True if this exit is a fall exit
isflyexit	Boolean	True if this exit is a fly exit
climbdifficulty	Number	The numerical conversion of the difficulty of climbing
outboundmovementsuffix	Text	e.g. out towards the East
inboundmovementsuffix	Text	e.g. in from the East
outbounddirectionsuffix	Text	e.g. to the East
inbounddirectionsuffix	Text	e.g. from the East
outbounddirectiondescription	Text	e.g. the North
doorsize	Number	A numerical representation of the size of door that go in this exit
maximumsize	Number	A numerical representation of the maximum size for someone to go through an exit
maximumsizeupright	Number	A numerical representation of the maximum size for someone to go through an exit while standing
slowdown	Number	The speed multiplier of the exit

Gas

Property	Return Type	Property Help
name	Text	The name of the material
id	Number	The Id of the material
density	Number	The density of the material in kg/m3
organic	Boolean	Whether this is an organic material
tags	Text Collection	A collection of tags for this material
description	Text	The material description for this material

Gender

Property	Return Type	Property Help
he	Text	returns he, she, it or they as appropriate
him	Text	returns him, her, it or them as appropriate
his	Text	returns his, her, its or theirs as appropriate
himself	Text	returns himself, herself, itself or theirself as appropriate

Item

Property	Return Type	Property Help
id	Number
effects	Effect Collection
name	Text
type	Text
proto	Number	The ID number of the proto this item was loaded from
quantity	Number	The quantity of this item in the stack. 1 if not stacked
holder	Character	The character who is holding this item, if any
wearer	Character	The character who is wearing this item, if any
weight	Number	The weight of this item in base units
contents	Item Collection	A collection of the item contents of this item
container	Item	The item that this item is contained in, if any
iscontainer	Boolean	True if the item is a container
isopenable	Boolean	True is the item can be opened and closed
iscurrency	Boolean	True if the item is a currency pile
islock	Boolean	True if the item is a lock
islockable	Boolean	True if the item can be locked and unlocked
iskey	Boolean	True if the item is a key
istable	Boolean	True if the item is a table
ischair	Boolean	True if the item is a chair
isdoor	Boolean	True if the item is a door
isbelt	Boolean	True if the item is a belt
isbeltable	Boolean	True if the item can be attached to a belt
iswearable	Boolean	True if the item can be worn
iswieldable	Boolean	True if the item can be wielded
isholdable	Boolean	True if the item can be held
issheath	Boolean	True if the item is a weapon sheath
islightable	Boolean	True if the item can be lit with the light command
ispowered	Boolean	True if the item is electrically powered
ison	Boolean	True if the item is on
iscover	Boolean	True if the item can be used as ranged cover
iscorpse	Boolean	True if the item is a corpse
isweapon	Boolean	True if the item is a weapon of any kind
ismeleeweapon	Boolean	True if the item is a melee weapon
israngedweapon	Boolean	True if the item is a ranged weapon
providingcover	Boolean	True if the item is currently providing cover
lit	Boolean	True if the item is currently lit (e.g. by the light command)
open	Boolean	True if the item is currently open
locked	Boolean	True if the item is currently locked
locks	Item Collection	A collection of the locks on this item
corpsecharacter	Character	If the item is a corpse, this is the original character
location	Location	The room that the item is in
tags	Text Collection	A collection of the tags that this item has
iscommodity	Boolean	True if the item is a commodity pile
material	Material	The primary material that this item is made from
isgridconnectable	Boolean	True if this item can be connected to a grid
iselectricgridconnectable	Boolean	True if this item can be connected to an electrical grid
grid	Number	The grid that this item is connected to, if any
layer	Text	A text description of the layer this item is currently in
isfood	Boolean	True if the item is food
isliquidcontainer	Boolean	True if the item is a liquid container
variables	Text Dictionary	Returns a dictionary of variable names and variable values

Knowledge

Property	Return Type	Property Help
id	Number
name	Text
desc	Text	An alias for the 'description' property
description	Text
ldesc	Text	An alias for the 'ldesc' property
longdescription	Text
type	Text
subtype	Text

Language

Property	Return Type	Property Help
id	Number	The ID of the language
name	Text	The name of the language
trait	Trait	The trait linked to the language
accents	Accent Collection	A list of accents associated with the language
defaultaccent	Accent	The default learner accent for the language
unknown	Text	The unknown description string

Law

Property	Return Type	Property Help
id	Number	The ID of the law
name	Text	The name of the law
authority	LegalAuthority	The legal authority that this law belongs to
crimename	Text	The name of the crime that this law governs
crimetype	Number	The numerical ID of the crime that this law governs
isviolentcrime	Boolean	Whether or not this crime type is considered a violent crime
ismoralcrime	Boolean	Whether or not this crime type is considered a moral crime
ismajorcrime	Boolean	Whether or not this crime type is considered a major crime
isarrestable	Boolean	Whether or not this crime can lead to the individual being arrested
iskillable	Boolean	Whether or not this crime attracts a lethal force response

LegalAuthority

Property	Return Type	Property Help
id	Number	The ID of the bank account
name	Text	The name of the bank account
zones	Zone Collection	The zones this legal authority enforces
preparinglocation	Location	The room patrols will prepare / equip in
marshallinglocation	Location	The room patrols will begin in after preparing
enforcerstowinglocation	Location	The room off duty enforcers are returned to
prisonlocation	Location	The room holding cells are connected to for enforcers to drag prisoners to
prisonreleaselocation	Location	The room where ex-prisoners are released to
prisonerbelongingsstoragelocation	Location	The room where prisoner belongings are stored while held
jaillocation	Location	The entry to the jail where custodial sentences are served
celllocations	Location Collection	A collection of rooms where criminals in custody are held
jaillocations	Location Collection	A collection of rooms where custodial prison sentences are served
laws	Law Collection	A collection of the laws that apply in this zone

Liquid

Property	Return Type	Property Help
name	Text	The name of the material
id	Number	The Id of the material
density	Number	The density of the material in kg/m3
organic	Boolean	Whether this is an organic material
tags	Text Collection	A collection of tags for this material
description	Text	The material description for this material

LiquidMixture

Property	Return Type	Property Help
empty	Boolean	True if the liquid mixture is empty
weight	Number	The weight of the liquid in base units (g)
volume	Number	The volume of the liquid in base units (L)
liquids	Liquid Collection	A collection of the liquid types contained in this mixture
distinct	LiquidMixture Collection	Each of the liquid instances broken into single liquid mixtures with only one instance
issingle	Boolean	True is this liquid mixture only contains one liquid instance
liquid	Liquid	The liquid of the single instance
isblood	Boolean	True if this is a single instance of blood
bloodcharacter	Character	The character who this blood belongs to, or null
iscoloured	Boolean	True if this is a coloured liquid, like ink
colour	Text	The text name of the colour that this liquid has
simplecolour	Text	The simple colour name of this liquid colour (e.g. black, green, brown etc)

Location

Property	Return Type	Property Help
id	Number	The ID of the room
characters	Character Collection	A collection of characters who are in the room (all layers)
items	Item Collection	A collection of items that are in the room (all layers)
surrounds	Location Collection	A collection of all rooms directly adjacent to this one
exits	Exit Collection	A collection of all the exits from this room
zone	Zone	The zone that this room is in
shard	Shard	The shard that this room is in
terrain	Terrain	The terrain type of this room
windlevel	Number	A numerical representation of the wind in this room. Values as follows: 0=none, 1=still, 2=occasionalbreeze, 3=breeze, 4=wind, 5=strongwind, 6=galewind, 7=hurricanewind, 8=maelstromwind
rainlevel	Number	A numerical representation of the rain in this room. Values as follows: 0=not raining, 1=lightrain, 2=rain, 3=heavyrain, 4=torrentialrain
snowlevel	Number	A numerical representation of the snow in this room. Values as follows: 0=not snowing, 1=lightsnow/sleet, 2=snow, 3=heavysnow, blizzard=4
temperature	Number	The temperature (in celcius) in the room
temperaturec	Number	The temperature (in celcius) in the room
temperaturef	Number	The temperature (in farenheit) in the room
temperaturek	Number	The temperature (in kelvin) in the room
wind	Text	A description of the wind in this room. Values are none, still, occasional breeze, breeze, wind, strong wind, gale wind, hurricane wind, maelstrom wind
rain	Text	A description of the rain in this room. Values are none, light rain, rain, heavy rain, torrential rain, sleet
snow	Text	A description of the snow in this room. Values are none, light snow, snow, heavy snow, blizzard, sleet
precipitation	Text	A description of the precipitation in this room. Values are parched, dry, humid, light rain, rain, heavy rain, torrential rain, light snow, snow, heavy snow, blizzard, sleet
weather	WeatherEvent	The current weather event at this room, if there is one (can be null)
tags	Text Collection	A collection of the names of the tags applied to this room
addedlight	Number	The amount of light added for this room
addedlightfactor	Number	The multiplier for natural light in this room
atmosphereid	Number	The id of the atmosphere gas or liquid, 0 if none
atmospheretype	Text	Either Gas, Liquid or None depending on the atmosphere
atmospherename	Text	The name of the gas or liquid atmosphere, or None if none
outdoors	Number	0=Indoors, 1=Indoors with Windows, 2=Outdoors, 3=Indoors No Light (Cave), 4=Indoors Climate Exposed (Shelter)
overlay	OverlayPackage	The current cell overlay
overlays	OverlayPackage Collection	A collection of all the cell overlays for this room
grids	Number Collection	A collection of the IDs of any grids in this location
electricgrids	Number Collection	A collection of the IDs of any electrical grids in this location
name	Text	The name of this room
type	Text	Returns the name of the framework item type, for example, character or gameitem or clan
effects	Effect Collection	A collection of all the effects that are on this room
light	Number	The current light level of this location at ground level, in lux

MagicCapability

Property	Return Type	Property Help
name	Text	The name of the magic capability
id	Number	The Id of the magic capability
school	MagicSchool	The school that this capability belongs to
powerlevel	Number	The power level of this capability
concentrationtrait	Trait	The trait used for concentrating on sustained spells

MagicResourceHaver

Property	Return Type	Property Help
id	Number
name	Text
type	Text	Returns the name of the framework item type, for example, character or gameitem or clan
effects	Effect Collection

MagicSchool

Property	Return Type	Property Help
name	Text	The name of the school of magic
id	Number	The Id of the school of magic
verb	Text	The verb (command) used when dealing with this magic school
adjective	Text	The adjective used to describe magic from this school
color	Text	An alias for the Colour property
colour	Text	The name of the colour that is used in displaying things from this school
parent	MagicSchool	The parent magical school, if any. Can be null
powers	Text Collection	A collection of the names of all powers belonging to this school
spells	MagicSpell Collection	A collection of all the spells defined for this school
capabilities	MagicCapability Collection	A collection of all the magic capabilities for this school

MagicSpell

Property	Return Type	Property Help
name	Text	The name of the spell
id	Number	The Id of the spell
description	Text	The description of the spell as seen in spellinfo
school	MagicSchool	The MagicSchool to which this spell belongs
exclusivedelay	TimeSpan	The lock-out timer to all other spells when cast
nonexclusivedelay	TimeSpan	The lock-out timer to spells in the same school when cast
castingtrait	Trait	The trait that this spell uses to cast in checks
opposedtrait	Trait	If set, the trait rolled by those opposing this spell. Can be null.

Market

Property	Return Type	Property Help
name	Text	The name of the market
id	Number	The Id of the market
categories	MarketCategory Collection	The market categories that apply in this market
influences	Number Dictionary	A dictionary with the names and IDs of influences effecting this market

MarketCategory

Property	Return Type	Property Help
name	Text	The name of the market category
id	Number	The Id of the market category

Material

Property	Return Type	Property Help
name	Text	The name of the material
id	Number	The Id of the material
density	Number	The density of the material in kg/m3
organic	Boolean	Whether this is an organic material
tags	Text Collection	A collection of tags for this material
description	Text	The material description for this material

Merchandise

Property	Return Type	Property Help
name	Text	The name of the merchandise record
id	Number	The ID of the merchandise record
price	Number	The price that the merchandise is selling for
description	Text	The description of the merchandise on the LIST command
shop	Shop	The shop the merchandise is being sold in
willbuy	Boolean	Whether the merchandise will be bought
willsell	Boolean	Whether the merchandise will be sold
mincond	Number	The minimum condition (0.0 to 1.0) the item must be in to be bought
markdown	Number	The markdown percentage on sale price for buying
markup	Number	The markup percentage on sale price for selling

Merit

Property	Return Type	Property Help
id	Number
name	Text

MudDateTime

Property	Return Type	Property Help
second	Number
minute	Number
hour	Number
day	Number
month	Text
year	Number
isnever	Boolean
midnight	MudDateTime	Returns the MudDateTime with the time component set to midnight
calendar	Calendar
clock	Clock
timezone	Text

Number

Property	Return Type	Property Help

Outfit

Property	Return Type	Property Help
owner	Character
name	Text
desc	Text
description	Text
items	OutfitItem Collection

OutfitItem

Property	Return Type	Property Help
id	Number
containerid	Number
order	Number
desc	Text
description	Text
containerdesc	Text
containerdescription	Text
profile	Text

OverlayPackage

Property	Return Type	Property Help
id	Number
name	Text
revnum	Number	An alias for the revision property
revision	Number
status	Text

ClanPaygrade

Property	Return Type	Property Help
id	Number	The Id of the paygrade
name	Text	The name of the paygrade
abbreviation	Text	The abbreviation of the paygrade
currency	Currency	The currency that pay is made out in
amount	Number	The amount in the currency's base pay to pay per pay period

Perceivable

Property	Return Type	Property Help
id	Number
name	Text
type	Text	Returns the name of the framework item type, for example, character or gameitem or clan
effects	Effect Collection

Perceiver

Property	Return Type	Property Help
id	Number
name	Text
type	Text	Returns the name of the framework item type, for example, character or gameitem or clan
effects	Effect Collection

Project

Property	Return Type	Property Help
id	Number
name	Text
location	Location
owner	Character
workers	Character Collection

Race

Property	Return Type	Property Help
id	Number	The Id of the race
name	Text	The name of the race
childage	Number	The minimum age at which this race is considered a child
youthage	Number	The minimum age at which this race is considered a youth
youngadultage	Number	The minimum age at which this race is considered a young adult
adultage	Number	The minimum age at which this race is considered an adult
elderage	Number	The minimum age at which this race is considered an elder
venerableage	Number	The minimum age at which this race is considered a venerable elder

ClanRank

Property	Return Type	Property Help
id	Number	The Id of the rank
name	Text	The name of the rank
ranknumber	Text	The number where the rank appears in the rank list
path	Text	The path of the rank (may be null)
paygrades	Paygrade Collection	A list of all of the paygrades associated with this rank

Role

Property	Return Type	Property Help
id	Number
name	Text
roletype	Number

Script

Property	Return Type	Property Help
id	Number	The ID of the language
name	Text	The name of the language
languages	Language Collection	All the languages this script is designed for
knowledge	Knowledge	The knowledge required for this script
unknownscriptdescription	Text	The text description if someone doesn't know this script
knownscriptdescription	Text	The text description is someone does know this script
documentlength	Number	A multiplier for how much space on a page this script takes up
inkuse	Number	A multiplier for how much ink this script uses

Shard

Property	Return Type	Property Help
id	Number
name	Text
type	Text	Returns the name of the framework item type, for example, character or gameitem or clan
effects	Effect Collection
zones	Zone Collection

Shop

Property	Return Type	Property Help
id	Number
name	Text
merchandise	Merchandise Collection
shopfront	Location Collection
storeroom	Location
workshop	Location
tills	Item Collection
employees	Number Collection
employeesonduty	Character Collection
managers	Number Collection
proprietors	Number Collection
stock	Item Collection

Solid

Property	Return Type	Property Help
name	Text	The name of the material
id	Number	The Id of the material
density	Number	The density of the material in kg/m3
organic	Boolean	Whether this is an organic material
tags	Text Collection	A collection of tags for this material
description	Text	The material description for this material
liquidform	Liquid	The liquid form of this solid
gasform	Gas	The gas form of this solid

Tagged

Property	Return Type	Property Help
tags	Text Collection	A collection of the tags that this thing has

Terrain

Property	Return Type	Property Help
id	Number	The ID of the terrain type
name	Text	The name of the terrain type
staminacost	Number	A multiplier of base stamina cost for movement
infectionmultiplier	Number	A multiplier for chance to get infected
primaryinfection	Text	The type of infection people catch here
infectionvirulence	Number	Initial virulence of infections
foragableprofile	Number	The id (or null) of the foragable profile for this terrain
atmosphereid	Number	The default atmospheric fluid id
default	Boolean	True if this is the MUD's default terrain
hidedifficulty	Number	The difficulty of hiding in this terrain
spotdifficulty	Number	The minimum spot difficulty in this terrain
tags	Text Collection	A collection of the names of the tags applied to this room

Text

Property	Return Type	Property Help
length	Number
upper	Text
lower	Text
proper	Text
title	Text

TimeSpan

Property	Return Type	Property Help
days	Number
hours	Number
minutes	Number
seconds	Number
milliseconds	Number

Toon

Property	Return Type	Property Help
id	Number
name	Text
simplefullname	Text
fullname	Text
surname	Text
race	Race
culture	Culture
ethnicity	Ethnicity
age	Number
agecategory	Text
height	Number
weight	Number
gender	Gender
skills	Trait Collection
accents	Accent Collection
class	Text
subclass	Text
npc	Boolean
guest	Boolean
pc	Boolean
merits	Merit Collection
applicablemerits	Merit Collection
roles	Role Collection
special	Boolean
simple	Boolean

Trait

Property	Return Type	Property Help
id	Number	The ID of the trait
name	Text	The name of the trait
group	Text	The group the trait belongs to
isskill	Boolean	True if this trait is for a skill
isattribute	Boolean	True if this trait is for an attribute

Void

Property	Return Type	Property Help

WeatherEvent

Property	Return Type	Property Help
id	Number
name	Text
description	Text
windlevel	Number
rainlevel	Number
snowlevel	Number
wind	Text
rain	Text
snow	Text
precipitation	Text
obscuressky	Boolean
lightmultiplier	Number
temperatureeffect	Number
precipitationtemperatureeffect	Number
windtemperatureeffect	Number
permittednight	Boolean
permitteddawn	Boolean
permittedmorning	Boolean
permittedafternoon	Boolean
permitteddusk	Boolean

Writing

Property	Return Type	Property Help
id	Number	The ID of the writing
name	Text	The name of the writing
author	Character	The author of the writing
trueauthor	Character	The true author of the writing, if forged (otherwise null)
script	Script	The script it is written in
language	Language	The language it is written in
handwriting	Number	The handwriting skill of the author
literacy	Number	The literacy skill of the author
forgery	Number	The forgery skill of the author
languageskill	Number	The language skill of the author
text	Text	The parsed text of the writing
simple	Boolean	True if simple writing, false is composite (drawing+writing)

Zone

Property	Return Type	Property Help
id	Number	The ID of the zone
name	Text	The name of the zone
type	Text	Returns the name of the framework item type, for example, character or gameitem or clan
effects	Effect Collection	A collection of effects on this zone
rooms	Location Collection	A collection of the rooms in this zone
latitude	Number	The latitude in degrees
longitude	Number	The longitude in degrees
elevation	Number	The elevation in metres
now	MudDateTime	The current datetime in this zone
characters	Character Collection	The characters in this zone
items	Item Collection	The items in this zone
timeofday	Text	The current time of day in this zone

Collection

Property	Return Type	Property Help
count	Number	The number of items in the collection
any	Boolean	True if there are any items in the collection
empty	Boolean	True if the collection is empty
first	Void	The first item in the collection or null if empty
last	Void	The last item in the collection or null if empty
reverse	Void Collection	The collection in reverse order

CollectionDictionary

Property	Return Type	Property Help
count	Number	The number of keys in the collection dictionary
longcount	Number	The number of values in all of the sub collections
any	Boolean	True if there are any values in this collection dictionary
empty	Boolean	True if the collection dictionary is empty
values	Void Collection	Returns all of the values in all of the collection dictionary collections
keys	Text Collection	Returns all of the keys in the collection dictionary

Dictionary

Property	Return Type	Property Help
count	Number	The number of items in this dictionary
any	Boolean	True if there are 1 or more items, otherwise false
empty	Boolean	True if empty
values	Void Collection	A collection of the values without their keys
keys	Text Collection	A collection of the keys without their values