Skip to main content

ProximityButton

Sends trigger signals when interacted via its ProximityPrompt.

It is a craftable and spawnable non-flammable solid.

Here is a list of possible sizes that reach the maximum malleability (75) that have integer components: 1x75x1, 1x25x3, 1x15x5, 3x5x5

At its default size (1x1x1) it has a durability of 1, at its maximum size it has a durability of 5.

By default, its colour is #1b2a35.

It requires 5 Copper, 5 Iron, 15 Quartz, and 10 Silicon to be crafted.

Configurables


GamepadKeyCode

The name of the key that will trigger the proximity prompt on a gamepad. It is a string.


HoldDuration

The length of time that the proximity prompt has to be held down for. It is a number.


KeyboardKeyCode

The name of the key that will trigger the proximity prompt on a keyboard. It is a string.


MaxActivationDistance

The range of the prompt, from 0 - 50. It is a number. It ranges between 0 and 50.


ObjectText

The text of the proximity prompt. It is a string.


RequiresLineOfSight

Whether a line of sight to the center of the part is required for the prompt to become visible. It is a boolean.

Events


Configured(configurerId)

Fires when the object is configured.

The configurerId parameter is the UserId of the player who configured the object. It is a number.


PromptButtonHoldBegan


PromptButtonHoldEnded


PromptTriggerEnded


PromptTriggered