GetObjectBoundingBox: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Gets the local bounds of the object.}}


{{FuncSyntax|GetObjectBoundingBox(object)}}
{{FuncSyntax|GetObjectBoundingBox(object)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|object|__EDIT_ME__}}
{{FuncParam|object|The object identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns 6 floats: MinX, MinY, MinZ, MaxX, MaxY, MaxZ
Min is the origin (pivot) minus the extent of the object.
Max is the origin (pivot) plus the extent of the object.}}


== Example ==
== Example ==
__EDIT_ME__
[https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/6f45ad9607e30c97f4f1d58443d808da632d4d91/mapeditor/client/editor.lua#L180 See example from the map editor on GitHub.]


{{RelatedFunctions}}
{{RelatedFunctions}}

Latest revision as of 11:27, 2 November 2020

GetObjectBoundingBox

Type: Function
Context: Client
Introduced: v1.0

Description

Gets the local bounds of the object.

Syntax

GetObjectBoundingBox(object)

Parameters

  • object
    The object identifier.

Return Value

  • Returns 6 floats: MinX, MinY, MinZ, MaxX, MaxY, MaxZ

Min is the origin (pivot) minus the extent of the object. Max is the origin (pivot) plus the extent of the object.

Example

See example from the map editor on GitHub.

See also