Jump to content

Component: Joystick 2D (Controls): Difference between revisions

From Flowcode Help
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(14 intermediate revisions by 2 users 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_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 44: Line 52:


==Examples==
==Examples==




Line 67: Line 81:


''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''




==Macro reference==
==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ReadAxisAsFloat===
{| 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;" | '''ReadAxisAsFloat'''
| width="90%" class="mtx-class-macrohead" | '''ReadAxisAsFloat'''
|-
|-
| colspan="2" | Reads a single axis of the joystick and returns as a floating point value.&nbsp;
| colspan="2" | Reads a single axis of the joystick and returns as a floating point value.&nbsp;
Line 89: Line 118:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ReadAxisAsInt===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadAxisAsInt'''
|-
| colspan="2" | Reads a single axis of the joystick and returns as a signed integer value.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Axis
|-
| colspan="2" | Range 0-1 Where 0=X, 1=Y&nbsp;
|-
| 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''
|}
 
 
===SimMoveThumbStick===
{| 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;" | '''SimMoveThumbStick'''
| width="90%" class="mtx-class-macrohead" | '''SimMoveThumbStick'''
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 115: Line 164:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Axis
|-
| colspan="2" | Range 0-1 Where 0=X, 1=Y&nbsp;
|-
| 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==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| 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'''  
|-
|-
|-
|-
Line 155: Line 184:
| 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.&nbsp;
| 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.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Limits
| width="90%" class="mtx-class-propfolder" | Limits
|-
|-
|-
|-
Line 169: Line 198:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Theme
| width="90%" class="mtx-class-propfolder" | Theme
|-
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Pointer
|-
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Fill
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Box Colour
| width="90%" | Colour
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Specifies the fill colour of the shape&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Shaft Colour
| width="90%" | Gradient
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Knob Colour
| width="90%" | Gradient Style
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" | Style
| width="90%" class="mtx-class-propfolder" | Outline
|-
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
Line 197: Line 233:
|-
|-
| colspan="2" | Outline line style&nbsp;
| colspan="2" | Outline line style&nbsp;
|}==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="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAxisAsFloat'''
| width="90%" | Thickness
|-
|-
| colspan="2" | Reads a single axis of the joystick and returns as a floating point value.&nbsp;
| colspan="2" | Thickness of the outline&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| colspan="2" | The outline colour of the shape&nbsp;
| width="90%" | Axis
|-
|-
| colspan="2" | Range 0-1 Where 0=X, 1=Y&nbsp;
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Gradient
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| colspan="2" | &nbsp;
| 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="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SimMoveThumbStick'''
| width="90%" | Gradient Style
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Slide Area
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" | X
| width="90%" class="mtx-class-propfolder" | Fill
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | Specifies the fill colour of the shape&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Gradient
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Y
| width="90%" | Gradient Style
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" | Component
| width="90%" class="mtx-class-propfolder" | Outline
|-
|-
|-
| colspan="2" | &nbsp;
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| colspan="2" | Outline line style&nbsp;
| 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="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAxisAsInt'''
| width="90%" | Thickness
|-
|-
| colspan="2" | Reads a single axis of the joystick and returns as a signed integer value.&nbsp;
| colspan="2" | Thickness of the outline&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| colspan="2" | The colour of the shape outline&nbsp;
| width="90%" | Axis
|-
|-
| colspan="2" | Range 0-1 Where 0=X, 1=Y&nbsp;
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Gradient
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| colspan="2" | &nbsp;
| 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="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
| width="90%" | Gradient Style
|-
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" | Joystick Type
| width="90%" class="mtx-class-propfolder" | Background
|-
|-
| colspan="2" | Defines the directions the joystick can travel.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" | Return To Center
| width="90%" class="mtx-class-propfolder" | Fill
|-
|-
| 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.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Limits
| width="90%" | Colour
|-
|-
| colspan="2" | Specifies the fill colour of the shape&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Y Min
| width="90%" | Gradient
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Y Max
| width="90%" | Gradient Style
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Theme
| width="90%" class="mtx-class-propfolder" | Outline
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Box Colour
| width="90%" | Style
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Outline line style&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Shaft Colour
| width="90%" | Thickness
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Thickness of the outline&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Knob Colour
| width="90%" | Colour
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | The outline colour of the shape&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Style
| width="90%" | Gradient
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
| width="90%" | Gradient Style
|-
|-
| colspan="2" | Outline line style&nbsp;
| colspan="2" | &nbsp;
|}
|}

Latest revision as of 14:36, 13 July 2026

Author Matrix TSL
Version 1.0
Category Controls


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

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


ReadAxisAsInt

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


SimMoveThumbStick

SimMoveThumbStick
 
- FLOAT X
 
- FLOAT Y
 
- HANDLE Component
 
- VOID 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
Pointer
Fill
Colour
Specifies the fill colour of the shape 
Gradient
 
Gradient Style
 
Outline
Style
Outline line style 
Thickness
Thickness of the outline 
Colour
The outline colour of the shape 
Gradient
 
Gradient Style
 
Slide Area
Fill
Colour
Specifies the fill colour of the shape 
Gradient
 
Gradient Style
 
Outline
Style
Outline line style 
Thickness
Thickness of the outline 
Colour
The colour of the shape outline 
Gradient
 
Gradient Style
 
Background
Fill
Colour
Specifies the fill colour of the shape 
Gradient
 
Gradient Style
 
Outline
Style
Outline line style 
Thickness
Thickness of the outline 
Colour
The outline colour of the shape 
Gradient
 
Gradient Style