Module:Interactables/Data/doc

From Risk of Rain 2 Wiki
Jump to navigation Jump to search

This is the documentation page for Module:Interactables/Data

Database of Risk of Rain 2's Interactables.

Interactable Entry Schema

{
    Name = "Interactable name",
    NameAlt = "Alternative name",
    NameLink = "Article link",
    ImageLink = "Image link",
    Category = "Friendly category name",
    Purchase = {
        Type = "Resource traded for activating the interactable",
        Cost = "1"
    },
    Director = {
        Category = "Director spawn card category",
        Credits = 10
    },
    Effect = "Interactable effect",
    Location = { "Rallypoint Delta" }
}
Key/Column Name Data Type Required? Explanation/Description Example(s)
Name String ✔️ Interactable name "3D Printer (White)"
NameAlt String Alternative name, used mostly for variants "3D Printer"
NameLink String Article link, defaults to "Name" "3D Printers"
ImageLink String Image link, defaults to "Name.png" "3D Printer.png"
Category String Gallery category for the Interactables article. If unspecified, it will not be included anywhere. "3D Printers"
Purchase Table (of table entries) Purchase data if the interactable has any See #Purchase Entry Schema
Director Table (of table entries) Director data if the interactable is spawned by the Scene Director See #Director Entry Schema
Effect String ✔️ Interactable effect "Item" or "Portal"
Location Table (of strings) Environments where the interactable is encountered { "Rallypoint Delta" }

Purchase Entry Schema

    Purchase = {
        Type = "Activation trade",
        Cost "5"
    }
Key/Column Name Data Type Required? Explanation/Description Example(s)
Type String ✔️ Trading resource for activation "Gold" or "Health"
Cost String ✔️ Trading amount "1" or "50%" or "All"

Director Entry Schema

    Director = {
        Category = "Spawn card category",
        Credits = 10
    }
Key/Column Name Data Type Required? Explanation/Description Example(s)
Category String ✔️ Director spawn card category "Chests"
Credits Number (integer) ✔️ Director spawn card credits 10