Component:Consumable

Consumable allows an item to be consumed by bringing it to the avatar's mouth. It was introduced in build 2026.4.1.11

Component image 

Consumable component as seen in the Scene Inspector

Consumable Allows the item to be consumed by users.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
MustBeHolding	Bool	Only allow component to be triggered when held. Needs to be paired by a grabbable in the same slot.
CanFeedToOthers	Bool
OverrideReferencePoint	Slot
Radius	Float
StartHysteresis	Float
CurrentStageIndex	Int
IsBeingConsumed	raw output of Bool
HasBeenFullyConsumed	raw output of Bool
CurrentlyConsumingUser	direct UserRef
DestroyOnConsumed	Bool
OnAnyStageConsumed	list of Action
OnFullyConsumed	list of Action
Stages	list of Consumable.Stage
_waitingForReset	Bool

Stage

Fields

Name	Type	Description
ConsumeTime	Float
OverrideReferencePoint	Slot
KeepConsumeProgressOnPause	Bool
WaitForResetBeforeStart	Bool
IsBeingConsumed	raw output of Bool
HasBeenConsumed	raw output of Bool
IsStageActive	raw output of Bool
ConsumedByUser	direct UserRef
NormalizedConsumeProgress	Float
StageActiveDrive	field drive of Bool
OnStageConsumed	list of Action

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
Visualize:ButtonEventHandler	ButtonEventHandler	✓	Visualizes the data for this component.

See Also

• ProtoFlux:OnConsumableConsuming
• ProtoFlux:OnConsumableFullyConsumed
• ProtoFlux:OnConsumableStageConsumed