Difference between revisions of "Component: Joystick (Controls)"

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray...")
 
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Joystick.fcfx FC_Comp_Source_Joystick.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Joystick.fcfx FC_Comp_Source_Joystick.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Joystick.fcfx FC_Comp_Source_Joystick.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
 
''No detailed description exists yet for this component''
 
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
 +
 +
  
 
''<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;"
 +
|-
 +
| 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.&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-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;" | '''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==
 +
 +
{| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Y Max
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Shaft Colour
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Knob Colour
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:22, 20 January 2023

Author Matrix TSL
Version 1.0
Category Controls


Joystick 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.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Fc9-comp-macro.png ReadAxisAsFloat
Reads a single axis of the joystick and returns as a floating point value. 
Fc9-u8-icon.png - BYTE Axis
Range 0-1 Where 0=X, 1=Y 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png ReadAxisAsInt
Reads a single axis of the joystick and returns as a signed integer value. 
Fc9-u8-icon.png - BYTE Axis
Range 0-1 Where 0=X, 1=Y 
Fc9-s16-icon.png - INT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Joystick Type
Defines the directions the joystick can travel. 
Fc9-type-7-icon.png 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. 
Fc9-conn-icon.png Limits
Fc9-type-15-icon.png Y Min
 
Fc9-type-15-icon.png Y Max
 
Fc9-conn-icon.png Theme
Fc9-type-1-icon.png Box Colour
 
Fc9-type-1-icon.png Shaft Colour
 
Fc9-type-1-icon.png Knob Colour
 

==Macro reference==

Fc9-comp-macro.png ReadAxisAsFloat
Reads a single axis of the joystick and returns as a floating point value. 
Fc9-u8-icon.png - BYTE Axis
Range 0-1 Where 0=X, 1=Y 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png ReadAxisAsInt
Reads a single axis of the joystick and returns as a signed integer value. 
Fc9-u8-icon.png - BYTE Axis
Range 0-1 Where 0=X, 1=Y 
Fc9-s16-icon.png - INT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Joystick Type
Defines the directions the joystick can travel. 
Fc9-type-7-icon.png 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. 
Fc9-conn-icon.png Limits
Fc9-type-15-icon.png Y Min
 
Fc9-type-15-icon.png Y Max
 
Fc9-conn-icon.png Theme
Fc9-type-1-icon.png Box Colour
 
Fc9-type-1-icon.png Shaft Colour
 
Fc9-type-1-icon.png Knob Colour
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Joystick_(Controls)&oldid=33436"