Difference between revisions of "RegisterEventHandler"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 9: Line 9:
 
  mainLoop, mouseEvent, animationStarted, animationStopped, textStarted & textStopped
 
  mainLoop, mouseEvent, animationStarted, animationStopped, textStarted & textStopped
 
|}
 
|}
 +
  
 
Syntax:
 
Syntax:
Line 15: Line 16:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
<span style="font-size:12px"><b><u>mainLoop</u></b></span>
+
 
 +
<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/>
 
you should only include one instance of the "mainLoop" event per game/project! <br/>

Revision as of 19:29, 5 March 2013

History: Available since v3.7

registerEventHandler is an event listener which lets you declare what should happen when specific events are registered!

Additional Info

Current events available:

mainLoop, mouseEvent, animationStarted, animationStopped, textStarted & textStopped


Syntax:

registerEventHandler('eventName', 'functionName', {integerValue or eventFlagName})


mainLoop

you should only include one instance of the "mainLoop" event per game/project!
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!)

-- 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")

Example 2: mainLoop (including functions inside of the loop event - recommended!)

-- 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


Arguments

Flags: none

Return: