Class ItemDistributionComponent

Inheritance
System.Object
WorldObjectComponent
ItemDistributionComponent
Inherited Members
Namespace: Eco.Gameplay.Components
Assembly: Eco.Gameplay.dll
Syntax
[ChatCommandHandler]
[RequireComponent]
public class ItemDistributionComponent : WorldObjectComponent, ILinkable, IOwned, IController, IViewController, IHasUniversalID, IHasSerializableID, IRPCAuthChecks, INotifyPropertyChanged, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasInteractions, IPersistentData, IGameActionAware, ICanOverrideAuth

Constructors

ItemDistributionComponent()

Declaration
public ItemDistributionComponent()

Properties

AppliedDistributionData

Declaration
public ItemDistributionData AppliedDistributionData { get; set; }
Property Value
Type Description
ItemDistributionData

Availability

Declaration
public override WorldObjectComponentClientAvailability Availability { get; }
Property Value
Type Description
WorldObjectComponentClientAvailability
Overrides

AvailableStacks

Declaration
public IEnumerable<ItemStack> AvailableStacks { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ItemStack>

CitizensWithAccess

Declaration
public IEnumerable<User> CitizensWithAccess { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<User>

DistributionData

Declaration
[NewTooltipChildren]
public ItemDistributionData DistributionData { get; set; }
Property Value
Type Description
ItemDistributionData

MaxSecondsToGetStuff

Declaration
public double MaxSecondsToGetStuff { get; }
Property Value
Type Description
System.Double

PersistentData

Declaration
public object PersistentData { get; set; }
Property Value
Type Description
System.Object

Stacks

Declaration
public IEnumerable<ItemStack> Stacks { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ItemStack>

Title

Declaration
public LocString Title { get; }
Property Value
Type Description
LocString

Methods

ActionPerformed(GameAction)

Declaration
public void ActionPerformed(GameAction action)
Parameters
Type Name Description
GameAction action

ApplyInternal(User)

Declaration
protected void ApplyInternal(User executor)
Parameters
Type Name Description
User executor

CanRecieveDistribution(User)

Declaration
public bool CanRecieveDistribution(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean

Describe()

Declaration
public LocString Describe()
Returns
Type Description
LocString

DescribeConsumers()

Declaration
public LocString DescribeConsumers()
Returns
Type Description
LocString

Destroy()

Declaration
public override void Destroy()
Overrides

DistributionStation(User, Boolean, Int32, Int32, Int32, Boolean)

Declaration
[ChatSubCommand]
public static void DistributionStation(User user, bool fixedCount = false, int itemMax = 20, int itemDistribute = 1, int itemCountMax = 1, bool carried = false)
Parameters
Type Name Description
User user
System.Boolean fixedCount
System.Int32 itemMax
System.Int32 itemDistribute
System.Int32 itemCountMax
System.Boolean carried

DistributionStationCarried(User)

Declaration
[ChatSubCommand]
public static void DistributionStationCarried(User user)
Parameters
Type Name Description
User user

GetTrackerByUser(User)

Declaration
public ItemTracker GetTrackerByUser(User user)
Parameters
Type Name Description
User user
Returns
Type Description
ItemTracker

Initialize()

Declaration
public override void Initialize()
Overrides

ResetTrackersInternal(User)

Declaration
protected void ResetTrackersInternal(User executor)
Parameters
Type Name Description
User executor

ShouldOverrideAuth(IAlias, IOwned, GameAction)

Declaration
public LazyResult ShouldOverrideAuth(IAlias alias, IOwned property, GameAction action)
Parameters
Type Name Description
IAlias alias
IOwned property
GameAction action
Returns
Type Description
LazyResult

ShouldReceiveDistribution(User)

Declaration
public bool ShouldReceiveDistribution(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods