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.
cached_texture_filter	a cached icon for the texture filter
categories	Bitflags that influence how SSmaterials handles this material. 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.
desc	A short description of the material. Not used anywhere, yet...
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.
name	What the material is referred to as IC.
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
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
cached_texture_filter
–

a cached icon for the texture filter

var
categories
– /list

Bitflags that influence how SSmaterials handles this material. 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.

var
desc
–

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

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

What the material is referred to as IC.

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

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

var categories – /list

var color –

var desc –

var id –

var integrity_modifier –

var item_sound_override –

var name –

var shard_type – /obj/item

var sheet_type –

var strength_modifier –

var texture_layer_icon_state –

var turf_sound_override –

var value_per_unit –