material

Vars
alpha	Base alpha of the material
cached_texture_filter_icon	A cached icon for the texture filter
color	Base color of the material, for items that don't have greyscale configs nor are made of multiple materials. Item isn't changed in color if this is null. This can be a RGB or color matrix, but it cannot be RGBA as alpha is automatically filled in.
debris_type	What type of debris the tile will leave behind when shattered.
desc	A short description of the material. Not used anywhere, yet...
greyscale_color	If the color is a color matrix and either the item uses greyscale configs or is made of multiple colored materials. This will be used instead because neither greyscale configs nor BlendRGB() support color matrices. Also this has to be RRGGBB, six characters, no alpha channel as it's automatically filled in.
id	What the material is indexed by in the SSmaterials.materials list. Defaults to the type of the material.
init_flags	Bitflags that influence how SSmaterials handles this material.
item_sound_override	Can be used to override the sound items make, lets add some SLOSHing.
mat_flags	Material behaviors, controls how the material is categorized and in what recipes it can be used
mat_properties	List of material property IDs to their values, 0 - 10
mat_rust_resistance	How resistant the material is to rusting when applied to a turf
material_reagent	Reagent type(s) of this material. Can be a reagent typepath or a list.
mineral_rarity	How likely this mineral is to be found in a boulder during mining.
minimum_value_override	This is the minimum value of the material, used in the stock market for any mat that isn't set to null
name	What the material is referred to as IC.
ore_type	What type of ore is this material associated with? Used for mining, and not every material has one.
points_per_unit	How many points per units of ore does this grant?
shard_type	What type of shard the material will shatter to
sheet_type	The type of sheet this material creates.
starlight_color	Starlight color of the material This is the color of light it'll emit if its turf is transparent and over space. Defaults to GLOB.starlight_color if not set
texture_layer_icon_state	What texture icon state to overlay
tradable	Is this material traded on the stock market?
tradable_base_quantity	If this material is tradable, what is the base quantity of the material on the stock market?
turf_sound_override	Can be used to override the stepsound a turf makes. MORE SLOOOSH
value_per_unit	This is the amount of value per 1 unit of the material
Procs
Initialize
get_armor_modifiers	Returns the list of armor modifiers, with each element having its assoc value multiplied by the multiplier arg
on_accidental_mat_consumption	This proc is called when the mat is found in an item that's consumed by accident. see /obj/item/proc/on_accidental_consumption. Arguments
on_applied	This proc is called when the material is added to an object.
on_edible_applied	Called in `/datum/component/edible/proc/on_material_effects`
on_edible_removed	Called in `/datum/component/edible/proc/on_remove_material_effects`
on_main_applied	This proc is called when the material becomes the one the object is composed of the most
on_main_removed	This proc is called when the material is no longer the one the object is composed by the most
on_removed	This proc is called when the material is removed from an object.
return_composition

Var Details

var
alpha

Base alpha of the material

var
cached_texture_filter_icon
– /icon

A cached icon for the texture filter

var
color

Base color of the material, for items that don't have greyscale configs nor are made of multiple materials. Item isn't changed in color if this is null. This can be a RGB or color matrix, but it cannot be RGBA as alpha is automatically filled in.

var
debris_type
– /obj/effect/decal

What type of debris the tile will leave behind when shattered.

var
desc

A short description of the material. Not used anywhere, yet...

var
greyscale_color

If the color is a color matrix and either the item uses greyscale configs or is made of multiple colored materials. This will be used instead because neither greyscale configs nor BlendRGB() support color matrices. Also this has to be RRGGBB, six characters, no alpha channel as it's automatically filled in.

Basically, set this if the color is a color matrix (list)

var
id

What the material is indexed by in the SSmaterials.materials list. Defaults to the type of the material.

var
init_flags

Bitflags that influence how SSmaterials handles this material.

var
item_sound_override

Can be used to override the sound items make, lets add some SLOSHing.

var
mat_flags

Material behaviors, controls how the material is categorized and in what recipes it can be used

var
mat_properties

List of material property IDs to their values, 0 - 10

var
mat_rust_resistance

How resistant the material is to rusting when applied to a turf

var
material_reagent
– /list

Reagent type(s) of this material. Can be a reagent typepath or a list.

var
mineral_rarity

How likely this mineral is to be found in a boulder during mining.

var
minimum_value_override

This is the minimum value of the material, used in the stock market for any mat that isn't set to null

var
name

What the material is referred to as IC.

var
ore_type
– /obj/item

What type of ore is this material associated with? Used for mining, and not every material has one.

var
points_per_unit

How many points per units of ore does this grant?

var
shard_type
– /obj/item

What type of shard the material will shatter to

var
sheet_type

The type of sheet this material creates.

var
starlight_color

Starlight color of the material This is the color of light it'll emit if its turf is transparent and over space. Defaults to GLOB.starlight_color if not set

var
texture_layer_icon_state

What texture icon state to overlay

var
tradable

Is this material traded on the stock market?

var
tradable_base_quantity

If this material is tradable, what is the base quantity of the material on the stock market?

var
turf_sound_override

Can be used to override the stepsound a turf makes. MORE SLOOOSH

var
value_per_unit

This is the amount of value per 1 unit of the material

Proc Details

proc
Initialize
(_id, ...)

Handles initializing the material.
Arguments:
- _id: The ID the material should use. Overrides the existing ID.

proc
get_armor_modifiers
(multiplier)

Returns the list of armor modifiers, with each element having its assoc value multiplied by the multiplier arg

proc
on_accidental_mat_consumption
(/mob/living/carbon/victim, /obj/item/source_item)

This proc is called when the mat is found in an item that's consumed by accident. see /obj/item/proc/on_accidental_consumption. Arguments

M - person consuming the mat
S - (optional) item the mat is contained in (NOT the item with the mat itself)

proc
on_applied
(/atom/source, mat_amount, multiplier)

This proc is called when the material is added to an object.

proc
on_edible_applied
(/atom/source, /datum/component/edible/edible)

Called in /datum/component/edible/proc/on_material_effects

proc
on_edible_removed
(/atom/source, /datum/component/edible/edible)

Called in /datum/component/edible/proc/on_remove_material_effects

proc
on_main_applied
(/atom/source, mat_amount, multiplier)

This proc is called when the material becomes the one the object is composed of the most

proc
on_main_removed
(/atom/source, mat_amount, multiplier)

This proc is called when the material is no longer the one the object is composed by the most

proc
on_removed
(/atom/source, amount, material_flags)

This proc is called when the material is removed from an object.

proc
return_composition
(amount, flags)

Returns the composition of this material.
Mostly used for alloys when breaking down materials.
Arguments:
- amount: The amount of the material to break down.

material /datum/material

Vars

Procs

Var Details

var alpha

var cached_texture_filter_icon – /icon

var color

var debris_type – /obj/effect/decal

var desc

var greyscale_color

var id

var init_flags

var item_sound_override

var mat_flags

var mat_properties

var mat_rust_resistance

var material_reagent – /list

var mineral_rarity

var minimum_value_override

var name

var ore_type – /obj/item

var points_per_unit

var shard_type – /obj/item

var sheet_type

var starlight_color

var texture_layer_icon_state

var tradable

var tradable_base_quantity

var turf_sound_override

var value_per_unit