/datum/material

Vars
alpha	The "transparency" of the material. Kept as alpha for logical reasons. Displayed as percentage ingame.
applyColor	Should this even color the objects made from it? Mostly used for base station materials like steel
cached	Whether this material should be stored in the material cache - only used for base types, modifying at runtime has no effect
canMix	Can this be mixed with other materials?
color	The color of the material
desc	Description of the material, used for scanning
edible	The functional value of edibility. Edible or not? This is what you check from the outside to see if material is edible. See /datum/material/var/edible_exact.
edible_exact	The actual value of edibility. Changes internally and sets /datum/material/var/edible.
generation	Compound generation
mat_id	used to retrieve instances of these base materials from the cache.
material_flags	Various flags. See [material_properties.dm]
mixOnly	Can this only be used after being combined with another material?
mutable	Is this a mutable instance? Defaults to true so creating new materials returns a mutable instance by default
name	Name of the material, used for combination and scanning
parent_materials	Holds the parent materials.
prefixes	words that go before the name, used in combination
properties	Associated list of all the various /datum/material_property that apply. list/datum/material_property = value
special_naming	Whether the specaialNaming proc is called when this material is applied.
suffixes	words that go after the name, used in combination
texture	if not null, texture will be set when mat is applied.
texture_blend	How to blend the /datum/material/var/texture.
triggersChem	Called when exposed to chemicals.
triggersDrop	Called when owning object is dropped.
triggersExp	Called when exposed to explosions.
triggersOnAdd	Called when the material is added to an object
triggersOnAttack	Called when the owning object is used to attack something or someone.
triggersOnAttacked	Called when a mob wearing the owning object is attacked.
triggersOnBlobHit	Called when blob hits something with this material assigned.
triggersOnBullet	Called when a mob wearing the owning object is shot.
triggersOnEat	Called when someone eats a thing with this material assigned.
triggersOnEntered	Called when something enters a turf with the material assigned. Also called on all objects on the turf with a material.
triggersOnHit	Called when an obj hits something with this material assigned.
triggersOnLife	Called when the life proc of a mob that has the owning item equipped runs.
triggersOnRemove	Called when the material is removed from an object
triggersPickup	Called when owning object is picked up.
triggersTemp	Called when exposed to temperatures.
value	In percent of a base value. How much this sells for.
Procs
addTrigger	Triggers is specified using one of the TRIGGER_ON_ defines
countTriggers	Triggers is specified using one of the TRIGGER_ON_ defines
getImmutable	Returns an immutable version of this material. Will return this material if it is already immutable.
getMaterialTraitDesc	Time for some super verbose proc names.
getMutable	Returns a mutable version of this material. Will return a copy of this material if it is already mutable. The reason this is a separate proc and not using in getMaterial() is prevent cargo-culting accidentally reintroducing the issue this was supposed to fix. Force the coders to explicitly ask for a mutable instance, demand to know why they want it to be mutable in reviews!
hasTrigger	Checks if material proc type is present for a given trigger in the material
isSameMaterial	Compares a material to this one to determine if stacking should be allowed.
removeAllTriggers	Triggers is specified using one of the TRIGGER_ON_ defines
removeTrigger	Triggers is specified using one of the TRIGGER_ON_ defines

Var Details

var
alpha
–

The "transparency" of the material. Kept as alpha for logical reasons. Displayed as percentage ingame.

var
applyColor
–

Should this even color the objects made from it? Mostly used for base station materials like steel

var
cached
–

Whether this material should be stored in the material cache - only used for base types, modifying at runtime has no effect

var
canMix
–

Can this be mixed with other materials?

var
color
–

The color of the material

var
desc
–

Description of the material, used for scanning

var
edible
–

The functional value of edibility. Edible or not? This is what you check from the outside to see if material is edible. See /datum/material/var/edible_exact.

var
edible_exact
–

The actual value of edibility. Changes internally and sets /datum/material/var/edible.

var
generation
–

Compound generation

var
mat_id
–

used to retrieve instances of these base materials from the cache.

var
material_flags
–

Various flags. See [material_properties.dm]

var
mixOnly
–

Can this only be used after being combined with another material?

var
mutable
– /tmp

Is this a mutable instance? Defaults to true so creating new materials returns a mutable instance by default

var
name
–

Name of the material, used for combination and scanning

var
parent_materials
– /list

Holds the parent materials.

var
prefixes
– /list

words that go before the name, used in combination

var
properties
– /list

Associated list of all the various /datum/material_property that apply. list/datum/material_property = value

var
special_naming
–

Whether the specaialNaming proc is called when this material is applied.

var
suffixes
– /list

words that go after the name, used in combination

var
texture
–

if not null, texture will be set when mat is applied.

var
texture_blend
–

How to blend the /datum/material/var/texture.

var
triggersChem
– /list

Called when exposed to chemicals.

var
triggersDrop
– /list

Called when owning object is dropped.

var
triggersExp
– /list

Called when exposed to explosions.

var
triggersOnAdd
– /list

Called when the material is added to an object

var
triggersOnAttack
– /list

Called when the owning object is used to attack something or someone.

var
triggersOnAttacked
– /list

Called when a mob wearing the owning object is attacked.

var
triggersOnBlobHit
– /list

Called when blob hits something with this material assigned.

var
triggersOnBullet
– /list

Called when a mob wearing the owning object is shot.

var
triggersOnEat
– /list

Called when someone eats a thing with this material assigned.

var
triggersOnEntered
– /list

Called when something enters a turf with the material assigned. Also called on all objects on the turf with a material.

var
triggersOnHit
– /list

Called when an obj hits something with this material assigned.

var
triggersOnLife
– /list

Called when the life proc of a mob that has the owning item equipped runs.

var
triggersOnRemove
– /list

Called when the material is removed from an object

var
triggersPickup
– /list

Called when owning object is picked up.

var
triggersTemp
– /list

Called when exposed to temperatures.

var
value
–

In percent of a base value. How much this sells for.

Proc Details

proc
addTrigger
(triggerListName, /datum/materialProc/D)

Triggers is specified using one of the TRIGGER_ON_ defines

proc
countTriggers
(triggerListName)

Triggers is specified using one of the TRIGGER_ON_ defines

proc
getImmutable
()

Returns an immutable version of this material. Will return this material if it is already immutable.

proc
getMaterialTraitDesc
()

Time for some super verbose proc names.

proc
getMutable
()

Returns a mutable version of this material. Will return a copy of this material if it is already mutable. The reason this is a separate proc and not using in getMaterial() is prevent cargo-culting accidentally reintroducing the issue this was supposed to fix. Force the coders to explicitly ask for a mutable instance, demand to know why they want it to be mutable in reviews!

proc
hasTrigger
(triggerListName, materialProcType)

Checks if material proc type is present for a given trigger in the material

proc
isSameMaterial
(/datum/material/M2)

Compares a material to this one to determine if stacking should be allowed.

proc
removeAllTriggers
(triggerListName)

Triggers is specified using one of the TRIGGER_ON_ defines

proc
removeTrigger
(triggerListName, inType)

Triggers is specified using one of the TRIGGER_ON_ defines

/datum/material

Vars

Procs

Var Details

var alpha –

var applyColor –

var cached –

var canMix –

var color –

var desc –

var edible –

var edible_exact –

var generation –

var mat_id –

var material_flags –

var mixOnly –

var mutable – /tmp

var name –

var parent_materials – /list

var prefixes – /list

var properties – /list

var special_naming –

var suffixes – /list

var texture –

var texture_blend –

var triggersChem – /list

var triggersDrop – /list

var triggersExp – /list

var triggersOnAdd – /list

var triggersOnAttack – /list

var triggersOnAttacked – /list

var triggersOnBlobHit – /list

var triggersOnBullet – /list

var triggersOnEat – /list

var triggersOnEntered – /list

var triggersOnHit – /list

var triggersOnLife – /list

var triggersOnRemove – /list

var triggersPickup – /list

var triggersTemp – /list

var value –

Proc Details

proc addTrigger(triggerListName, /datum/materialProc/D)

proc countTriggers(triggerListName)

proc getImmutable()

proc getMaterialTraitDesc()

proc getMutable()

proc hasTrigger(triggerListName, materialProcType)

proc isSameMaterial(/datum/material/M2)

proc removeAllTriggers(triggerListName)

proc removeTrigger(triggerListName, inType)

var
alpha
–

var
applyColor
–

var
cached
–

var
canMix
–

var
color
–

var
desc
–

var
edible
–

var
edible_exact
–

var
generation
–

var
mat_id
–

var
material_flags
–

var
mixOnly
–

var
mutable
– /tmp

var
name
–

var
parent_materials
– /list

var
prefixes
– /list

var
properties
– /list

var
special_naming
–

var
suffixes
– /list

var
texture
–

var
texture_blend
–

var
triggersChem
– /list

var
triggersDrop
– /list

var
triggersExp
– /list

var
triggersOnAdd
– /list

var
triggersOnAttack
– /list

var
triggersOnAttacked
– /list

var
triggersOnBlobHit
– /list

var
triggersOnBullet
– /list

var
triggersOnEat
– /list

var
triggersOnEntered
– /list

var
triggersOnHit
– /list

var
triggersOnLife
– /list

var
triggersOnRemove
– /list

var
triggersPickup
– /list

var
triggersTemp
– /list

var
value
–

proc
addTrigger
(triggerListName, /datum/materialProc/D)

proc
countTriggers
(triggerListName)

proc
getImmutable
()

proc
getMaterialTraitDesc
()

proc
getMutable
()

proc
hasTrigger
(triggerListName, materialProcType)

proc
isSameMaterial
(/datum/material/M2)

proc
removeAllTriggers
(triggerListName)

proc
removeTrigger
(triggerListName, inType)