Difference between revisions of "Component: Joystick 2D (Controls)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Joystick_2dgi.fcfx FC_Comp_Source_Joystick_2dgi.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Joystick_2dgi.fcfx FC_Comp_Source_Joystick_2dgi.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Joystick_2dgi.fcfx FC_Comp_Source_Joystick_2dgi.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 48: | Line 50: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 76: | Line 80: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAxisAsFloat''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a single axis of the joystick and returns as a floating point value. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Axis | ||
| + | |- | ||
| + | | colspan="2" | Range 0-1 Where 0=X, 1=Y | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SimMoveThumbStick''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | X | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Y | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Component | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAxisAsInt''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a single axis of the joystick and returns as a signed integer value. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Axis | ||
| + | |- | ||
| + | | colspan="2" | Range 0-1 Where 0=X, 1=Y | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Joystick Type | ||
| + | |- | ||
| + | | colspan="2" | Defines the directions the joystick can travel. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Return To Center | ||
| + | |- | ||
| + | | colspan="2" | Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Limits | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Y Min | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Y Max | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Theme | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Box Colour | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Shaft Colour | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Knob Colour | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Style | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-12-icon.png]] | ||
| + | | width="90%" | Style | ||
| + | |- | ||
| + | | colspan="2" | Outline line style | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:57, 27 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Controls |
Contents
Joystick 2D component
A simple joystick component allowing for easy mouse or touchscreen based analogue control.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Joystick_2dgi.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Joystick_2dgi.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
ReadAxisAsFloat |
| Reads a single axis of the joystick and returns as a floating point value. | |
 - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
 - FLOAT
|
Return |
|
|
SimMoveThumbStick |
| - FLOAT
|
X |
| - FLOAT
|
Y |
 - HANDLE
|
Component |
 - VOID
|
Return |
|
|
ReadAxisAsInt |
| Reads a single axis of the joystick and returns as a signed integer value. | |
| - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
 - INT
|
Return |
Property reference
|
Properties |
|
Joystick Type |
| Defines the directions the joystick can travel. | |
|
Return To Center |
| Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released. | |
|
Limits |
|
Y Min |
|
|
Y Max |
|
|
Theme |
|
Box Colour |
|
|
Shaft Colour |
|
|
Knob Colour |
|
|
Style |
|
Style |
| Outline line style | |
==Macro reference==
|
|
ReadAxisAsFloat |
| Reads a single axis of the joystick and returns as a floating point value. | |
| - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
| - FLOAT
|
Return |
|
|
SimMoveThumbStick |
| - FLOAT
|
X |
| - FLOAT
|
Y |
| - HANDLE
|
Component |
| - VOID
|
Return |
|
|
ReadAxisAsInt |
| Reads a single axis of the joystick and returns as a signed integer value. | |
| - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
| - INT
|
Return |
Property reference
|
|
Properties |
|
|
Joystick Type |
| Defines the directions the joystick can travel. | |
|
|
Return To Center |
| Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released. | |
|
|
Limits |
|
|
Y Min |
|
|
Y Max |
|
|
Theme |
|
|
Box Colour |
|
|
Shaft Colour |
|
|
Knob Colour |
|
|
Style |
|
|
Style |
| Outline line style | |
==Macro reference==
|
|
ReadAxisAsFloat |
| Reads a single axis of the joystick and returns as a floating point value. | |
| - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
| - FLOAT
|
Return |
|
|
SimMoveThumbStick |
| - FLOAT
|
X |
| - FLOAT
|
Y |
| - HANDLE
|
Component |
| - VOID
|
Return |
|
|
ReadAxisAsInt |
| Reads a single axis of the joystick and returns as a signed integer value. | |
| - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
| - INT
|
Return |
Property reference
|
|
Properties |
|
|
Joystick Type |
| Defines the directions the joystick can travel. | |
|
|
Return To Center |
| Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released. | |
|
|
Limits |
|
|
Y Min |
|
|
Y Max |
|
|
Theme |
|
|
Box Colour |
|
|
Shaft Colour |
|
|
Knob Colour |
|
|
Style |
|
|
Style |
| Outline line style | |
==Macro reference==
|
|
ReadAxisAsFloat |
| Reads a single axis of the joystick and returns as a floating point value. | |
| - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
| - FLOAT
|
Return |
|
|
SimMoveThumbStick |
| - FLOAT
|
X |
| - FLOAT
|
Y |
| - HANDLE
|
Component |
| - VOID
|
Return |
|
|
ReadAxisAsInt |
| Reads a single axis of the joystick and returns as a signed integer value. | |
| - BYTE
|
Axis |
| Range 0-1 Where 0=X, 1=Y | |
| - INT
|
Return |
Property reference
|
|
Properties |
|
|
Joystick Type |
| Defines the directions the joystick can travel. | |
|
|
Return To Center |
| Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released. | |
|
|
Limits |
|
|
Y Min |
|
|
Y Max |
|
|
Theme |
|
|
Box Colour |
|
|
Shaft Colour |
|
|
Knob Colour |
|
|
Style |
|
|
Style |
| Outline line style | |
