Difference between revisions of "RegisterEventHandler"

From The Official Visionaire Studio: Adventure Game Engine Wiki
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<b>History</b>: Available since <span style="color:green">v3.7</span> <br/>
+
#REDIRECT [[Global Command: registerEventHandler]]
 
 
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:12px"><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()
 
checkVal() -- calls checkVal function on each loop!
 
end
 
 
 
-- let's create the loop handler!
 
registerEventHandler("mainLoop", "onMainLoop")
 
end
 
</syntaxhighlight>
 
 
 
 
 
<b><u>Arguments</u></b>
 
 
 
Flags: none
 
 
 
Return:<br/>
 
{{i18n|RegisterEventHandler}}
 

Latest revision as of 13:28, 19 May 2023