FutureProg types

Location

type ·

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

atmospherename → Text
The name of the gas or liquid atmosphere, or None if none

atmospheretype → Text
Either Gas, Liquid or None depending on the atmosphere

characters → Character Collection
A collection of characters who are in the room (all layers)

effects → Effect Collection
A collection of all the effects that are on this room

electricgrids → Number Collection
A collection of the IDs of any electrical grids in this location

exits → Exit Collection
A collection of all the exits from this room

field → AgricultureField
The agriculture field in this room, if any

grids → Number Collection
A collection of the IDs of any grids in this location

id → Number
The ID of the room

items → Item Collection
A collection of items that are in the room (all layers)

light → Number
The current light level of this location at ground level, in lux

name → Text
The name of this room

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

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

rain → Text
A description of the rain in this room. Values are none, light rain, rain, heavy rain, torrential rain, sleet

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

shard → Shard
The shard that this room is in

snow → Text
A description of the snow in this room. Values are none, light snow, snow, heavy snow, blizzard, sleet

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

surrounds → Location Collection
A collection of all rooms directly adjacent to this one

tags → Text Collection
A collection of the names of the tags applied to this room

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

terrain → Terrain
The terrain type of this room

type → Text
Returns the name of the framework item type, for example, character or gameitem or clan

weather → WeatherEvent
The current weather event at this room, if there is one (can be null)

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

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

zone → Zone
The zone that this room is in

← Back to FutureProg types