Skip to main content
Version: 1.1.1

Struct ScriptPolicy

Namespace: OblivionMP.SDK.Common.Archetypes.Mixins
Assembly: OblivionMP.SDK.Common.dll

How this ref's own scripts run and whether scripts may change it, where not the session's default.

[ArchetypeMixin(Replication.ServerAuthoritative)]
public readonly struct ScriptPolicy : 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​

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

Target​

How script commands that change the ref run, SessionDefault for the session's rule.

public ScriptTargetPolicy Target { get; set; }

Property Value​

ScriptTargetPolicy

Methods​

As<T>()​

public T As<T>() where T : struct, IArchetypeQueryable

Returns​

T

Type Parameters​

T

Is<T>()​

public bool Is<T>() where T : struct, IArchetypeQueryable

Returns​

bool

Type Parameters​

T

Keep()​

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

public ScriptPolicy Keep()

Returns​

ScriptPolicy

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.

TryAs<T>(out T)​

public bool TryAs<T>(out T archetype) where T : struct, IArchetypeQueryable

Parameters​

archetype T

Returns​

bool

Type Parameters​

T