Event Keyboard.ButtonName: Difference between revisions

Latest revision as of 14:13, 13 July 2026

	ButtonName
Sent to give a meaningful name to a button on a simulated mouse-click
- HANDLE	Component
The component to simulate a click on
- STRING	CmpntName
The name of the component to simulate a click on
- STRING	MapName
The name to return describing the key-press event
- NONE	Return

Details on using Event Macros can be found here: Event Macros

@@ Line 1: / Line 1: @@
-<sidebar>Event Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sent to give a meaningful name to a button on a simulated mouse-click
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''ButtonName'''
+|-
+| colspan="2" | Sent to give a meaningful name to a button on a simulated mouse-click&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Component
+|-
+| colspan="2" | The component to simulate a click on&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | CmpntName
+|-
+| colspan="2" | The name of the component to simulate a click on&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | MapName
+|-
+| colspan="2" | The name to return describing the key-press event&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-This event is part of the [[Event class Keyboard|Keyboard]] class
-__TOC__
+Details on using Event Macros can be found here: [[Simulation Events|Event Macros]]
-==Parameters==
-[[Variable Types|HANDLE]] ''Component''
-:The component to simulate a click on
-[[Variable Types|STRING]] ''CmpntName''
+==Detailed description==
-:The name of the component to simulate a click on
-[[Variable Types|STRING]] ''MapName''
-:The name to return describing the key-press event
-:''This parameter is returned back to Flowcode''
-==Return value==
-[[Variable Types|ULONG]]
-The return of this event is currently unused
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
 ==Examples==
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:13, 13 July 2026

Detailed description

Examples