Struct Weather

Namespace: OblivionMp.Sdk.Common.Archetypes.Mixins
Assembly: OblivionMp.Sdk.Common.dll

The weather of an area.

[ArchetypeMixin]
[Extends(typeof(Area), "")]
public readonly struct Weather : IArchetypeMixin, IArchetypeQueryable, IEntityShape

Implements

IArchetypeMixin, IArchetypeQueryable, IEntityShape

Inherited Members

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties

TransitionRatio

How far the change to WeatherFormId has got, 0 to 1.

public float TransitionRatio { get; set; }

Property Value

float

WeatherFormId

The weather form.

public FormId WeatherFormId { get; set; }

Property Value

FormId

Methods

Keep()

This entity, which it already is: a loop over this shape hands over the shape itself.

public Weather Keep()

Returns

Weather

Remarks

Here so taking something out of a loop reads the same whichever way the loop walks. Whether a shape is walked by chunk follows from what it includes, which the call site cannot see and which changes when an include does.