Struct Flora
Namespace: OblivionMp.Sdk.Common.Archetypes
Assembly: OblivionMp.Sdk.Common.dll
A plant or other harvestable object placed in the world.
[Archetype(true)]
[Tag(typeof(AllowOwnershipTransferOnScopeEnterTag))]
[Tag(typeof(AllowOwnershipTransferOnScopeLeaveTag))]
[Include(typeof(RefIdMixin), "")]
[Include(typeof(BaseIdMixin), "")]
[Include(typeof(Transform), "")]
[Include(typeof(Presence), "")]
[Include(typeof(FloraState), "")]
public readonly struct Flora : 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
HarvestedBy
The player who picked the plant.
public PlayerId HarvestedBy { get; set; }
Property Value
PlayerId
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
IsHarvested
Whether the plant has been picked.
public bool IsHarvested { get; set; }
Property Value
IsValid
public bool IsValid { get; }
Property Value
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
Rotation
The yaw, in degrees.
public float Rotation { get; set; }
Property Value
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
Type Parameters
T
Keep()
This entity, which it already is: a loop over this shape hands over the shape itself.
public Flora 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.
TryAs<T>(out T)
public bool TryAs<T>(out T archetype) where T : struct, IArchetypeQueryable
Parameters
archetype T
Returns
Type Parameters
T