Przeglądaj źródła

Updated font doc

looeee 8 lat temu
rodzic
commit
10208c7daa
1 zmienionych plików z 26 dodań i 3 usunięć
  1. 26 3
      docs/api/extras/core/Font.html

+ 26 - 3
docs/api/extras/core/Font.html

@@ -11,9 +11,9 @@
 		<h1>[name]</h1>
 
 		<div class="desc">
-		Create a set of [page:Shape Shape]s representing a font loaded in JSON format.<br /><br />
+		Create a set of [page:Shape Shapes] representing a font loaded in JSON format.<br /><br />
 
-		Used internally by the [page:FontLoader].
+		This is used internally by the [page:FontLoader].
 		</div>
 
 		<h2>Constructor</h2>
@@ -22,7 +22,30 @@
 		<div>
 		data -- JSON data representing the font.<br /><br />
 
-		This constructor creates a new [name], which is an array of [page:Shape Shape]s.
+		This constructor creates a new [name], which is an array of [page:Shape Shapes].
+		</div>
+
+		<h2>Properties</h2>
+
+		<h3>[property:array data]</h3>
+		<div>The JSON data passed in the constructor.</div>
+
+		<h3>[property:Boolean isFont]</h3>
+		<div>
+			Used to check whether this or derived classes are fonts. Default is *true*.<br /><br />
+
+			You should not change this, as it used internally by the renderer for optimisation.
+		</div>
+
+		<h2>Methods</h2>
+
+		<h3>[method:null generateShapes]( [page:String text], [page:Float size], [page:Integer divisions] )</h3>
+		<div>
+			[page:String text] -- string of text.<br />
+			[page:Float size] -- (optional) scale for the [page:Shape Shapes]. Default is *100*.<br />
+			[page:Integer divisions] -- (optional) fineness of the [page:Shape Shapes]. Default is *5*.<br />
+
+			Creates an array of [page:Shape Shapes] representing the text in the font.
 		</div>
 
 		<h2>Source</h2>