Browse Source

Rough docs for Loader.

sole 13 years ago
parent
commit
94d0e6a5e6
1 changed files with 19 additions and 12 deletions
  1. 19 12
      docs/api/loaders/Loader.html

+ 19 - 12
docs/api/loaders/Loader.html

@@ -9,26 +9,33 @@
 	<body>
 	<body>
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">Base class for implementing loaders.</div>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
+		<h3>[name]( [page:Boolean showStatus] )</h3>
 
 
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 
 
-		<h3>.[page:Vector3 todo]</h3>
-
-
-		<h2>Methods</h2>
-
-		<h3>.todo( [page:Vector3 todo] )</h3>
-		<div>
-		todo — todo<br />
-		</div>
-
+		<h3>.[page:Boolean showStatus]</h3>
+		<div>If true, show loading status in the statusDomElement.</div>
+		
+		<h3>.[page:DOMElement statusDomElement]</h3>
+		<div>This is the recipient of status messages.</div>
+		
+		<h3>.[page:Function onLoadStart]</h3>
+		<div>Will be called when load starts.</div>
+		<div>The default is a function with empty body.</div>
+
+		<h3>.[page:Function onLoadProgress]</h3>
+		<div>Will be called while load progresses.</div>
+		<div>The default is a function with empty body.</div>
+		
+		<h3>.[page:Function onLoadComplete]</h3>
+		<div>Will be called when load completes.</div>
+		<div>The default is a function with empty body.</div>
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>