screeps-api
    Preparing search index...

    Interface Decoration<P>

    Represents a single non-BadgeDecoration decoration. instances of each decoration can be earned by users via pixelization.

    interface Decoration<P extends string> {
        __v: number;
        _id: string;
        description: string;
        enabled?: boolean;
        graphics: ({ url: string } & { [key in string]: unknown })[];
        group: string;
        groupDescription: string | null;
        name: string;
        objectType?: RoomObjectType;
        preview: { "128x128": string; "256x256": string; original: string };
        props: { [key in string]: DecorationProperty };
        rarity: number;
        rarityMultiplier?: number;
        restricted?: boolean;
        steam: number;
        steamItemDefId: number;
        theme: string;
        type:
            | "object"
            | "creep"
            | "floorLandscape"
            | "wallGraffiti"
            | "wallLandscape";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    __v _id description enabled? graphics group groupDescription name objectType? preview props rarity rarityMultiplier? restricted? steam steamItemDefId theme type

    Properties

    __v

    __v: number

    Appears to always be 0

    _id

    _id: string
    description: string

    Appears to always be a .svg filename

    enabled?: boolean

    Whether or not this decoration is being used somewhere

    graphics: ({ url: string } & { [key in string]: unknown })[]

    Type Declaration

    • url: string

      Image asset URL (appears to always be an SVG file)

    group: string

    Group ID

    groupDescription: string | null
    name: string
    objectType?: RoomObjectType

    For object decorations; if defined, indicates the type of room object this can be applied to (ex: 'controller')

    preview: { "128x128": string; "256x256": string; original: string }

    Preview image asset URLs

    props: { [key in string]: DecorationProperty }

    Configurable properties of a decoration

    rarity: number

    Number from 1 (least rare) to 5 (most rare)

    rarityMultiplier?: number
    restricted?: boolean

    For object decorations; indicates whether objectType is present

    steam: number
    steamItemDefId: number
    theme: string

    Theme ID

    type: "object" | "creep" | "floorLandscape" | "wallGraffiti" | "wallLandscape"

    Settings

    Member Visibility

    On This Page

    Properties