material

Vars
alpha	Base alpha of the material, is used for greyscale icons.
armor_modifiers	Armor modifiers, multiplies an items normal armor vars by these amounts.
beauty_modifier	How beautiful is this material per unit.
bespoke	If set to TRUE, this material doesn't generate at roundstart, and generates unique instances based on the variables passed to GET_MATERIAL_REF
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, is used for greyscale. Item isn't changed in color if this is null. Deprecated, use greyscale_color instead.
desc	A short description of the material. Not used anywhere, yet...
false_wall_type	Type of the false wall this material will make when used as its plating
greyscale_colors	Determines the color palette of the material. Formatted the same as atom/var/greyscale_colors
hard_wall_decon	If true, walls plated with this material that have a reinforcement, will be hard to deconstruct
id	What the material is indexed by in the SSmaterials.materials list. Defaults to the type of the 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.
low_wall_stripe_icon	Icon for painted stripes on the low walls
name	What the material is referred to as IC.
reinforced_wall_icon	Icon for reinforced walls which are plated with this material
reinforced_wall_stripe_icon	Icon for painted stripes on reinforced walls
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
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
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
wall_color	Color of walls constructed with this material as their plating
wall_icon	Icon for walls which are plated with this material
wall_name	What do we call a 'wall' made out of this stuff?
wall_stripe_icon	Icon for painted stripes on the walls
wall_type	Type of the wall this material makes when its used as a plating, null means can't make a wall out of it.
Procs
Initialize
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_applied_obj	This proc is called when the material is added to an object specifically.
on_removed	This proc is called when the material is removed from an object.
on_removed_obj	This proc is called when the material is removed from an object specifically.
return_composition

Var Details

var
alpha

Base alpha of the material, is used for greyscale icons.

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
bespoke

If set to TRUE, this material doesn't generate at roundstart, and generates unique instances based on the variables passed to GET_MATERIAL_REF

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, is used for greyscale. Item isn't changed in color if this is null. Deprecated, use greyscale_color instead.

var
desc

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

var
false_wall_type

Type of the false wall this material will make when used as its plating

var
greyscale_colors

Determines the color palette of the material. Formatted the same as atom/var/greyscale_colors

var
hard_wall_decon

If true, walls plated with this material that have a reinforcement, will be hard to deconstruct

var
id

What the material is indexed by in the SSmaterials.materials list. Defaults to the type of the 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
low_wall_stripe_icon

Icon for painted stripes on the low walls

var
name

What the material is referred to as IC.

var
reinforced_wall_icon

Icon for reinforced walls which are plated with this material

var
reinforced_wall_stripe_icon

Icon for painted stripes on reinforced walls

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

var
wall_color

Color of walls constructed with this material as their plating

var
wall_icon

Icon for walls which are plated with this material

var
wall_name

What do we call a 'wall' made out of this stuff?

var
wall_stripe_icon

Icon for painted stripes on the walls

var
wall_type

Type of the wall this material makes when its used as a plating, null means can't make a wall out of it.

Proc Details

proc
Initialize
(_id, ...)

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

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, amount, material_flags)

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

proc
on_applied_obj
(/obj/o, amount, material_flags)

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

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

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

proc
on_removed_obj
(/obj/o, amount, material_flags)

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

proc
return_composition
(amount, breakdown_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.
- breakdown_flags: Some flags dictating how exactly this material is being broken down.

material /datum/material

Vars

Procs

Var Details

var alpha

var armor_modifiers

var beauty_modifier

var bespoke

var cached_texture_filter_icon

var categories – /list

var color

var desc

var false_wall_type

var greyscale_colors

var hard_wall_decon

var id

var integrity_modifier

var item_sound_override

var low_wall_stripe_icon

var name

var reinforced_wall_icon

var reinforced_wall_stripe_icon

var shard_type – /obj/item

var sheet_type

var strength_modifier

var texture_layer_icon_state

var turf_sound_override

var value_per_unit

var wall_color

var wall_icon

var wall_name

var wall_stripe_icon

var wall_type