Difference between revisions of "Lily/Documentation"

(Created page with "List of functions in <code>lily</code> table. {{notice|Function list correspond to Lily v2.0.x}} = Lily Functions = == lily.getThreadCount == {{notice|When love.system i...")
 
m (Blanked page (Lily v.2.0 is obsoleted. Instead use the Github pages).)
 
Line 1: Line 1:
List of functions in <code>lily</code> table.
 
  
{{notice|Function list correspond to Lily v2.0.x}}
 
 
= Lily Functions =
 
== lily.getThreadCount ==
 
{{notice|When [[love.system]] is not loaded, it uses other ways to get the amount of logical CPU. If all else fails, fallback to 1.}}
 
=== Synopsis ===
 
<source lang="lua">count = lily.getThreadCount( )</source>
 
=== Arguments ===
 
None.
 
=== Returns ===
 
{{param|number|count|Amount of threads used by Lily. This is mostly likely amount of logical CPU available.}}
 
 
== lily.getThreadsTaskCount ==
 
Retrieves the total pending task for every thread.
 
=== Synopsis ===
 
<source lang="lua">threadsTaskCount = lily.getThreadsTaskCount( )</source>
 
=== Arguments ===
 
None.
 
=== Returns ===
 
{{param|table|threadsTaskCount |Table with n-elements depending on <code>lily.getThreadCount()</code>. Each index is the task count of thread-n.}}
 
 
== lily.quit ==
 
Uninitializes Lily.
 
{{notice|This function should only be called if you plan restarting your game with [[love.event.quit|<code>love.event.quit("restart")</code>]]. This is true when using LOVE under iOS!}}
 
=== Synopsis ===
 
<source lang="lua">lily.quit( )</source>
 
=== Arguments ===
 
None.
 
=== Returns ===
 
None.
 
 
= Asset Loading Functions =
 
TODO
 

Latest revision as of 12:27, 17 December 2019