Component: Button helper (Helpers): Difference between revisions

Latest revision as of 14:22, 13 July 2026

Author	Matrix Ltd
Version	1.1
Category	Helpers

Button helper component

A button overlay that allows any object to behave like a button

Component Source Code

Please click here to download the component source project: FC_Comp_Source_buttonhelper.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_buttonhelper.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Clear

	Clear
Clears all objects from the lists This leaves no links for the button helper
- VOID	Return

GetState

	GetState
Returns true if the button is depressed, else false
- BOOL	Return

GetStateFor

	GetStateFor
Returns true if the button is depressed, else false
- HANDLE	Target

- BOOL	Return

GetTarget

	GetTarget
Gets the target handle the property links to
- HANDLE	Return

Register

	Register
Adds the object to the list if not already there
- HANDLE	Target

- VOID	Return

SetAutoReset

	SetAutoReset
Sets the state of the auto-reset flag If the flag is true (it is by default) then Button Helper will reset the state of each button on stop
- BOOL	State
Set true to reset to off on sim stop, else false to retain state
- VOID	Return

SetAxis

	SetAxis
Sets the movement axis as an Axis_... constant
- BYTE	Axis
Movement axis to set to, default 4
- VOID	Return

SetAxisFor

	SetAxisFor
Sets the movement axis as an Axis_... constant
- HANDLE	Target

- BYTE	Axis
Movement axis to set to, default 4
- VOID	Return

SetDisabledPos

	SetDisabledPos
Sets the position of the released button
- HANDLE	PositionHandle
A handle to the position of the depressed location
- VOID	Return

SetDisabledPosFor

	SetDisabledPosFor
Sets the disabled position for an object
- HANDLE	Target

- HANDLE	Position

- VOID	Return

SetEnabledPos

	SetEnabledPos
Sets the position of the depressed button
- HANDLE	PositionHandle
A handle to the position of the depressed location
- VOID	Return

SetEnabledPosFor

	SetEnabledPosFor
Sets the enabled position for an object
- HANDLE	Target

- HANDLE	Position

- VOID	Return

SetLatching

	SetLatching
Sets whether the button is depressed when the mouse is released
- BOOL	Enabled

- VOID	Return

SetLatchingFor

	SetLatchingFor
Sets whether the button is depressed when the mouse is released
- HANDLE	Target

- BOOL	Enabled

- VOID	Return

SetMode

	SetMode
Sets the animation mode for the button
- BYTE	Mode
0=User, 1=Up/Down, 2 = Lever
- VOID	Return

SetModeFor

	SetModeFor
Sets the animation mode for the button
- HANDLE	Target
The target object, 0 for 'set default'
- BYTE	Mode
0=User, 1=Up/Down, 2 = Lever
- VOID	Return

SetMovement

	SetMovement
Sets the movement in units or PI/16 steps for the button
- FLOAT	Move
Movement to set to - default is 4
- VOID	Return

SetMovementFor

	SetMovementFor
Sets the movement in units or PI/16 steps for the button
- HANDLE	Target

- FLOAT	Move
Movement to set to, default 4
- VOID	Return

SetNotify

	SetNotify
Sets the object to notify when the button is pressed or released
- HANDLE	Handle
The handle of the object - 0 to use the caller object
- ULONG	Ident
The identifier to send in the System.Notify message
- VOID	Return

SetPivotPos

	SetPivotPos
Sets the position of the object the lever rotates around
- HANDLE	PositionHandle
A handle to the position of the depressed location
- VOID	Return

SetPivotPosFor

	SetPivotPosFor
Sets the position the lever rotates around for an object
- HANDLE	Target

- HANDLE	Position

- VOID	Return

Unregister

	Unregister
Removes the object to the list if present
- HANDLE	Target

- VOID	Return

Property reference

	Properties
	Host component

	Lever pivot

@@ Line 74: / Line 74: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
+| width="90%" class="mtx-class-macrohead" | '''Clear'''
 |-
 | colspan="2" | Clears all objects from the lists This leaves no links for the button helper&nbsp;
@@ Line 88: / Line 88: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetState'''
+| width="90%" class="mtx-class-macrohead" | '''GetState'''
 |-
 | colspan="2" | Returns true if the button is depressed, else false&nbsp;
@@ Line 102: / Line 102: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStateFor'''
+| width="90%" class="mtx-class-macrohead" | '''GetStateFor'''
 |-
 | colspan="2" | Returns true if the button is depressed, else false&nbsp;
@@ Line 121: / Line 121: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTarget'''
+| width="90%" class="mtx-class-macrohead" | '''GetTarget'''
 |-
 | colspan="2" | Gets the target handle the property links to&nbsp;
@@ Line 135: / Line 135: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register'''
+| width="90%" class="mtx-class-macrohead" | '''Register'''
 |-
 | colspan="2" | Adds the object to the list if not already there&nbsp;
@@ Line 154: / Line 154: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAutoReset'''
+| width="90%" class="mtx-class-macrohead" | '''SetAutoReset'''
 |-
 | colspan="2" | Sets the state of the auto-reset flag If the flag is true (it is by default) then Button Helper will reset the state of each button on stop &nbsp;
@@ Line 173: / Line 173: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAxis'''
+| width="90%" class="mtx-class-macrohead" | '''SetAxis'''
 |-
 | colspan="2" | Sets the movement axis as an Axis_... constant&nbsp;
@@ Line 192: / Line 192: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAxisFor'''
+| width="90%" class="mtx-class-macrohead" | '''SetAxisFor'''
 |-
 | colspan="2" | Sets the movement axis as an Axis_... constant&nbsp;
@@ Line 216: / Line 216: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPos'''
+| width="90%" class="mtx-class-macrohead" | '''SetDisabledPos'''
 |-
 | colspan="2" | Sets the position of the released button &nbsp;
@@ Line 235: / Line 235: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPosFor'''
+| width="90%" class="mtx-class-macrohead" | '''SetDisabledPosFor'''
 |-
 | colspan="2" | Sets the disabled position for an object&nbsp;
@@ Line 259: / Line 259: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEnabledPos'''
+| width="90%" class="mtx-class-macrohead" | '''SetEnabledPos'''
 |-
 | colspan="2" | Sets the position of the depressed button &nbsp;
@@ Line 278: / Line 278: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEnabledPosFor'''
+| width="90%" class="mtx-class-macrohead" | '''SetEnabledPosFor'''
 |-
 | colspan="2" | Sets the enabled position for an object&nbsp;
@@ Line 302: / Line 302: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLatching'''
+| width="90%" class="mtx-class-macrohead" | '''SetLatching'''
 |-
 | colspan="2" | Sets whether the button is depressed when the mouse is released&nbsp;
@@ Line 321: / Line 321: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLatchingFor'''
+| width="90%" class="mtx-class-macrohead" | '''SetLatchingFor'''
 |-
 | colspan="2" | Sets whether the button is depressed when the mouse is released&nbsp;
@@ Line 345: / Line 345: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMode'''
+| width="90%" class="mtx-class-macrohead" | '''SetMode'''
 |-
 | colspan="2" | Sets the animation mode for the button&nbsp;
@@ Line 364: / Line 364: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetModeFor'''
+| width="90%" class="mtx-class-macrohead" | '''SetModeFor'''
 |-
 | colspan="2" | Sets the animation mode for the button&nbsp;
@@ Line 388: / Line 388: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovement'''
+| width="90%" class="mtx-class-macrohead" | '''SetMovement'''
 |-
 | colspan="2" | Sets the movement in units or PI/16 steps for the button&nbsp;
@@ Line 407: / Line 407: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovementFor'''
+| width="90%" class="mtx-class-macrohead" | '''SetMovementFor'''
 |-
 | colspan="2" | Sets the movement in units or PI/16 steps for the button&nbsp;
@@ Line 431: / Line 431: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetNotify'''
+| width="90%" class="mtx-class-macrohead" | '''SetNotify'''
 |-
 | colspan="2" | Sets the object to notify when the button is pressed or released &nbsp;
@@ Line 455: / Line 455: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPos'''
+| width="90%" class="mtx-class-macrohead" | '''SetPivotPos'''
 |-
 | colspan="2" | Sets the position of the object the lever rotates around &nbsp;
@@ Line 474: / Line 474: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPosFor'''
+| width="90%" class="mtx-class-macrohead" | '''SetPivotPosFor'''
 |-
 | colspan="2" | Sets the position the lever rotates around for an object&nbsp;
@@ Line 498: / Line 498: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Unregister'''
+| width="90%" class="mtx-class-macrohead" | '''Unregister'''
 |-
 | colspan="2" | Removes the object to the list if present&nbsp;
@@ Line 518: / Line 518: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)