DrawCircle3D: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Draws a circle in 3d space.}} | ||
{{FuncSyntax|DrawCircle3D(x, y, z [, Radius])}} | {{FuncSyntax|DrawCircle3D(x, y, z, XAxisX, XAxisY, XAxisZ, YAxisX, YAxisY, YAxisZ [, Radius, bForeground])}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|x| | {{FuncParam|x|World X location.}} | ||
{{FuncParam|y| | {{FuncParam|y|World Y location.}} | ||
{{FuncParam|z| | {{FuncParam|z|World Z location.}} | ||
{{FuncParam|XAxisX| | {{FuncParam|XAxisX|X axis alignment of the circle}} | ||
{{FuncParam|XAxisY| | {{FuncParam|XAxisY|X axis alignment of the circle}} | ||
{{FuncParam|XAxisZ| | {{FuncParam|XAxisZ|X axis alignment of the circle}} | ||
{{FuncParam|YAxisX| | {{FuncParam|YAxisX|Y axis alignment of the circle}} | ||
{{FuncParam|YAxisY| | {{FuncParam|YAxisY|Y axis alignment of the circle}} | ||
{{FuncParam|YAxisZ| | {{FuncParam|YAxisZ|Y axis alignment of the circle}} | ||
{{FuncParamOptional|Radius| | {{FuncParamOptional|Radius|The circle radius, default: 1.0}} | ||
{{FuncParamOptional|bForeground|'''true''' to draw in front of geometry, default: false}} | |||
{{FuncReturnValue| | {{FuncReturnValue|Returns nothing.}} | ||
== Example == | == Example == | ||
Example usage can be found in the map editor script package: | |||
https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/6f45ad9607e30c97f4f1d58443d808da632d4d91/mapeditor/client/editor.lua#L164 | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
Revision as of 13:25, 30 August 2020
Description
Draws a circle in 3d space.
Syntax
DrawCircle3D(x, y, z, XAxisX, XAxisY, XAxisZ, YAxisX, YAxisY, YAxisZ [, Radius, bForeground])
Parameters
- x
World X location. - y
World Y location. - z
World Z location. - XAxisX
X axis alignment of the circle - XAxisY
X axis alignment of the circle - XAxisZ
X axis alignment of the circle - YAxisX
Y axis alignment of the circle - YAxisY
Y axis alignment of the circle - YAxisZ
Y axis alignment of the circle - Radius (optional)
The circle radius, default: 1.0 - bForeground (optional)
true to draw in front of geometry, default: false
Return Value
- Returns nothing.
Example
Example usage can be found in the map editor script package: https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/6f45ad9607e30c97f4f1d58443d808da632d4d91/mapeditor/client/editor.lua#L164
