material

Vars
alpha	Base alpha of the material, is used for greyscale icons.
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.gold
coin_type	The type of coin this material spawns. This should be replaced as soon as possible by greyscale coins.
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.
greyscale_colors	Determines the color palette of the material. Formatted the same as atom/var/greyscale_colors
id	Var that's mostly used by science machines to identify specific materials, should most likely be phased out at some point
integrity_modifier	This is a modifier for integrity, and resembles the strength of the material
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
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
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.gold

var
coin_type
–

The type of coin this material spawns. This should be replaced as soon as possible by greyscale coins.

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

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

var
id
–

Var that's mostly used by science machines to identify specific materials, should most likely be phased out at some point

var
integrity_modifier
–

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

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

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

var categories – /list

var coin_type –

var color –

var greyscale_colors –

var id –

var integrity_modifier –

var sheet_type –

var strength_modifier –

var texture_layer_icon_state –