getObjectScale: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Article creation)
 
m (Text replacement - "Samatra" to "Sa-Matra")
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


|game1= arma3dev |Game name=
|game1= arma3
|version1= 2.02


|version= 2.01 |Game version=
|gr1= Object Manipulation


|arg=  |Multiplayer Arguments ("local" or "global")=
|descr= Returns the render scale of an object relative to the original model.


|eff=  |Multiplayer Effects ("local" or "global")=
|s1= [[getObjectScale]] object


|serverExec= |Multiplayer Execution ("server" or empty)=
|p1= object: [[Object]] - object to return scale of. Can also be a [[nearestTerrainObjects|terrain object]].
____________________________________________________________________________________________


|descr= Returns the render scale of the object relative to the original model. Also works for terrain objects. |Description=
|r1= [[Number]] - scale relative to the original model


|mp= |Multiplayer Behaviour=
|x1= <sqf>
private _objectScale = getObjectScale MyObject;


|pr= |Problems=
if (_objectScale == 1) exitWith { systemChat "Original scale"; };
____________________________________________________________________________________________


|s1= [[getObjectScale]] object|Syntax=
if (_objectScale > 1) then
{
systemChat "Scaled up";
}
else
{
systemChat "Scaled down";
};
</sqf>


|p1= object: [[Object]] |Parameter 1=
|seealso= [[setObjectScale]]
____________________________________________________________________________________________
}}
 
|x1= <code>[[getObjectScale]] _mrap;</code> |Example 1=
____________________________________________________________________________________________


|seealso= [[setObjectScale]] |See Also=
{{Note
|user= Sa-Matra
|timestamp= 20240610122652
|text= Some objects can be scaled by XYZ individually by the engine. Rope segments are one example, they only scale by Z and this command returns average of all dimensions giving no real picture of the scale. You can get real scale of each dimension with:
<sqf>[vectorMagnitude vectorSideVisual _seg, vectorMagnitude vectorDirVisual _seg, vectorMagnitude vectorUpVisual _seg]</sqf>
for rope segment it will be something like <sqf inline>[1,1,1.54066]</sqf>
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">[[User:User Name|User Name]]</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Non-automatic appropriate categories go here, e.g
[[Category:Scripting Commands {{arma3}}|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-->

Latest revision as of 20:58, 4 July 2024

Hover & click on the images for description

Description

Description:
Returns the render scale of an object relative to the original model.
Groups:
Object Manipulation

Syntax

Syntax:
getObjectScale object
Parameters:
object: Object - object to return scale of. Can also be a terrain object.
Return Value:
Number - scale relative to the original model

Examples

Example 1:
private _objectScale = getObjectScale MyObject; if (_objectScale == 1) exitWith { systemChat "Original scale"; }; if (_objectScale > 1) then { systemChat "Scaled up"; } else { systemChat "Scaled down"; };

Additional Information

See also:
setObjectScale

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Sa-Matra - c
Posted on Jun 10, 2024 - 12:26 (UTC)
Some objects can be scaled by XYZ individually by the engine. Rope segments are one example, they only scale by Z and this command returns average of all dimensions giving no real picture of the scale. You can get real scale of each dimension with: for rope segment it will be something like [1,1,1.54066]