Class BuildableFobEntity<TInfo>

Namespace

Uncreated.Warfare.FOBs.Entities

Assembly

Uncreated.Warfare.dll

public class BuildableFobEntity<TInfo> : IBuildableFobEntity, IFobEntity, ITransformObject, IDisposable where TInfo : IBuildableFobEntityInfo

Type Parameters

TInfo

Inheritance

object

BuildableFobEntity<TInfo>

Implements

IBuildableFobEntity

IFobEntity

ITransformObject

IDisposable

Derived

ShovelableBuildable

FortificationEntity

RestockableBuildableFobEntity<TInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TransformObjectExtensions.InRadiusOf(ITransformObject, in Vector3, float, bool)

TransformObjectExtensions.TransformPoint(ITransformObject, Vector3)

Constructors

BuildableFobEntity(TInfo?, IBuildable, Team, IServiceProvider, string?)

public BuildableFobEntity(TInfo? info, IBuildable buildable, Team team, IServiceProvider serviceProvider, string? iconOverride = null)

Parameters

info TInfo

buildable IBuildable

team Team

serviceProvider IServiceProvider

iconOverride string

Properties

Buildable

The buildable this FOB entity is based on.

public IBuildable Buildable { get; }

Property Value

IBuildable

Icon

The floating icon above this buildable.

public WorldIconInfo? Icon { get; }

Property Value

WorldIconInfo

IdentifyingAsset

The primary asset that identifies this fob entity.

public virtual IAssetLink<Asset> IdentifyingAsset { get; }

Property Value

IAssetLink<Asset>

Info

Shovelable or supply crate info of this buildable if it's configured.

public TInfo? Info { get; }

Property Value

TInfo

IsIconVisible

Temporarily hides the icon.

public bool IsIconVisible { get; set; }

Property Value

bool

Position

The world position of the object.

public Vector3 Position { get; }

Property Value

Vector3

Exceptions

GameThreadException

Not on main thread.

NotSupportedException

Not able to set position.

PreventItemDrops

Whether or not contained items should be dropped when this buildable is destroyed.

public virtual bool PreventItemDrops { get; }

Property Value

bool

Rotation

The world rotation of the object.

public Quaternion Rotation { get; }

Property Value

Quaternion

Exceptions

GameThreadException

Not on main thread.

NotSupportedException

Not able to set rotation.

Team

The team this buildable belongs to.

public Team Team { get; }

Property Value

Team

Methods

DestroyIcon()

protected void DestroyIcon()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public virtual void Dispose()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

UpdateConfiguration(FobConfiguration)

Called when the FobConfiguration is updated.

public virtual void UpdateConfiguration(FobConfiguration configuration)

Parameters

configuration FobConfiguration