Struct Journal

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

The quests and compass targets in a player's journal.

[ArchetypeMixin]
[Extends(typeof(Player), "")]
public readonly struct Journal : 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

CompassTargetsCount

public int CompassTargetsCount { get; }

Property Value

int

QuestsCount

public int QuestsCount { get; }

Property Value

int

Methods

AddCompassTargets(in QuestCompassTarget)

[Changes("Journal.Field.CompassTargets")]
public void AddCompassTargets(in QuestCompassTarget value)

Parameters

value QuestCompassTarget

AddQuests(in QuestEntry)

[Changes("Journal.Field.Quests")]
public void AddQuests(in QuestEntry value)

Parameters

value QuestEntry

ClearCompassTargets()

[Changes("Journal.Field.CompassTargets")]
public void ClearCompassTargets()

ClearQuests()

[Changes("Journal.Field.Quests")]
public void ClearQuests()

ContainsCompassTargets(in QuestCompassTarget)

public bool ContainsCompassTargets(in QuestCompassTarget value)

Parameters

value QuestCompassTarget

Returns

bool

ContainsQuests(in QuestEntry)

public bool ContainsQuests(in QuestEntry value)

Parameters

value QuestEntry

Returns

bool

GetCompassTargets()

public NativeList<QuestCompassTarget>.ReadOnly GetCompassTargets()

Returns

NativeList<QuestCompassTarget>.ReadOnly

GetCompassTargets(int)

public QuestCompassTarget GetCompassTargets(int index)

Parameters

index int

Returns

QuestCompassTarget

GetQuests()

public NativeList<QuestEntry>.ReadOnly GetQuests()

Returns

NativeList<QuestEntry>.ReadOnly

GetQuests(int)

public QuestEntry GetQuests(int index)

Parameters

index int

Returns

QuestEntry

InsertCompassTargets(int, in QuestCompassTarget)

[Changes("Journal.Field.CompassTargets")]
public void InsertCompassTargets(int index, in QuestCompassTarget value)

Parameters

index int

value QuestCompassTarget

InsertQuests(int, in QuestEntry)

[Changes("Journal.Field.Quests")]
public void InsertQuests(int index, in QuestEntry value)

Parameters

index int

value QuestEntry

Keep()

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

public Journal Keep()

Returns

Journal

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.

RemoveAtCompassTargets(int)

[Changes("Journal.Field.CompassTargets")]
public QuestCompassTarget RemoveAtCompassTargets(int index)

Parameters

index int

Returns

QuestCompassTarget

RemoveAtQuests(int)

[Changes("Journal.Field.Quests")]
public QuestEntry RemoveAtQuests(int index)

Parameters

index int

Returns

QuestEntry

SetCompassTargets(in NativeList<QuestCompassTarget>)

[Changes("Journal.Field.CompassTargets")]
public void SetCompassTargets(in NativeList<QuestCompassTarget> value)

Parameters

value NativeList<QuestCompassTarget>

SetCompassTargets(int, in QuestCompassTarget)

[Changes("Journal.Field.CompassTargets")]
public void SetCompassTargets(int index, in QuestCompassTarget value)

Parameters

index int

value QuestCompassTarget

SetQuests(in NativeList<QuestEntry>)

[Changes("Journal.Field.Quests")]
public void SetQuests(in NativeList<QuestEntry> value)

Parameters

value NativeList<QuestEntry>

SetQuests(int, in QuestEntry)

[Changes("Journal.Field.Quests")]
public void SetQuests(int index, in QuestEntry value)

Parameters

index int

value QuestEntry