Difference between revisions of "Component: Button helper (Helpers)"
From Flowcode Help
Jump to navigationJump to search| (6 intermediate revisions by the same user not shown) | |||
| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 42: | Line 50: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ==Macro reference== | ||
| + | ===Clear=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Clears all objects from the lists This leaves no links for the button helper |
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 199: | Line 85: | ||
| + | ===GetState=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetState''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Returns true if the button is depressed, else false |
|- | |- | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===GetStateFor=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStateFor''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Returns true if the button is depressed, else false |
|- | |- | ||
|- | |- | ||
| Line 235: | Line 113: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===GetTarget=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTarget''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Gets the target handle the property links to |
|- | |- | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===Register=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Adds the object to the list if not already there |
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| width="90%" | Target | | width="90%" | Target | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 286: | Line 151: | ||
| + | ===SetAutoReset=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAutoReset''' |
|- | |- | ||
| − | | colspan="2" | Sets the | + | | 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 |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL |
| − | | width="90%" | | + | | width="90%" | State |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Set true to reset to off on sim stop, else false to retain state |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 309: | Line 170: | ||
| + | ===SetAxis=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAxis''' |
| − | |||
| − | |||
|- | |- | ||
| + | | colspan="2" | Sets the movement axis as an Axis_... constant | ||
|- | |- | ||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| − | | width="90%" | | + | | width="90%" | Axis |
|- | |- | ||
| − | + | | colspan="2" | Movement axis to set to, default 4 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | colspan="2" | Movement to set to | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 350: | Line 189: | ||
| + | ===SetAxisFor=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 373: | Line 213: | ||
| + | ===SetDisabledPos=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPos''' |
|- | |- | ||
| − | | colspan="2" | Sets the position of the | + | | colspan="2" | Sets the position of the released button |
|- | |- | ||
|- | |- | ||
| Line 391: | Line 232: | ||
| + | ===SetDisabledPosFor=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPosFor''' |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | + | | colspan="2" | Sets the disabled position for an object | |
| − | |||
| − | |||
| − | |||
| − | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|- | |- | ||
| Line 439: | Line 245: | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| − | | width="90%" | | + | | width="90%" | Position |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 538: | Line 256: | ||
| + | ===SetEnabledPos=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 556: | Line 275: | ||
| + | ===SetEnabledPosFor=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEnabledPosFor''' |
|- | |- | ||
| − | | colspan="2" | Sets the | + | | colspan="2" | Sets the enabled position for an object |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|- | |- | ||
| Line 597: | Line 299: | ||
| + | ===SetLatching=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLatching''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Sets whether the button is depressed when the mouse is released |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center | + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL |
| − | + | | width="90%" | Enabled | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="90%" | | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 641: | Line 318: | ||
| − | + | ===SetLatchingFor=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 687: | Line 342: | ||
| + | ===SetMode=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 705: | Line 361: | ||
| − | + | ===SetModeFor=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 774: | Line 385: | ||
| + | ===SetMovement=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 792: | Line 404: | ||
| + | ===SetMovementFor=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovementFor''' |
|- | |- | ||
| − | | colspan="2" | Sets the movement | + | | colspan="2" | Sets the movement in units or PI/16 steps for the button |
|- | |- | ||
|- | |- | ||
| Line 805: | Line 418: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| − | | width="90%" | | + | | width="90%" | Move |
|- | |- | ||
| − | | colspan="2" | Movement | + | | colspan="2" | Movement to set to, default 4 |
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 815: | Line 428: | ||
| + | ===SetNotify=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetNotify''' |
|- | |- | ||
| − | | colspan="2" | Sets | + | | colspan="2" | Sets the object to notify when the button is pressed or released |
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| − | | width="90%" | | + | | width="90%" | Handle |
| + | |- | ||
| + | | colspan="2" | The handle of the object - 0 to use the caller object | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Ident | ||
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | The identifier to send in the System.Notify message |
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 833: | Line 452: | ||
| + | ===SetPivotPos=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPos''' |
|- | |- | ||
| − | | colspan="2" | Sets the | + | | colspan="2" | Sets the position of the object the lever rotates around |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | | width="90%" | | + | | width="90%" | PositionHandle |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | A handle to the position of the depressed location |
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 851: | Line 471: | ||
| + | ===SetPivotPosFor=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPosFor''' |
|- | |- | ||
| − | | colspan="2" | Sets | + | | colspan="2" | Sets the position the lever rotates around for an object |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | | width="90%" | | + | | width="90%" | Target |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| − | | width="90%" | | + | | width="90%" | Position |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 887: | Line 495: | ||
| + | ===Unregister=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Unregister''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Removes the object to the list if present |
|- | |- | ||
|- | |- | ||
| Line 899: | Line 508: | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
Latest revision as of 13:13, 7 February 2023
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Helpers |
Contents
- 1 Button helper component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 Clear
- 5.2 GetState
- 5.3 GetStateFor
- 5.4 GetTarget
- 5.5 Register
- 5.6 SetAutoReset
- 5.7 SetAxis
- 5.8 SetAxisFor
- 5.9 SetDisabledPos
- 5.10 SetDisabledPosFor
- 5.11 SetEnabledPos
- 5.12 SetEnabledPosFor
- 5.13 SetLatching
- 5.14 SetLatchingFor
- 5.15 SetMode
- 5.16 SetModeFor
- 5.17 SetMovement
- 5.18 SetMovementFor
- 5.19 SetNotify
- 5.20 SetPivotPos
- 5.21 SetPivotPosFor
- 5.22 Unregister
- 6 Property reference
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 |
