|
|
| (12 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
| + | #REDIRECT [[Global Command: registerEventHandler]] |
| − | <b>Command History</b>
| |
| − | <div class="mw-collapsible-content">
| |
| − | <div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.6</span></div>
| |
| − | <div>animationStarted, animationStopped, textStarted & textStopped event listener LUA commands added to <span style="color:orange">v3.6</span></div>
| |
| − | <div style="background:#ebebeb" width="100%">mouseEvent listener added to <span style="color:orange">v3.7</span></div>
| |
| − | </div></div>
| |
| − | | |
| − | | |
| − | registerEventHandler is an event listener which lets you declare what should happen when specific events are registered!
| |
| − | {| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
| |
| − | ! Additional Info
| |
| − | |-
| |
| − | |
| |
| − | Current events available: <br/>
| |
| − | mainLoop, mouseEvent, animationStarted, animationStopped, textStarted & textStopped
| |
| − | |}
| |
| − | | |
| − | | |
| − | Syntax:
| |
| − | <syntaxhighlight>
| |
| − | registerEventHandler("eventName", "functionName", {integerValue or eventFlagName})
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | <span style="font-size:15px"><b><u>mainLoop</u></b></span>
| |
| − | | |
| − | you should only include one instance of the "mainLoop" event per game/project! <br/>
| |
| − | currently there is no delay/pause method to control the speed of the loop!
| |
| − | | |
| − | | |
| − | Example 1: mainLoop (code inside of the loop event - not recommended!)
| |
| − | <syntaxhighlight>
| |
| − | | |
| − | -- let's create the function for the mainLoop event!
| |
| − | function onMainLoop()
| |
| − | -- if x equals less than 100 then + 1 should be added to value of x on each loop until x equals 100!
| |
| − | if x < 100 then
| |
| − | x = x + 1
| |
| − | end
| |
| − | end
| |
| − | | |
| − | -- let's create the loop handler!
| |
| − | registerEventHandler("mainLoop", "onMainLoop")
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | Example 2: mainLoop (including functions inside of the loop event - recommended!)
| |
| − | <syntaxhighlight>
| |
| − | -- let's create a function that we will include inside of the mainLoop event!
| |
| − | function checkValue()
| |
| − | -- if x equals less than 100 then + 1 should be added to value of x on each loop until x equals 100!
| |
| − | if x < 100 then
| |
| − | x = x + 1
| |
| − | end
| |
| − | end
| |
| − | | |
| − | -- let's create the mainLoop event, where we will include functions for looping!
| |
| − | function onMainLoop()
| |
| − | checkValue() -- calls checkVal function on each loop!
| |
| − | end
| |
| − | | |
| − | -- let's create the loop handler!
| |
| − | registerEventHandler("mainLoop", "onMainLoop") | |
| − | end
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | | |
| − | <span style="font-size:15px"><b><u>mouseEvent</u></b></span>
| |
| − | | |
| − | you should only include one instance of the "mouseEvent" event per game/project!
| |
| − | {| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
| |
| − | ! Additional Info
| |
| − | |-
| |
| − | |
| |
| − | Current mouseEvent eventFlags available:
| |
| − | <syntaxhighlight enclose="div">
| |
| − | eEvtMouseMove(1), eEvtMouseLeftButtonDoubleClick(2), eEvtMouseLeftButtonDown(3), eEvtMouseLeftButtonUp(4), eEvtMouseLeftButtonHold(5), eEvtMouseLeftButtonHolding(6), eEvtMouseRightButtonDoubleClick(7), eEvtMouseRightButtonDown(8), eEvtMouseRightButtonUp(9), eEvtMouseMiddleButtonDown(10), eEvtMouseMiddleButtonUp(11), eEvtMouseWheelUp(12) & eEvtMouseWheelDown(13)
| |
| − | </syntaxhighlight> <br/>
| |
| − | If no mouseEvent flags are included then all mouse events will be registered!
| |
| − | |}
| |
| − | | |
| − | | |
| − | Example: mouseEvent
| |
| − | <syntaxhighlight enclose="div">
| |
| − | --[[
| |
| − | Like the mainLoop event you can create what each registered event should do inside of the mouseEvent function or you can add functions which could be called based on certain conditions or not!
| |
| − | --]]
| |
| − | | |
| − | -- let's create the function for the mouseEvent listener!
| |
| − | function onMouseEvent(eventType, mousePosition)
| |
| − | -- bleh!
| |
| − | end
| |
| − | | |
| − | -- let's create the mouseEvent listener!
| |
| − | registerEventHandler("mouseEvent", "onMouseEvent", {eEvtMouseMove, eEvtMouseLeftButtonDoubleClick, eEvtMouseLeftButtonDown, eEvtMouseLeftButtonUp, eEvtMouseLeftButtonHold, eEvtMouseLeftButtonHolding, eEvtMouseRightButtonDoubleClick, eEvtMouseRightButtonDown, eEvtMouseRightButtonUp, eEvtMouseMiddleButtonDown, eEvtMouseMiddleButtonUp, eEvtMouseWheelUp, eEvtMouseWheelDown})
| |
| − | | |
| − | --[[
| |
| − | registerEventHandler("mouseEvent", "onMouseEvent", {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13})
| |
| − | would also work & saves time on having to type out all the string versions of the mouseEvents!
| |
| − | note: you don't need to add of the mouseEvents; only add the ones you need for your game!
| |
| − | --]]
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | | |
| − | <b><u>Arguments</u></b>
| |
| − | | |
| − | will add later!
| |
| − | | |
| − | Flags: n/a (will add later)
| |
| − | | |
| − | Return: none
| |
| − | {{i18n|RegisterEventHandler}}
| |
