Difference between revisions of "Component: Simulation Switch Template (Controls)"
From Flowcode Help
Jump to navigationJump to search(12 intermediate revisions by the same user not shown) | |||
Line 14: | Line 14: | ||
==Simulation Switch Template component== | ==Simulation Switch Template component== | ||
A base for building switches that do not download to chip. Mouse interaction can send 'System.User' events with the following data... ID = The handle of the switch component sending the message Message = 1 (on) or 0 (off) Current state can also be read via simulation macros. | A base for building switches that do not download to chip. Mouse interaction can send 'System.User' events with the following data... ID = The handle of the switch component sending the message Message = 1 (on) or 0 (off) Current state can also be read via simulation macros. | ||
+ | |||
+ | ==Component Source Code== | ||
+ | |||
+ | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_sim_switch_base.fcfx FC_Comp_Source_sim_switch_base.fcfx] | ||
+ | |||
+ | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_sim_switch_base.fcfx FC_Comp_Source_sim_switch_base.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
Line 28: | Line 50: | ||
==Examples== | ==Examples== | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
Line 41: | Line 79: | ||
− | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==Macro reference== | ||
+ | |||
+ | ===GetState=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 56: | Line 107: | ||
+ | ===SetState=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 72: | Line 124: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
− | |||
− | |||
Line 128: | Line 178: | ||
|- | |- | ||
| colspan="2" | Default state of the indicator when loading the project or starting the simulation runtime. | | colspan="2" | Default state of the indicator when loading the project or starting the simulation runtime. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} |
Latest revision as of 11:57, 3 November 2023
Author | Matrix Ltd |
Version | 1.3 |
Category | Controls |
Contents
Simulation Switch Template component
A base for building switches that do not download to chip. Mouse interaction can send 'System.User' events with the following data... ID = The handle of the switch component sending the message Message = 1 (on) or 0 (off) Current state can also be read via simulation macros.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_sim_switch_base.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_sim_switch_base.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
GetState
GetState | |
Read the current state of the switch. Returns BOOL true when the switch is on, or BOOL false when off. | |
- BOOL | Return |
SetState
SetState | |
Sets the current state of the switch. BOOL true when the switch is on, or BOOL false when off. | |
- BOOL | SwitchState |
Sets the state of the switch | |
- VOID | Return |