material

Vars
added_slowdown	The slowdown that is added to items.
alpha	Base alpha of the material
armor_modifiers	Armor modifiers, multiplies an items normal armor vars by these amounts.
beauty_modifier	How beautiful is this material per unit.
cached_texture_filter_icon	a cached icon for the texture filter
categories	Materials "Traits". its a map of key = category \| Value = Bool. Used to define what it can be used for
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...
fish_weight_modifier	Fish made of or infused with this material have their weight multiplied by this value.
fishing_bait_speed_mult	The multiplier of the bait/bobber speed of the fishing challenge for fishing rods made of this material
fishing_bounciness_mult	The multiplier of the bounciness of the bait/bobber upon hitting the edges of the minigame area
fishing_cast_range	Additive bonus/malus to the cast range of the fishing rod
fishing_completion_speed	The multiplier to the completion gain of the fishing rod made of this material
fishing_deceleration_mult	The multiplier of the deceleration/friction for fishing rods made of this material
fishing_difficulty_modifier	Additive bonus/malus to the fishing difficulty modifier of any rod made of this item. Negative is good, positive bad
fishing_experience_multiplier	The multiplier of how much experience is gained when using a fishing rod made of this material
fishing_gravity_mult	The multiplier of negative velocity that pulls the bait/bobber of a fishing rod down when not holding the click
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.
integrity_modifier	This is a modifier for integrity, and resembles the strength of the material
item_sound_override	Can be used to override the sound items make, lets add some SLOSHing.
mat_rust_resistance	How resistant the material is to rusting when applied to a turf
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. This should be replaced as soon as possible by greyscale sheets
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 COLOR_STARLIGHT if not set
strength_modifier	This is a modifier for force, and resembles the strength of the material
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_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
added_slowdown
–

The slowdown that is added to items.

var
alpha
–

Base alpha of the material

var
armor_modifiers
–

Armor modifiers, multiplies an items normal armor vars by these amounts.

var
beauty_modifier
–

How beautiful is this material per unit.

var
cached_texture_filter_icon
–

a cached icon for the texture filter

var
categories
– /list

Materials "Traits". its a map of key = category | Value = Bool. Used to define what it can be used for

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
fish_weight_modifier
–

Fish made of or infused with this material have their weight multiplied by this value.

var
fishing_bait_speed_mult
–

The multiplier of the bait/bobber speed of the fishing challenge for fishing rods made of this material

var
fishing_bounciness_mult
–

The multiplier of the bounciness of the bait/bobber upon hitting the edges of the minigame area

var
fishing_cast_range
–

Additive bonus/malus to the cast range of the fishing rod

var
fishing_completion_speed
–

The multiplier to the completion gain of the fishing rod made of this material

var
fishing_deceleration_mult
–

The multiplier of the deceleration/friction for fishing rods made of this material

var
fishing_difficulty_modifier
–

Additive bonus/malus to the fishing difficulty modifier of any rod made of this item. Negative is good, positive bad

var
fishing_experience_multiplier
–

The multiplier of how much experience is gained when using a fishing rod made of this material

var
fishing_gravity_mult
–

The multiplier of negative velocity that pulls the bait/bobber of a fishing rod down when not holding the click

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
integrity_modifier
–

This is a modifier for integrity, and resembles the strength of the material

var
item_sound_override
–

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

var
mat_rust_resistance
–

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

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. This should be replaced as soon as possible by greyscale sheets

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 COLOR_STARLIGHT if not set

var
strength_modifier
–

This is a modifier for force, and resembles the strength of the material

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/M, /obj/item/S)

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_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)

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 added_slowdown –

var alpha –

var armor_modifiers –

var beauty_modifier –

var cached_texture_filter_icon –

var categories – /list

var color –

var debris_type – /obj/effect/decal

var desc –

var fish_weight_modifier –

var fishing_bait_speed_mult –

var fishing_bounciness_mult –

var fishing_cast_range –

var fishing_completion_speed –

var fishing_deceleration_mult –

var fishing_difficulty_modifier –

var fishing_experience_multiplier –

var fishing_gravity_mult –

var greyscale_color –

var id –

var init_flags –

var integrity_modifier –

var item_sound_override –

var mat_rust_resistance –

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 strength_modifier –

var texture_layer_icon_state –

var tradable –

var tradable_base_quantity –

var turf_sound_override –

var value_per_unit –