Skip to main content

On Craftengine Furniture Hit Event

Triggers when a player hits CraftEngine furniture

Fires when a player hits furniture without breaking it, which the break event never reports.

Fields

FieldTypeDefaultDescription
furnitureIdString—The furniture ID that triggers this event (e.g., 'namespace:furniture_id'). Leave empty for any furniture.
locationOptional<Var<Position>>—The location of the furniture that was hit (optional)
permissionString—A permission the player must hold for the hit to be allowed. Leave empty to skip the check.
allowWhenList<Criteria>emptyFacts the player must satisfy for the hit to be allowed. When unmet, the hit is refused.
cancelBooleantrueWhether to stop the hit when the requirements are unmet. Turn off to only fire the triggers.
repeatGuardMillisInt250Milliseconds a held button is treated as one hit. A held left click otherwise fires this every tick. Set to 0 to fire on every repeat.
Common TypeWriter fields (triggers)
FieldTypeDefaultDescription
triggersList<Ref<TriggerableEntry>>empty—