Skip to main content

Forcecompostable

Based on game build 714014 | Last updated: 2026-03-03

Overview

ForceCompostable is a lightweight component that designates an entity as compostable and optionally assigns it a green or brown classification, which the composting system uses to determine composition behavior and visual state in compost bins. It does not implement composting logic itself but provides the necessary metadata for other systems (e.g., compostbin) to process the item.

Usage example

local inst = CreateEntity()
inst:AddTag("compostable")
inst:AddComponent("forcecompostable")
inst.components.forcecompostable.green = true

Dependencies & tags

Components used: None identified
Tags: Requires compostable tag on the entity; does not modify tags.

Properties

PropertyTypeDefault ValueDescription
greenbooleanfalseIndicates if the item is "green" (e.g., organic waste like vegetables).
brownbooleanfalseIndicates if the item is "brown" (e.g., dry materials like leaves or sticks).

Main functions

No public methods beyond property accessors.

Events & listeners

None identified