Difference between revisions of "SetScale"
Reworking function documentation to provide _detailed_ Parameter info (possible template prototype).
imported>Qazaaq m (fixing links) |
imported>Laisren (Reworking function documentation to provide _detailed_ Parameter info (possible template prototype).) |
||
| Line 1: | Line 1: | ||
=SetScale (function/command)= | |||
This [[Console command|command]] sets the scale (relative size) of the referenced object to the specified value. | |||
==Syntax== | |||
SetScale <''percent''> | |||
==Syntax Description== | |||
<table border="1" style="border:1px solid"> | |||
<tr> | |||
<th>Parameter</th> | |||
<th>Type</th> | |||
<th>Optional or Required</th> | |||
<th>Details</th> | |||
</tr> | |||
<tr> | |||
<td> ''percent'' </td> | |||
<td> [[Float]] </td> | |||
<td> Required </td> | |||
<td> The scale, expressed as a decimal percentage; <tt>1.00</tt> = 100% (normal size), <tt>0.90</tt> = 90% of normal size, and so on.<br> | |||
Valid values are from <tt>0.50</tt> (50%) to <tt>2.00</tt> (200%).<br> | |||
A value of <tt>1.00</tt> returns the item to its default size.<br> | |||
Leading or trailing zeros are recommended, but not required (i.e. <tt>1.5</tt> = <tt>1.50</tt>). | |||
</td> | |||
</tr> | |||
</table> | |||
== | ==Example== | ||
The following example sets the scale of the selected object to 150%: | |||
SetScale 1.50 | |||
* The scale is limited in the range of 0.5 - 2.0. Higher or lower values | ==Additional Details (Notes)== | ||
* The Reference ([[RefID|referenceID]]/called object) can be specified in Console Mode by pre-selecting the object. | |||
* The scale is limited in the range of 0.5 - 2.0. Higher or lower values do not generate errors, but have no effect beyond that range. | |||
** Use OBSE's [[SetScaleEX]] for sizes outside of that range. | ** Use OBSE's [[SetScaleEX]] for sizes outside of that range. | ||
| Line 29: | Line 51: | ||
[[Category: Statistics Functions]] | [[Category: Statistics Functions]] | ||
[[Category: Statistics Functions (CS 1.0)]] | [[Category: Statistics Functions (CS 1.0)]] | ||
<hr> | |||
<font size="1">ShareAlike Attribution: Part of this article is based on original work by Laisren; used under license terms.</font> | |||