DrawCircle3D

From Onset Developer Wiki
Revision as of 20:25, 30 August 2020 by BlueMountains (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
DrawCircle3D

Type: Function
Context: Client
Introduced: v1.0

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

See also