Struct WorldActivator
Namespace: OblivionMP.SDK.Common.Archetypes
Assembly: OblivionMP.SDK.Common.dll
A lever, gate, trap, trigger or other activator placed in the world.
[Archetype]
[Tag(typeof(AllowOwnershipTransferOnScopeEnterTag))]
[Tag(typeof(AllowOwnershipTransferOnScopeLeaveTag))]
[Include(typeof(RefIdMixin), "")]
[Include(typeof(BaseIdMixin), "")]
[Include(typeof(Transform), "")]
[Include(typeof(Presence), "")]
[Include(typeof(ScriptVariables), "")]
[Include(typeof(Sequence), "")]
[Include(typeof(LinkedPathPointsState), "")]
[Include(typeof(ScriptPolicy), "")]
public readonly struct WorldActivator : IArchetype, IArchetypeQueryable, IEntityShape
Implements
IArchetype, IArchetypeQueryable, IEntityShape
Inherited Members
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Properties
BaseId
The form this entity is made from, such as which kind of chest or which creature.
public NetworkFormId BaseId { get; set; }
Property Value
NetworkFormId
IsDestroyed
Whether a script marked the object destroyed, which keeps it from activating.
public bool IsDestroyed { get; set; }
Property Value
IsDisabled
Whether a seeded ref is enabled in the world. Starts from the game files and only the server writes it.
public bool IsDisabled { get; set; }
Property Value
IsValid
public bool IsValid { get; }
Property Value
LastFinished
The sequence's name, empty when the object never played one.
public NativeString64 LastFinished { get; set; }
Property Value
NativeString64
Position
The position in the game's world space, in centimeters.
public Vector3 Position { get; set; }
Property Value
RefId
The ref id of this placed object or actor.
public uint RefId { get; set; }
Property Value
RollIndex
How many random rolls the script made, so every client continues the same sequence.
public uint RollIndex { get; set; }
Property Value
Rotation
The yaw, in degrees.
public float Rotation { get; set; }
Property Value
Run
How the ref's own script blocks run, SessionDefault for the session's rule of its kind.
public ScriptRunPolicy Run { get; set; }
Property Value
ScriptRunPolicy
State
public LinkedPathPoints State { get; set; }
Property Value
LinkedPathPoints
Target
How script commands that change the ref run, SessionDefault for the session's rule.
public ScriptTargetPolicy Target { get; set; }
Property Value
ScriptTargetPolicy
VariablesCount
public int VariablesCount { get; }
Property Value
Methods
AddVariables(in ScriptVariable)
[Changes("ScriptVariables.Field.Variables")]
public void AddVariables(in ScriptVariable value)
Parameters
value ScriptVariable
As<T>()
public T As<T>() where T : struct, IArchetypeQueryable
Returns
T
Type Parameters
T
ClearVariables()
[Changes("ScriptVariables.Field.Variables")]
public void ClearVariables()
ContainsVariables(in ScriptVariable)
public bool ContainsVariables(in ScriptVariable value)
Parameters
value ScriptVariable
Returns
GetVariables()
public NativeList<ScriptVariable>.ReadOnly GetVariables()
Returns
NativeList<ScriptVariable>.ReadOnly
GetVariables(int)
public ScriptVariable GetVariables(int index)
Parameters
index int
Returns
ScriptVariable
InsertVariables(int, in ScriptVariable)
[Changes("ScriptVariables.Field.Variables")]
public void InsertVariables(int index, in ScriptVariable value)
Parameters
index int
value ScriptVariable
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 WorldActivator 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.
RemoveAtVariables(int)
[Changes("ScriptVariables.Field.Variables")]
public ScriptVariable RemoveAtVariables(int index)
Parameters
index int
Returns
ScriptVariable
SetVariables(in NativeList<ScriptVariable>)
[Changes("ScriptVariables.Field.Variables")]
public void SetVariables(in NativeList<ScriptVariable> value)
Parameters
value NativeList<ScriptVariable>
SetVariables(int, in ScriptVariable)
[Changes("ScriptVariables.Field.Variables")]
public void SetVariables(int index, in ScriptVariable value)
Parameters
index int
value ScriptVariable
TryAs<T>(out T)
public bool TryAs<T>(out T archetype) where T : struct, IArchetypeQueryable
Parameters
archetype T
Returns
Type Parameters
T