An Event in Time

On this page you will find a bunch of tips & tricks related to events, loops, & timing methods that you can use to control exactly when specific events &/or state changes (via values/conditions) should occur in your game projects.

Anyway, let's crack on...

Pause (static)

The simplest method for controlling time is to use the pause action part. The pause action part will prevent any action parts created after it from executing until the pause has finished.

---

Quick note: The pause action part allows you to specify the time in milliseconds, seconds, or minutes; however I highly recommend that you use milliseconds because it allows you to input precise time values.

---

Anyway, here's an example of the pause action part being used with some other action parts...

1. if condition "cond_example" is true
2. pause for 500 milliseconds
3. change condition "cond_example" to false
4. end if

Pause (dynamic)

The same action part above can also be used to create dynamic pauses, which can be really useful for making your game projects feel more alive & less like a broken record stuck in a never-ending loop.

To setup dynamic pauses you will need to create a value that you can link to the pause action part. The integer number belonging to values can be modified at any time via action parts or script; however we will only be covering action parts for now to keep things as simple as possible.

Anyway, let's just assume you have created a value somewhere inside of the Visionaire Studio editor & have called it "v_time". Right, let's see an example of what a dynamic pause would look like inside of an action block...

1. set random value "v_time" between 1000 and 5000
2. pause for "v_time" milliseconds
3. play animation "anim_example" and wait
4. jump to action part #1

Animation Frame Events

Did you know that you can edit animation frames via & assign sounds & actions to each individual animation frame? This is actually a really great method for precision timing based events as they are tied to animation frames instead of the frames per second (fps) that your game is running on each players device. It's much more accurate than using the pause action part.

Wait Actions

Some action parts have an additional option called wait, which enabled will tell the engine to pause the action list until the action or animation has finished. These wait options are optional & can also be very useful for controlling the timing of when certain events should occur.

Play Animation and wait

This will start an animation & pause the action list that you execute this action in until the animation finishes, however you do need to be careful not to use this option on animations that are set to infinite loop as the action list will be paused indefinitely due to the animation never ending.

---

Wait until Animation is Finished

Same as above, but this action part is meant to be used on an already playing animation. & again be careful not to use this option on animations that are set to infinite loop as the action list will be paused indefinitely due to the animation never ending.

---

Wait until Sound is Finished

This action part will pause the action list that you execute this action in until the linked sound stops playing, however just like play animation and wait you need to be careful that you don't link to a sound that is looping as the action list will be infinitely due to the sound never ending.

---

Wait until Condition was Changed

This will pause the current action list until the condition is changed from whatever it currently is or until it's changed to the specified boolean state.

---

Quick note: There are 3 options available.

1. Changed: wait until condition is changed to the opposite of its current state.

2. True: wait until condition is changed to true.

3. False: wait until condition is changed to false.

---

Wait until Value was Changed (static)

This will pause the current action list until the specified value target is met.

---

Wait until Value was Changed (dynamic)

This will pause the current action list until the specified value meets the same target value as the secondary linked value. The reason this method is dynamic is because both values can be manipulated which means that the secondary value could be repurposed for multiple situations.

---

Quick note: There are multiple operators you can use for querying values, which allows a lot of freedom when it comes to querying values.

= equals.

!= does not equal.

<= less than or equal to.

< less than.

>= greater than or equal to.

> greater than.

---

Wait until Character Stops Speaking

Pauses the current action list until the specified character stops talking; or just continue executing the action parts if the character wasn't talking to begin with.

---

Wait until Character Stops

Pauses the current action list until the specified character stops walking; or just continue executing the action parts if the character wasn't walking to begin with.

---

Send Character to Position/Object and Wait

This is actually 2 different action parts. One will let you send the character to a specified position in the current scene & the other will let you tell the character to walk to the position defined in the specified object. Both have wait options & will pause the action list until the character reaches the position.

---

Quick note: The destination position isn't what the engine is listening out for, it's actually listening out for when the character stops walking so you may want to use these 2 action parts inside of cutscene wrappers to prevent the player from being able to interrupt the destination position/object by left clicking elsewhere in the scene.

---

Call/Quit Action and Wait

This action part allows you to call another existing action block. You can optionally tell the current action list to wait until the other action block you call finishes iterating through all the action parts/scripts listed inside of it - I don't know if you can chain this action through multiple action blocks, but maybe one of you want to try it out & let me (AFRLme) know?

Loops

This section is going to get a bit complicated as we are going to start delving into the scripting side of things, as well as some conventional & unconvential methods via action parts & animations.

Jump to Action Part

The jump to action part action part is one of the methods that you can use for creating loops inside of the Visionaire Studio editor without having to resort to scripting. There are 2 ways that you can use the jump to x action part, which are...

---

Absolute

This is the option you would probably be using most of the time & it's the simplest method as you simply tell the engine to jump to x action part inside of the current action block. For example #1 would be the first action part in the list aka the top of the list.

Here's a quick example of what the action block might look like...

1. if condition "cond_example" is false
2. pause for 500 milliseconds
3. jump to action part #1 (jump back to first action part)
4. end if
5. display text "hello world" (if condition "cond_example" is true then this would be executed instead)

---

Relative

The relative mode is a bit more complicated as it involves jumping x amount of steps forwards or backwards & is more situation based.

Here's a little action block example of what it might look like in use...

1. pause for 500 milliseconds
2. if condition "cond_example" is true
3. jump 4 action parts forwards          (0)
4. else                                  (1)
5. jump to action part #1                (2)
6. end if                                (3)
7. display text "hello world"            (4)

---

The setDelay() Function

The setDelay() function is really useful for controlling when to execute lines of code or functions & it can also be used to create timed based loops.

Syntax

setDelay(duration, function)

---

Call Existing Function

setDelay(1000, "helloworld()") -- call function helloworld() after 1000ms (1 second)

---

Execute Custom Function

setDelay(1000, function()
 print("hello world!") -- print "hello world" to the log after 1000ms (1 second)
 -- you can insert any code you like between function() & end
end)

---

Looping Function with Delay

local i = 0 -- create variable i & set default value as 0

function example()
 i = i + 1 -- increment i by 1
 print(i) -- print the value of i to the log
 setDelay(1000, "example()") -- call the example() function again after 1000ms (1 second)
end

example() -- call the example() function to start the loop

---

Quick note: You might want to consider wrapping the setDelay() function inside of a delayed looping function with an if query to kill the loop when it's no longer needed.

mainLoop

The mainLoop event handler is the main scripting looping method that most people will probably learn about first. Unlike the delayed looping method with the setDelay() function, the mainLoop will loop constantly while it's registered, however you can control when the code inside of the mainLoop function is executed by wrapping your code in various if queries.

The mainLoop is one of the only event handlers that can have multiple functions registered to it per game project, & thus it can also be unregistered when you no longer need it.

registerEventHandler()

registerEventHandler("mainLoop", "exampleLoop") -- register exampleLoop() as a looping function & start looping

<tr>

unregisterEventHandler()

unregisterEventHandler("mainLoop", "exampleLoop") -- unregister exampleLoop as a looping function & kill the loop

<tr>

Basic Example

local i = 0 -- create variable i & set default value as 0

exampleLoop()
 i = i + 1 -- increment i by 1
 print(i) -- print the value of i to the log
end

registerEventHandler("mainLoop", "exampleLoop")

<tr>

Tick Rate Example

local i = 0 -- create variable i & set default value as 0

exampleLoop()
 i = i + 1 -- increment i by 1
 if i == 10 then -- check if i equals 10
  print("hello world!") -- print "hello world!" to the log
  i = 0 -- reset i back to 0
 end
end
<tr>
==== getTime() Example ====

<syntaxhighlight lang="lua">
local time = nil

exampleLoop()
 if time = nil then time = getTime({flags=1, reset=true}) end -- init time & reset back to 0
 if getTime() >= time + 3000 then -- if time more than or equals time plus 3000ms then
  print("hello world!") -- print "hello world!" to the log
  time = getTime({flags=1, reset=true}) -- reset time back to 0ms
 end
end

registerEventHandler("mainLoop", "exampleLoop")

---

Quick note: Tick rate & getTime() are not very accurate in terms of controlling the delay as the mainLoop is based on system loop which is rarely consistent. In other words it could be 4ms one loop, or 33ms, etc. etc. in another loop, but it still has its uses for delays that don't need to be super precise.

---