s&box docs
API Referenceglobal

public sealed struct Angles

Euler angles. Unlike a Rotation, Euler angles can represent multiple revolutions (rotations) around an axis, but suffer from issues like gimbal lock and lack of a defined "up" vector. Use Rotation for most cases.

Broader workflow and conceptual references connected to this API.

Events

You can broadcast and listen to events in your scene using interfaces.

GameObject

A GameObject represents an object in the scene world. It contains a few different elements.

Math Types

A Vector is just a set of numbers that describe a position or a direction in space.

Network Helper

To make a multiplayer game you need to take care of a few things. There's a special component that helps with those things, called NetworkHelper. This is a simple component that fits a lot of situations, but can be used as an example to code your own network component.

Player Controller

The PlayerController component is a first and third person player controller.

Citizen Characters

This section needs to be rewritten with an explanation of all the code, libraries, etc.

Constructors

Showing 4 constructors

Methods

Showing 17 methods

public static Vector3 AngleVector(Angles ang)

Converts an angle to a forward vector.

public Vector3 AsVector3()

Return as a Vector3, where x = pitch etc

public static float ClampAngle(float v)

Clamps the angle to range of [0, 360)

public Angles Clamped()

Returns clamped version of this object, meaning the angle on each axis is transformed to range of [0,360).

public bool IsNearlyZero(double tolerance = 1E-06)

Returns true if this angles object's components are all nearly zero with given tolerance.

Parameters

  • tolerance: Default: 1E-06

public static Angles Lerp(Angles source, Angles target, float frac)

Performs linear interpolation on the two given angle objects.

Parameters

  • source: Angle A
  • target: Angle B
  • frac: Fraction in range [0,1] between the 2 angle objects to use for interpolation.

public Angles LerpTo(Angles target, float frac)

Performs linear interpolation on the two given angle objects.

Parameters

  • target: Angle B
  • frac: Fraction in range [0,1] between the 2 angle objects to use for interpolation.

public static float NormalizeAngle(float v)

Normalizes the angle to range of (-180, 180]

public Angles SnapToGrid(float gridSize, bool sx = True, bool sy = True, bool sz = True)

Snap to grid

Parameters

  • sx: Default: True
  • sy: Default: True
  • sz: Default: True

public Rotation ToRotation()

Converts these Euler angles to a rotation. The angles will be normalized.

public Angles WithPitch(float pitch)

Returns this angles object with given pitch component.

public Angles WithRoll(float roll)

Returns this angles object with given roll component.

public Angles WithYaw(float yaw)

Returns this angles object with given yaw component.

Properties

Showing 3 properties

public Vector3 Angles.Forward { get; set; }

The forward direction vector for this angle.

public Angles Angles.Normal { get; set; }

Returns normalized version of this object, meaning the angle on each axis is normalized to range of (-180,180].

public static Angles Angles.Random { get; set; }

Returns the angles of a uniformly random rotation.

Metadata

FieldValue
Namespaceglobal
Typeclass
AssemblySandbox.System
Doc IDT:Angles

AliasAttribute

Previous Page

BBox

Next Page

On this page

Constructorspublic Angles(Angles other)public Angles(System.Single pitch, System.Single yaw, System.Single roll)public Angles(System.Single all = 0)public Angles(Vector3 vector)Methodspublic static Vector3 AngleVector(Angles ang)public Vector3 AsVector3()public static System.Single ClampAngle(System.Single v)public Angles Clamped()public System.Boolean IsNearlyZero(System.Double tolerance = 1E-06)public static Angles Lerp(Angles source, Angles target, System.Single frac)public Angles LerpTo(Angles target, System.Single frac)public static System.Single NormalizeAngle(System.Single v)public static override Angles Parse(System.String str, System.IFormatProvider provider)public static Angles Parse(System.String str)public Angles SnapToGrid(System.Single gridSize, System.Boolean sx = True, System.Boolean sy = True, System.Boolean sz = True)public Rotation ToRotation()public static System.Boolean TryParse(System.String str, Angles result)public static override System.Boolean TryParse(System.String str, System.IFormatProvider provider, Angles result)public Angles WithPitch(System.Single pitch)public Angles WithRoll(System.Single roll)public Angles WithYaw(System.Single yaw)Propertiespublic Vector3 Angles.Forward { get; set; }public Angles Angles.Normal { get; set; }public static Angles Angles.Random { get; set; }Metadata