Skip to main content
Version: 1.1.1

Struct Furniture

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

A chair, bed or other piece of furniture 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(ParentCell), "")]
[Include(typeof(ScriptPolicy), "")]
public readonly struct Furniture : 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​

bool

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​

bool

IsValid​

public bool IsValid { get; }

Property Value​

bool

Kind​

Whether the cell is an interior or an exterior, or Unknown before the game has said.

public ParentCellKind Kind { get; set; }

Property Value​

ParentCellKind

Position​

The position in the game's world space, in centimeters.

public Vector3 Position { get; set; }

Property Value​

Vector3

RefId​

The ref id of this placed object or actor.

public uint RefId { get; set; }

Property Value​

uint

Rotation​

The yaw, in degrees.

public float Rotation { get; set; }

Property Value​

float

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

X​

The X coordinate of the exterior grid square.

public int X { get; set; }

Property Value​

int

Y​

The Y coordinate of the exterior grid square.

public int Y { get; set; }

Property Value​

int

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 Furniture Keep()

Returns​

Furniture

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

  • Properties
    • BaseId
    • IsDestroyed
    • IsDisabled
    • IsValid
    • Kind
    • Position
    • RefId
    • Rotation
    • Run
    • Target
    • X
    • Y
  • Methods
    • As<T>()
    • Is<T>()
    • Keep()
    • TryAs<T>(out T)