Skip to content

Commit 256c79e

Browse files
committed
Update Strings.DisplayString.html
1 parent f8aa49e commit 256c79e

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

2 classes/Strings.DisplayString.html

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,10 @@ <h2><a href="#Functions">Functions</a></h2>
128128
<td class="name" ><a href="#DisplayString:GetPosition">DisplayString:GetPosition()</a></td>
129129
<td class="summary">Get the position of the string.</td>
130130
</tr>
131+
<tr>
132+
<td class="name" ><a href="#DisplayString:SetFlags">DisplayString:SetFlags(table)</a></td>
133+
<td class="summary">Set the display string's flags</td>
134+
</tr>
131135
</table>
132136

133137
<br/>
@@ -250,7 +254,7 @@ <h3>Parameters:</h3>
250254
<h3>Returns:</h3>
251255
<ol>
252256

253-
<span class="types"><span class="type">String</span></span>
257+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
254258
a string
255259
</ol>
256260

@@ -272,7 +276,7 @@ <h3>Returns:</h3>
272276
<h3>Parameters:</h3>
273277
<ul>
274278
<li><span class="parameter">string</span>
275-
<span class="types"><span class="type">String</span></span>
279+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
276280
the new key for the display string
277281
</li>
278282
</ul>
@@ -333,6 +337,38 @@ <h3>Returns:</h3>
333337

334338

335339

340+
</dd>
341+
<dt>
342+
<a name = "DisplayString:SetFlags"></a>
343+
<strong>DisplayString:SetFlags(table)</strong>
344+
</dt>
345+
<dd>
346+
Set the display string's flags
347+
348+
349+
350+
<h3>Parameters:</h3>
351+
<ul>
352+
<li><span class="parameter">table</span>
353+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
354+
the new table with display flags options
355+
</li>
356+
</ul>
357+
358+
359+
360+
361+
<h3>Usage:</h3>
362+
<ul>
363+
<pre class="example"><span class="keyword">local</span> varDisplayString = DisplayString(<span class="string">'example string'</span>, <span class="number">0</span>, <span class="number">0</span>, Color(<span class="number">255</span>, <span class="number">255</span>, <span class="number">255</span>), <span class="keyword">false</span>)
364+
varDisplayString:SetFlags({})
365+
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.SHADOW })
366+
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.CENTER })
367+
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.SHADOW, TEN.Strings.DisplayStringOption.CENTER })
368+
<span class="comment">-- When passing a table to a function, you can omit the parentheses
369+
</span>varDisplayString:SetFlags{ TEN.Strings.DisplayStringOption.CENTER }</pre>
370+
</ul>
371+
336372
</dd>
337373
</dl>
338374

@@ -341,7 +377,7 @@ <h3>Returns:</h3>
341377
</div> <!-- id="main" -->
342378
<div id="about">
343379
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
344-
<i style="float:right;">Last updated 2023-03-31 20:44:31 </i>
380+
<i style="float:right;">Last updated 2023-04-11 21:28:36 </i>
345381
</div> <!-- id="about" -->
346382
</div> <!-- id="container" -->
347383
</body>

0 commit comments

Comments
 (0)