FutureMUD Type Help Reference

Accent
PropertyReturn TypeProperty Help
idNumber
nameText
languageLanguage
suffixText
vagueText
difficultyNumber
groupText
descriptionText
ClanAppointment
PropertyReturn TypeProperty Help
idNumberThe Id of the appointment
nameTextThe name of the appointment
paygradePaygradeThe paygrade associated with the appointment (can be null)
minrankRankThe minimum rank required to hold the appointment (can be null)
minappointerRankThe minimum rank required to appoint to this appointment (can be null)
parentAppointmentThe parent rank controlling appointments to this appointment (can be null)
holdersNumberA list of all the current holders of this appointment
maxholdersNumberThe maximum number of simultaneous holders (0 if unlimited)
onlinemembersCharacter CollectionA list of all online characters with this appointment
Bank
PropertyReturn TypeProperty Help
idNumberThe ID of the bank
nameTextThe name of the bank
codeTextThe code the bank uses in transfers
accounttypesBankAccountType CollectionA collection of all the bank account types
accountsBankAccount CollectionA collection of all the bank accounts
branchesLocation CollectionA collection of the locations that this bank uses as branches
currencyCurrencyThe currency in which the bank operates
BankAccount
PropertyReturn TypeProperty Help
idNumberThe ID of the bank account
nameTextThe name of the bank account
statusTextThe status of the bank account; Active, Locked, Suspended or Closed
bankBankThe bank this account is with
balanceNumberThe current balance of this account
accounttypeBankAccountTypeThe account type for this account
accountnumberNumberThe account number to access this bank account
BankAccountType
PropertyReturn TypeProperty Help
idNumberThe ID of the bank account
nameTextThe name of the bank account
bankBankThe bank this account is with
Boolean
PropertyReturn TypeProperty Help
Calendar
PropertyReturn TypeProperty Help
idNumber
nameText
dateMudDateTime
clockClock
Character
PropertyReturn TypeProperty Help
idNumber
effectsEffect Collection
nameText
typeText
simplefullnameText
fullnameText
surnameText
csimplefullnameText
cfullnameText
csurnameText
cnameText
genderGender
heightNumber
weightNumber
locationLocation
ageNumber
agecategoryText
raceRace
cultureCulture
currencyCurrency
ethnicityEthnicity
zoneZone
shardShard
inventoryItem Collection
helditemsItem Collection
wieldeditemsItem Collection
wornitemsItem Collection
visiblewornitemsItem Collection
clansClan Collection
skillsTrait Collection
classText
subclassText
ingroupBoolean
groupmembersCharacter Collection
npcBoolean
pcBoolean
accentsAccent Collection
languagesLanguage Collection
guestBoolean
linewidthNumber
innerlinewidthNumber
languageLanguage
accentAccent
meritsMerit Collection
applicablemeritsMerit Collection
rolesRole Collection
playtimeNumber
incombatBoolean
combattargetPerceiver
combattargetcharCharacter
preferredintentionsText Collection
requiredintentionsText Collection
forbiddenintentionsText Collection
drugsDrug Collection
drugamountsNumber Collection
latentdrugsDrug Collection
latentdrugamountsNumber Collection
outfitsOutfit Collection
layerText
Chargen
PropertyReturn TypeProperty Help
idNumber
nameText
simplefullnameText
fullnameText
surnameText
raceRace
cultureCulture
ethnicityEthnicity
ageNumber
agecategoryText
heightNumber
weightNumber
genderGender
skillsTrait Collection
accentsAccent Collection
classText
subclassText
npcBoolean
guestBoolean
pcBoolean
meritsMerit Collection
applicablemeritsMerit Collection
rolesRole Collection
specialBoolean
Clan
PropertyReturn TypeProperty Help
idNumberThe Id of the clan
nameTextThe name of the clan
aliasTextThe alias of the clan
descriptionTextThe full description of the clan
ranksRank CollectionAn ordered list of the ranks in the clan
paygradesPaygrade CollectionA list of all of the paygrades in the clan
appointmentsAppointment CollectionA list of all of the appointments in the clan
onlinemembersCharacter CollectionA list of all of the online characters who are clan members
bankaccountBankAccountThe bank account for the clan, if one is set. Otherwise null.
Clock
PropertyReturn TypeProperty Help
idNumber
nameText
Crime
PropertyReturn TypeProperty Help
idNumberThe ID of the crime
nameTextThe name of the law which this crime is against
lawLawThe law which this crime is against
authorityLegalAuthorityThe legal authority that this crime belongs to
crimenameTextThe generic name of the crime
crimetypeNumberThe numerical ID of the crime that this law governs
isviolentcrimeBooleanWhether or not this crime type is considered a violent crime
ismoralcrimeBooleanWhether or not this crime type is considered a moral crime
ismajorcrimeBooleanWhether or not this crime type is considered a major crime
isarrestableBooleanWhether or not this crime can lead to the individual being arrested
iskillableBooleanWhether or not this crime attracts a lethal force response
Culture
PropertyReturn TypeProperty Help
idNumber
nameText
Currency
PropertyReturn TypeProperty Help
idNumber
nameText
DateTime
PropertyReturn TypeProperty Help
yearNumber
monthNumber
dayNumber
hourNumber
minuteNumber
secondNumber
Drug
PropertyReturn TypeProperty Help
idNumberThe unique database id of the drug
nameTextThe name of the drug
intensitypergramNumberThe hard-coded intensity of the drug per gram ingested. Has different effects per drug type
metabolisationrateText CollectionThe relative rate at which the drug is metabolised (removed) by the body
metabolizationrateNumberAn alias for the metabolisationrate property
vectorsText CollectionThe potential vectors for the drug affecting someone
typesText CollectionThe drug effect types contained in this drug
intensitiesNumber CollectionThe intensities for each drug type, ordered the same way as the 'types' property
Effect
PropertyReturn TypeProperty Help
idNumber
nameText
typeText
ownerPerceivable
Ethnicity
PropertyReturn TypeProperty Help
idNumberThe Id of the ethnicity
nameTextThe name of the ethnicity
groupTextThe ethnic group to which this ethnicity belongs
subgroupTextThe ethnic sub group to which this ethnicity belongs
ethnicgroupTextAn alias for the GROUP property
ethnicsubgroupTextAn alias for the SUBGROUP property
parentraceRaceWhich race this ethnicity belongs to
Exit
PropertyReturn TypeProperty Help
originLocationThe origin room for this exit
destinationLocationThe destination room for this exit
keywordTextThe best keyword for targeting the exit. A direction for cardinal exits and a keyword for non cardinal exits.
directionTextA text conversion of the cardinal direction
oppositeExitThe corresponding exit from the destination room's perspective
doorItemIf not null, the door item in this exit
acceptsdoorBooleanTrue if this exit can have a door
isclimbexitBooleanTrue if this exit is a climb exit
isfallexitBooleanTrue if this exit is a fall exit
isflyexitBooleanTrue if this exit is a fly exit
climbdifficultyNumberThe numerical conversion of the difficulty of climbing
outboundmovementsuffixTexte.g. out towards the East
inboundmovementsuffixTexte.g. in from the East
outbounddirectionsuffixTexte.g. to the East
inbounddirectionsuffixTexte.g. from the East
outbounddirectiondescriptionTexte.g. the North
doorsizeNumberA numerical representation of the size of door that go in this exit
maximumsizeNumberA numerical representation of the maximum size for someone to go through an exit
maximumsizeuprightNumberA numerical representation of the maximum size for someone to go through an exit while standing
slowdownNumberThe speed multiplier of the exit
Gas
PropertyReturn TypeProperty Help
nameTextThe name of the material
idNumberThe Id of the material
densityNumberThe density of the material in kg/m3
organicBooleanWhether this is an organic material
tagsText CollectionA collection of tags for this material
descriptionTextThe material description for this material
Gender
PropertyReturn TypeProperty Help
heTextreturns he, she, it or they as appropriate
himTextreturns him, her, it or them as appropriate
hisTextreturns his, her, its or theirs as appropriate
himselfTextreturns himself, herself, itself or theirself as appropriate
Item
PropertyReturn TypeProperty Help
idNumber
effectsEffect Collection
nameText
typeText
protoNumber
quantityNumber
holderCharacter
wearerCharacter
weightNumber
contentsItem Collection
containerItem
iscontainerBoolean
isopenableBoolean
iscurrencyBoolean
islockBoolean
islockableBoolean
iskeyBoolean
istableBoolean
ischairBoolean
isdoorBoolean
isbeltBoolean
isbeltableBoolean
iswearableBoolean
iswieldableBoolean
isholdableBoolean
issheathBoolean
islightableBoolean
ispoweredBoolean
isonBoolean
iscoverBoolean
iscorpseBoolean
isweaponBoolean
ismeleeweaponBoolean
israngedweaponBoolean
providingcoverBoolean
litBoolean
openBoolean
lockedBoolean
locksItem Collection
corpsecharacterCharacter
locationLocation
tagsText Collection
iscommodityBoolean
materialMaterial
isgridconnectableBoolean
iselectricgridconnectableBoolean
gridNumber
layerText
Knowledge
PropertyReturn TypeProperty Help
idNumber
nameText
descTextAn alias for the 'description' property
descriptionText
ldescTextAn alias for the 'ldesc' property
longdescriptionText
typeText
subtypeText
Language
PropertyReturn TypeProperty Help
idNumber
nameText
traitTrait
accentsAccent Collection
defaultaccentText
unknownText
Law
PropertyReturn TypeProperty Help
idNumberThe ID of the law
nameTextThe name of the law
authorityLegalAuthorityThe legal authority that this law belongs to
crimenameTextThe name of the crime that this law governs
crimetypeNumberThe numerical ID of the crime that this law governs
isviolentcrimeBooleanWhether or not this crime type is considered a violent crime
ismoralcrimeBooleanWhether or not this crime type is considered a moral crime
ismajorcrimeBooleanWhether or not this crime type is considered a major crime
isarrestableBooleanWhether or not this crime can lead to the individual being arrested
iskillableBooleanWhether or not this crime attracts a lethal force response
LegalAuthority
PropertyReturn TypeProperty Help
idNumberThe ID of the bank account
nameTextThe name of the bank account
zonesZone CollectionThe zones this legal authority enforces
preparinglocationLocationThe room patrols will prepare / equip in
marshallinglocationLocationThe room patrols will begin in after preparing
enforcerstowinglocationLocationThe room off duty enforcers are returned to
prisonlocationLocationThe room holding cells are connected to for enforcers to drag prisoners to
prisonreleaselocationLocationThe room where ex-prisoners are released to
prisonerbelongingsstoragelocationLocationThe room where prisoner belongings are stored while held
jaillocationLocationThe entry to the jail where custodial sentences are served
celllocationsLocation CollectionA collection of rooms where criminals in custody are held
jaillocationsLocation CollectionA collection of rooms where custodial prison sentences are served
lawsLaw CollectionA collection of the laws that apply in this zone
Liquid
PropertyReturn TypeProperty Help
nameTextThe name of the material
idNumberThe Id of the material
densityNumberThe density of the material in kg/m3
organicBooleanWhether this is an organic material
tagsText CollectionA collection of tags for this material
descriptionTextThe material description for this material
Location
PropertyReturn TypeProperty Help
idNumberThe ID of the room
charactersCharacter CollectionA collection of characters who are in the room (all layers)
itemsItem CollectionA collection of items that are in the room (all layers)
surroundsLocation CollectionA collection of all rooms directly adjacent to this one
exitsExit CollectionA collection of all the exits from this room
zoneZoneThe zone that this room is in
shardShardThe shard that this room is in
terrainTerrainThe terrain type of this room
windlevelNumberA 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
rainlevelNumberA numerical representation of the rain in this room. Values as follows: 0=not raining, 1=lightrain, 2=rain, 3=heavyrain, 4=torrentialrain
snowlevelNumberA numerical representation of the snow in this room. Values as follows: 0=not snowing, 1=lightsnow/sleet, 2=snow, 3=heavysnow, blizzard=4
temperatureNumberThe temperature (in celcius) in the room
temperaturecNumberThe temperature (in celcius) in the room
temperaturefNumberThe temperature (in farenheit) in the room
temperaturekNumberThe temperature (in kelvin) in the room
windTextA description of the wind in this room. Values are none, still, occasional breeze, breeze, wind, strong wind, gale wind, hurricane wind, maelstrom wind
rainTextA description of the rain in this room. Values are none, light rain, rain, heavy rain, torrential rain, sleet
snowTextA description of the snow in this room. Values are none, light snow, snow, heavy snow, blizzard, sleet
precipitationTextA 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
weatherWeatherEventThe current weather event at this room, if there is one (can be null)
tagsText CollectionA collection of the names of the tags applied to this room
addedlightNumberThe amount of light added for this room
addedlightfactorNumberThe multiplier for natural light in this room
atmosphereidNumberThe id of the atmosphere gas or liquid, 0 if none
atmospheretypeTextEither Gas, Liquid or None depending on the atmosphere
atmospherenameTextThe name of the gas or liquid atmosphere, or None if none
outdoorsNumber0=Indoors, 1=Indoors with Windows, 2=Outdoors, 3=Indoors No Light (Cave), 4=Indoors Climate Exposed (Shelter)
overlayOverlayPackageThe current cell overlay
overlaysOverlayPackage CollectionA collection of all the cell overlays for this room
gridsNumber CollectionA collection of the IDs of any grids in this location
electricgridsNumber CollectionA collection of the IDs of any electrical grids in this location
nameTextThe name of this room
typeTextReturns the name of the framework item type, for example, character or gameitem or clan
effectsEffect CollectionA collection of all the effects that are on this room
lightNumberThe current light level of this location at ground level, in lux
MagicCapability
PropertyReturn TypeProperty Help
nameTextThe name of the magic capability
idNumberThe Id of the magic capability
schoolMagicSchoolThe school that this capability belongs to
powerlevelNumberThe power level of this capability
concentrationtraitTraitThe trait used for concentrating on sustained spells
MagicResourceHaver
PropertyReturn TypeProperty Help
idNumber
nameText
typeTextReturns the name of the framework item type, for example, character or gameitem or clan
effectsEffect Collection
MagicSchool
PropertyReturn TypeProperty Help
nameTextThe name of the school of magic
idNumberThe Id of the school of magic
verbTextThe verb (command) used when dealing with this magic school
adjectiveTextThe adjective used to describe magic from this school
colorTextAn alias for the Colour property
colourTextThe name of the colour that is used in displaying things from this school
parentMagicSchoolThe parent magical school, if any. Can be null
powersText CollectionA collection of the names of all powers belonging to this school
spellsMagicSpell CollectionA collection of all the spells defined for this school
capabilitiesMagicCapability CollectionA collection of all the magic capabilities for this school
MagicSpell
PropertyReturn TypeProperty Help
nameTextThe name of the spell
idNumberThe Id of the spell
descriptionTextThe description of the spell as seen in spellinfo
schoolMagicSchoolThe MagicSchool to which this spell belongs
exclusivedelayTimeSpanThe lock-out timer to all other spells when cast
nonexclusivedelayTimeSpanThe lock-out timer to spells in the same school when cast
castingtraitTraitThe trait that this spell uses to cast in checks
opposedtraitTraitIf set, the trait rolled by those opposing this spell. Can be null.
Material
PropertyReturn TypeProperty Help
nameTextThe name of the material
idNumberThe Id of the material
densityNumberThe density of the material in kg/m3
organicBooleanWhether this is an organic material
tagsText CollectionA collection of tags for this material
descriptionTextThe material description for this material
Merchandise
PropertyReturn TypeProperty Help
nameText
idNumber
priceNumber
descriptionText
shopShop
Merit
PropertyReturn TypeProperty Help
idNumber
nameText
MudDateTime
PropertyReturn TypeProperty Help
secondNumber
minuteNumber
hourNumber
dayNumber
monthText
yearNumber
isneverBoolean
midnightMudDateTimeReturns the MudDateTime with the time component set to midnight
calendarCalendar
clockClock
timezoneText
Number
PropertyReturn TypeProperty Help
Outfit
PropertyReturn TypeProperty Help
ownerCharacter
nameText
descText
descriptionText
itemsOutfitItem Collection
OutfitItem
PropertyReturn TypeProperty Help
idNumber
containeridNumber
orderNumber
descText
descriptionText
containerdescText
containerdescriptionText
profileText
OverlayPackage
PropertyReturn TypeProperty Help
idNumber
nameText
revnumNumberAn alias for the revision property
revisionNumber
statusText
ClanPaygrade
PropertyReturn TypeProperty Help
idNumberThe Id of the paygrade
nameTextThe name of the paygrade
abbreviationTextThe abbreviation of the paygrade
currencyCurrencyThe currency that pay is made out in
amountNumberThe amount in the currency's base pay to pay per pay period
Perceivable
PropertyReturn TypeProperty Help
idNumber
nameText
typeTextReturns the name of the framework item type, for example, character or gameitem or clan
effectsEffect Collection
Perceiver
PropertyReturn TypeProperty Help
idNumber
nameText
typeTextReturns the name of the framework item type, for example, character or gameitem or clan
effectsEffect Collection
Project
PropertyReturn TypeProperty Help
idNumber
nameText
locationLocation
ownerCharacter
workersCharacter Collection
Race
PropertyReturn TypeProperty Help
idNumberThe Id of the race
nameTextThe name of the race
childageNumberThe minimum age at which this race is considered a child
youthageNumberThe minimum age at which this race is considered a youth
youngadultageNumberThe minimum age at which this race is considered a young adult
adultageNumberThe minimum age at which this race is considered an adult
elderageNumberThe minimum age at which this race is considered an elder
venerableageNumberThe minimum age at which this race is considered a venerable elder
ClanRank
PropertyReturn TypeProperty Help
idNumberThe Id of the rank
nameTextThe name of the rank
ranknumberTextThe number where the rank appears in the rank list
pathTextThe path of the rank (may be null)
paygradesPaygrade CollectionA list of all of the paygrades associated with this rank
Role
PropertyReturn TypeProperty Help
idNumber
nameText
roletypeNumber
Shard
PropertyReturn TypeProperty Help
idNumber
nameText
typeTextReturns the name of the framework item type, for example, character or gameitem or clan
effectsEffect Collection
zonesZone Collection
Shop
PropertyReturn TypeProperty Help
idNumber
nameText
merchandiseMerchandise Collection
shopfrontLocation Collection
storeroomLocation
workshopLocation
tillsItem Collection
employeesNumber Collection
employeesondutyCharacter Collection
managersNumber Collection
proprietorsNumber Collection
stockItem Collection
Solid
PropertyReturn TypeProperty Help
nameTextThe name of the material
idNumberThe Id of the material
densityNumberThe density of the material in kg/m3
organicBooleanWhether this is an organic material
tagsText CollectionA collection of tags for this material
descriptionTextThe material description for this material
liquidformLiquidThe liquid form of this solid
gasformGasThe gas form of this solid
Tagged
PropertyReturn TypeProperty Help
tagsText Collection
Terrain
PropertyReturn TypeProperty Help
idNumber
nameText
staminacostNumber
infectionmultiplierNumber
primaryinfectionText
infectionvirulenceNumber
foragableprofileNumber
atmosphereidNumber
defaultBoolean
hidedifficultyNumber
spotdifficultyNumber
Text
PropertyReturn TypeProperty Help
lengthNumber
upperText
lowerText
properText
titleText
TimeSpan
PropertyReturn TypeProperty Help
daysNumber
hoursNumber
minutesNumber
secondsNumber
millisecondsNumber
Toon
PropertyReturn TypeProperty Help
idNumber
nameText
simplefullnameText
fullnameText
surnameText
raceRace
cultureCulture
ethnicityEthnicity
ageNumber
agecategoryText
heightNumber
weightNumber
genderGender
skillsTrait Collection
accentsAccent Collection
classText
subclassText
npcBoolean
guestBoolean
pcBoolean
meritsMerit Collection
applicablemeritsMerit Collection
rolesRole Collection
specialBoolean
Trait
PropertyReturn TypeProperty Help
idNumber
nameText
groupText
Void
PropertyReturn TypeProperty Help
WeatherEvent
PropertyReturn TypeProperty Help
idNumber
nameText
descriptionText
windlevelNumber
rainlevelNumber
snowlevelNumber
windText
rainText
snowText
precipitationText
obscuresskyBoolean
lightmultiplierNumber
temperatureeffectNumber
precipitationtemperatureeffectNumber
windtemperatureeffectNumber
permittednightBoolean
permitteddawnBoolean
permittedmorningBoolean
permittedafternoonBoolean
permittedduskBoolean
Zone
PropertyReturn TypeProperty Help
idNumber
nameText
typeTextReturns the name of the framework item type, for example, character or gameitem or clan
effectsEffect Collection
roomsLocation Collection
latitudeNumber
longitudeNumber
elevationNumber
nowMudDateTime
charactersCharacter Collection
itemsItem Collection
timeofdayText
Collection
PropertyReturn TypeProperty Help
countNumber
anyBoolean
emptyBoolean
CollectionDictionary
PropertyReturn TypeProperty Help
countNumber
longcountNumber
anyBoolean
emptyBoolean
valuesCollectionItem Collection
keysText Collection
Dictionary
PropertyReturn TypeProperty Help
countNumber
anyBoolean
emptyBoolean
valuesCollectionItem Collection
keysText Collection