Skip to main content

Button

Button​

An input that acts as a button. While pressed down by the mouse button, it outputs a signal. When you release the mouse button, the signal is no longer outputted. The red portion is the clickable portion. Clicking anywhere else on the button (ie. the corners) will give you the settings for the button.

Constructor​

public Button​

new Button()

Creates a button. The button has 0 inputs, 1 output, and a size of 50.

Properties​

No publicly accessible properties on Button

Methods​

public isWithinPressBounds​

isWithinPressBounds(v) => false | true

Determines whether or not a point is within this component's "pressable" bounds, in this case the inner red circle.

Parameters

  •  v: Vector – The point.

Returns

  •   false | true – True if the point is within this component, false otherwise.

public isOn​

isOn() => false | true

Utility function to check if this Button is on or not.

Returns

  •   false | true – True if the Button is toggled, false otherwise.

public press​

press() => void

Activates the button (makes the output true) by calling activate.

public release​

release() => void

Deactivates the button (makes the output false) by calling activate.

public getDisplayName​

getDisplayName() => string

Returns the name of the object.

Returns

  •   string – The string "Button".

public getImageName​

getImageName() => string

Description needed

Returns

  •   string – Description needed

Static Methods​

No static methods for Button