Interface IHasClientControlledContainers

Namespace: Eco.Gameplay.Utils
Assembly: Eco.Gameplay.dll
Syntax
public interface IHasClientControlledContainers : IController, IViewController, IHasUniversalID

Methods

Add(Player, String)

Adds entry from registrar. The container and the entries are gotten from listName, then the container adds the player and each entry.

Declaration
virtual object Add(Player player, string listName)
Parameters
Type Name Description
Player player
System.String listName
Returns
Type Description
System.Object

Move(Player, String, Int32, Int32)

Move entry. The container is gotten from listName, then the container Moves the selected iEntry to the newIndex

Declaration
virtual void Move(Player player, string listName, int iEntry, int newIndex)
Parameters
Type Name Description
Player player
System.String listName
System.Int32 iEntry
System.Int32 newIndex

MoveRelative(Player, String, IController, Int32)

Moves entry. The container is gotten from listName, then the entry is shifted in the container iDeltaMove positions

Declaration
virtual void MoveRelative(Player player, string listName, IController entry, int iDeltaMove)
Parameters
Type Name Description
Player player
System.String listName
IController entry
System.Int32 iDeltaMove

Remove(Player, String, IController)

Removes entry from registrar. The container is gotten from listName, then the container removes the selected entry

Declaration
virtual Task<bool> Remove(Player player, string listName, IController entry)
Parameters
Type Name Description
Player player
System.String listName
IController entry
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

RemoveAt(Player, String, Int32)

Removes index from registrar. The container is gotten from listName, then the container removes the selected index

Declaration
virtual Task<bool> RemoveAt(Player player, string listName, int index)
Parameters
Type Name Description
Player player
System.String listName
System.Int32 index
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

RemoveInternal(Player, String, Object, IClientControlledContainer, PropertyInfo, Func<Result>)

Removes entry from registrar (shared logic). The container is gotten from listName, then the container removes the selected entry

Declaration
virtual Task<bool> RemoveInternal(Player player, string listName, object entry, IClientControlledContainer container, PropertyInfo property, Func<Result> removeFunc)
Parameters
Type Name Description
Player player
System.String listName
System.Object entry
IClientControlledContainer container
System.Reflection.PropertyInfo property
System.Func<Result> removeFunc
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

SetAt(Player, String, Int32, Object)

Replaces the existing entry of a list at given index.

Declaration
virtual void SetAt(Player player, string listName, int iEntry, object newEntry)
Parameters
Type Name Description
Player player
System.String listName
System.Int32 iEntry
System.Object newEntry

VerifyCanAdd(Player, IClientControlledContainer, Object)

Declaration
virtual bool VerifyCanAdd(Player player, IClientControlledContainer container, object obj)
Parameters
Type Name Description
Player player
IClientControlledContainer container
System.Object obj
Returns
Type Description
System.Boolean

VerifyCanMove(Player, IClientControlledContainer, Int32, Int32)

Declaration
virtual bool VerifyCanMove(Player player, IClientControlledContainer container, int index, int newIndex)
Parameters
Type Name Description
Player player
IClientControlledContainer container
System.Int32 index
System.Int32 newIndex
Returns
Type Description
System.Boolean

VerifyCanRemove(Player, IClientControlledContainer, Object)

Declaration
virtual Task<Result> VerifyCanRemove(Player player, IClientControlledContainer container, object obj)
Parameters
Type Name Description
Player player
IClientControlledContainer container
System.Object obj
Returns
Type Description
System.Threading.Tasks.Task<Result>

VerifyNewSetIsValid(Player, IClientControlledContainer, IEnumerable<Object>)

Declaration
virtual Task<Result> VerifyNewSetIsValid(Player player, IClientControlledContainer container, IEnumerable<object> newSet)
Parameters
Type Name Description
Player player
IClientControlledContainer container
System.Collections.Generic.IEnumerable<System.Object> newSet
Returns
Type Description
System.Threading.Tasks.Task<Result>

Extension Methods