Struct WorldState
Namespace: OblivionMP.SDK.Common.Archetypes.Mixins
Assembly: OblivionMP.SDK.Common.dll
The named world flags every player's game reads, such as the ones that gate a quest's compass target.
[ArchetypeMixin(Replication.OwnershipBased)]
[Extends(typeof(World), "")]
public readonly struct WorldState : 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
FlagsCount
public int FlagsCount { get; }
Property Value
Methods
AddFlags(in WorldFlagEntry)
[Changes("WorldState.Field.Flags")]
public void AddFlags(in WorldFlagEntry value)
Parameters
value WorldFlagEntry
As<T>()
public T As<T>() where T : struct, IArchetypeQueryable
Returns
T
Type Parameters
T
ClearFlags()
[Changes("WorldState.Field.Flags")]
public void ClearFlags()
ContainsFlags(in WorldFlagEntry)
public bool ContainsFlags(in WorldFlagEntry value)
Parameters
value WorldFlagEntry
Returns
GetFlags()
public NativeList<WorldFlagEntry>.ReadOnly GetFlags()
Returns
NativeList<WorldFlagEntry>.ReadOnly
GetFlags(int)
public WorldFlagEntry GetFlags(int index)
Parameters
index int
Returns
WorldFlagEntry
InsertFlags(int, in WorldFlagEntry)
[Changes("WorldState.Field.Flags")]
public void InsertFlags(int index, in WorldFlagEntry value)
Parameters
index int
value WorldFlagEntry
Is<T>()
public bool Is<T>() where T : struct, IArchetypeQueryable
Returns
Type Parameters
T
Keep()
This entity, which it already is: a loop over this shape hands over the shape itself.
public WorldState Keep()
Returns
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.
RemoveAtFlags(int)
[Changes("WorldState.Field.Flags")]
public WorldFlagEntry RemoveAtFlags(int index)
Parameters
index int
Returns
WorldFlagEntry
SetFlags(in NativeList<WorldFlagEntry>)
[Changes("WorldState.Field.Flags")]
public void SetFlags(in NativeList<WorldFlagEntry> value)
Parameters
value NativeList<WorldFlagEntry>
SetFlags(int, in WorldFlagEntry)
[Changes("WorldState.Field.Flags")]
public void SetFlags(int index, in WorldFlagEntry value)
Parameters
index int
value WorldFlagEntry
TryAs<T>(out T)
public bool TryAs<T>(out T archetype) where T : struct, IArchetypeQueryable
Parameters
archetype T
Returns
Type Parameters
T