FutureProg types

Item

type ·

calibrationbias → Number
The current deliberate calibration bias in base units or percent depending on calibrationbiasispercent

calibrationbiasispercent → Boolean
True if calibrationbias is a percentage rather than a base-unit amount

calibrationdeliberate → Boolean
True if the current calibration has a deliberate wrong-measure bias

condition → Number
A value from 0.0 to 1.0 representing the current condition percentage of the item

container → Item
The item that this item is contained in, if any

contents → Item Collection
A collection of the item contents of this item

corpsebodyid → Number
If the item is a corpse, this is the original body ID represented by the remains

corpsecharacter → Character
If the item is a corpse, this is the original character

corpsefinaldeath → Boolean
True if the item is a corpse from a final character death rather than abandoned body remains

corpseremainscontext → Text
If the item is a corpse, this is the body-remains context

effects → Effect Collection


grid → Number
The grid that this item is connected to, if any

hasowner → Boolean
True if this item has a durable registered owner reference.

holder → Character
The character who is holding this item, if any

id → Number


isbelt → Boolean
True if the item is a belt

isbeltable → Boolean
True if the item can be attached to a belt

iscellphonetower → Boolean
True if this item is or hosts a cell phone tower

iscellularphone → Boolean
True if this item is or hosts a cellular phone

ischair → Boolean
True if the item is a chair

iscommodity → Boolean
True if the item is a commodity pile

iscontainer → Boolean
True if the item is a container

iscorpse → Boolean
True if the item is a corpse

iscover → Boolean
True if the item can be used as ranged cover

iscurrency → Boolean
True if the item is a currency pile

isdoor → Boolean
True if the item is a door

iselectricgridconnectable → Boolean
True if this item can be connected to an electrical grid

isfood → Boolean
True if the item is food

isgridconnectable → Boolean
True if this item can be connected to a grid

isholdable → Boolean
True if the item can be held

iskey → Boolean
True if the item is a key

islightable → Boolean
True if the item can be lit with the light command

isliquidcontainer → Boolean
True if the item is a liquid container

islock → Boolean
True if the item is a lock

islockable → Boolean
True if the item can be locked and unlocked

ismeasuringinstrument → Boolean
True if the item is a measuring instrument

ismeleeweapon → Boolean
True if the item is a melee weapon

ison → Boolean
True if the item is on

isopenable → Boolean
True is the item can be opened and closed

ispowered → Boolean
True if the item is electrically powered

israngedweapon → Boolean
True if the item is a ranged weapon

issealable → Boolean
True if the item can hold a seal impression

issealed → Boolean
True if the item currently has an intact seal

issealstamp → Boolean
True if the item is a seal stamp

issheath → Boolean
True if the item is a weapon sheath

istable → Boolean
True if the item is a table

istelecommunicationsgridconnectable → Boolean
True if this item can be connected to a telecommunications grid

istelephone → Boolean
True if this item is or hosts a telephone

isweapon → Boolean
True if the item is a weapon of any kind

iswearable → Boolean
True if the item can be worn

iswieldable → Boolean
True if the item can be wielded

layer → Text
A text description of the layer this item is currently in

lit → Boolean
True if the item is currently lit (e.g. by the light command)

location → Location
The room that the item is in

locked → Boolean
True if the item is currently locked

locks → Item Collection
A collection of the locks on this item

material → Material
The primary material that this item is made from

measuringmode → Text
The measuring mode of the measuring instrument, if any

name → Text


open → Boolean
True if the item is currently open

owner → Character Clan Shop Bank
The registered owner of this item when its owner has a native FutureProg variable type.

ownerid → Number
The ID of this item's registered owner, or 0 if unowned.

ownertype → Text
The framework-item type of this item's registered owner, or empty text if unowned.

phonenumber → Text
The active telephone number assigned to this item or its connected telecom endpoint, if any

proto → Number
The ID number of the proto this item was loaded from

providingcover → Boolean
True if the item is currently providing cover

quality → Number
The quality of the item as a number between 0 (terrible) and 11 (legendary)

qualityname → Text
The name of the quality level of the item (e.g. Terrible, ExtremelyBad, Bad, Poor, Substandard, Standard, Good, Very Good, Great, Excellent, Heroic, Legendary)

quantity → Number
The quantity of this item in the stack. 1 if not stacked

rawquality → Number
The raw (base) quality of the item as a number between 0 (terrible) and 11 (legendary)

rawqualityname → Text
The name of the raw (base) quality level of the item (e.g. Terrible, ExtremelyBad, Bad, Poor, Substandard, Standard, Good, Very Good, Great, Excellent, Heroic, Legendary)

sealbroken → Boolean
True if the item has had a seal broken

sealclan → Text
The clan metadata of the current or broken seal impression, if any

sealdesign → Text
The design text of the current or broken seal impression, if any

sealingcharacterid → Number
The ID of the character who applied the current or broken seal impression, if any

sealissuer → Text
The issuer metadata of the current or broken seal impression, if any

sealmaterial → Text
The stamp material metadata of the current or broken seal impression, if any

sealmedium → Text
The sealing medium description of the current or broken seal impression, if any

sealoffice → Text
The office metadata of the current or broken seal impression, if any

sealowner → Text
The owner metadata of the current or broken seal impression, if any

sealresidue → Boolean
True if the item has broken seal residue

tags → Text Collection
A collection of the tags that this item has

type → Text


usessincecalibration → Number
The number of measurements made since the instrument was last calibrated

variables → Text Dictionary
Returns a dictionary of variable names and variable values

wearer → Character
The character who is wearing this item, if any

weight → Number
The weight of this item in base units

← Back to FutureProg types