Skip to content

Improve documentation of init and update #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Zarel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve documentation of init and update #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions documentation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,14 @@ <h2>Basics</h2>
// dt is the number of game seconds that passed since the last time update was called
}
}</code></pre></div>
<p>These functions will then be called by the game during the challenge.<br>
<span class="emphasis-color">init</span> will be called when the challenge starts, and <span class="emphasis-color">update</span> repeatedly during the challenge.
<p>
These functions will then be called by the game during the challenge.
</p>
<p>
<span class="emphasis-color">init</span> will be called when the challenge starts. <span class="emphasis-color">elevators</span> will be an array of Elevator objects, <span class="emphasis-color">floors</span> will be an array of Floor objects, and <span class="emphasis-color">this</span> will be the object you declared.
</p>
<p>
<span class="emphasis-color">update</span> will be called every frame the challenge updates, approximately 60 times per real-time second on most computers. <span class="emphasis-color">dt</span> will be the number of in-game seconds that have passed since the previous update (not necessarily an integer!), <span class="emphasis-color">elevators</span> will be an array of Elevator objects, <span class="emphasis-color">floors</span> will be an array of Floor objects, and <span class="emphasis-color">this</span> will be the object you declared.
</p>
<p>
Normally you will put most of your code in the <span class="emphasis-color">init</span> function, to set up event listeners and logic.
Expand Down