Class ViewEditor

Inheritance
System.Object
ViewEditor
Namespace: Eco.Gameplay.Systems
Assembly: Eco.Gameplay.dll
Syntax
public class ViewEditor : Object, IController, IViewController, IHasUniversalID, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, INotifyPropertyChanged, IDisplayErrorUI, IProvidesContext

Constructors

ViewEditor()

Declaration
public ViewEditor()

Properties

ButtonColor

Declaration
public Color ButtonColor { get; set; }
Property Value
Type Description
Color

ButtonText

Declaration
public string ButtonText { get; set; }
Property Value
Type Description
System.String

ContextProvided

Declaration
public IEnumerable<IContextValue> ContextProvided { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IContextValue>

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

ErrorData

Declaration
public ErrorDisplayData ErrorData { get; set; }
Property Value
Type Description
ErrorDisplayData

Errors

Declaration
public List<PropError> Errors { get; set; }
Property Value
Type Description
System.Collections.Generic.List<PropError>

HasBackButton

Declaration
public bool HasBackButton { get; set; }
Property Value
Type Description
System.Boolean

ObjectToEdit

Declaration
public IController ObjectToEdit { get; set; }
Property Value
Type Description
IController

OverrideTitle

Declaration
public string OverrideTitle { get; set; }
Property Value
Type Description
System.String

ShowAdminEditableProperties

Declaration
public bool ShowAdminEditableProperties { get; set; }
Property Value
Type Description
System.Boolean

Subscriptions

Declaration
public ref ThreadSafeSubscriptions Subscriptions { get; }
Property Value
Type Description
ThreadSafeSubscriptions

Methods

Close(Player)

When the view get closed, we invoke the onClose event.

Declaration
public void Close(Player player)
Parameters
Type Name Description
Player player

CloseForUser(User, ViewEditor.WindowType)

Tell the user to close an open editor.

Declaration
public static void CloseForUser(User user, ViewEditor.WindowType windowType)
Parameters
Type Name Description
User user
ViewEditor.WindowType windowType

Edit(User, IController, Action<IController>, ISaveablePlugin, String, Nullable<Color>, String, ViewEditor.WindowType, Boolean, IProvidesContext, Action<IController>, Action<IController>, Boolean)

Declaration
public static void Edit(User user, IController toEdit, Action<IController> onSubmit = null, ISaveablePlugin savePlugin = null, string buttonText = null, Nullable<Color> buttonColor = null, string overrideTitle = null, ViewEditor.WindowType windowType, bool readOnly = false, IProvidesContext overrideContext = null, Action<IController> onClose = null, Action<IController> onBack = null, bool showAdminEditableOnlyProperties = false)
Parameters
Type Name Description
User user
IController toEdit
System.Action<IController> onSubmit
ISaveablePlugin savePlugin
System.String buttonText
System.Nullable<Color> buttonColor
System.String overrideTitle
ViewEditor.WindowType windowType
System.Boolean readOnly
IProvidesContext overrideContext
System.Action<IController> onClose
System.Action<IController> onBack
System.Boolean showAdminEditableOnlyProperties

Finalize()

Declaration
protected override void Finalize()

Init()

Declaration
public void Init()

OnPropertyChanged(String, Object, Object)

Declaration
public void OnPropertyChanged(string propertyName, object before, object after)
Parameters
Type Name Description
System.String propertyName
System.Object before
System.Object after

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods