Class TemperatureAlgorithm

Namespace

S1API.Temperature

Assembly

S1API.dll

Queries temperatures with the game's native temperature algorithm.

public static class TemperatureAlgorithm

Inheritance

object

TemperatureAlgorithm

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

GetTemperatureAtPoint(float, Vector3, Vector3, TemperatureEmitterInfo[])

Calculates the temperature at a world position from an ambient temperature and emitter snapshots.

public static float GetTemperatureAtPoint(float ambientTemperature, Vector3 originPoint, Vector3 point, TemperatureEmitterInfo[] emitters)

Parameters

ambientTemperature float

The ambient temperature in degrees Celsius.

originPoint Vector3

The world origin forwarded to the native API for signature compatibility. The current native implementation evaluates world-space emitter and query positions directly and does not otherwise use this value.

point Vector3

The world position to query.

emitters TemperatureEmitterInfo[]

The emitter snapshots to include in the calculation.

Returns

float

The temperature at point in degrees Celsius.

Remarks

This method does not discover scene emitters or register the supplied snapshots with a grid.

Exceptions

ArgumentNullException

emitters is null.

ArgumentOutOfRangeException

A scalar or vector input is not finite.