SlashCo Wiki

Document

Document

Description

Table structure used for SlashCo.RegisterDocument.

Parameters

string Name

The name of the document.

string Type

The document's type. Can be any value, but "Slasher" is the convention used for every document related to a Slasher, and is required for the document to be picked up automatically by SlashCo.EndRound's hand-out logic.

Default: Slasher

string Slasher (Optional)

The ID of the Slasher this document belongs to. Defaults to Name if not set.
Only relevant when Type is "Slasher".

number Class (Optional)

The Slasher's SlashCo.SlasherClass.
Only required if Document.Slasher isn't set and no registered Slasher matches Name (e.g. for a document like Hat Man, who isn't a playable Slasher).

number DangerLevel (Optional)

The Slasher's DangerLevel.
Only required under the same conditions as Class.

string ID (Optional)

Used to look up the document's material icon.
Only required under the same conditions as Class.

string Description

The description shown as soon as the player receives the document.

string AdditionalDescription (Optional)

An extra description shown once the player has survived the Slasher.

table Aliases (Optional)

A list of alternate name strings shown alongside the document, translated through the language key Alias_.
If not set, falls back to the matching SLASHER's own SLASHER.Aliases field.