Class UserTaskManager

Class for handling the tasks (so far just tutorials) that an individual user is given. Manages the creation, tracking, ordering, etc of them.

Inheritance
System.Object
UserTaskManager
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: Eco.Gameplay.Tutorial
Assembly: Eco.Gameplay.dll
Syntax
[ChatCommandHandler]
public class UserTaskManager : Object, IController, IViewController, IHasUniversalID, INotifyPropertyChanged

Constructors

UserTaskManager()

Declaration
public UserTaskManager()

Fields

ItemsGiven

Declaration
public ThreadSafeHashSet<string> ItemsGiven
Field Value
Type Description
ThreadSafeHashSet<System.String>

Properties

ControllerID

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

CurrentTaskPosition

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

OnTaskCompleted

Declaration
public ThreadSafeAction OnTaskCompleted { get; }
Property Value
Type Description
ThreadSafeAction

SkippedAll

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

Methods

AddSidePanelButton(String, String, Action)

Declaration
public void AddSidePanelButton(string id, string icon, Action onClick)
Parameters
Type Name Description
System.String id
System.String icon
System.Action onClick

AddViewedPopup(UserTask)

Declaration
public void AddViewedPopup(UserTask task)
Parameters
Type Name Description
UserTask task

AnyTasksActive()

Declaration
public bool AnyTasksActive()
Returns
Type Description
System.Boolean

GetSidePanelButton(String)

Declaration
public SidePanelButton GetSidePanelButton(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
SidePanelButton

GetUserTask(String)

Declaration
public UserTask GetUserTask(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
UserTask

Init(User)

Declaration
public void Init(User user)
Parameters
Type Name Description
User user

IsTaskComplete(String)

Declaration
public bool IsTaskComplete(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Boolean

RemoveSidePanelButton(String)

Declaration
public void RemoveSidePanelButton(string id)
Parameters
Type Name Description
System.String id

Reset(User)

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

ResetTutorial(Player)

Called from the escape menu on the client, resets all tutorials and clears tutorial cache on the client.

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

SkipAllTasks(Player)

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

SomeTasksComplete(IEnumerable<String>)

Declaration
public bool SomeTasksComplete(IEnumerable<string> names)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> names
Returns
Type Description
System.Boolean

Task(User, String)

Declaration
[ChatSubCommand]
public static void Task(User user, string taskName = null)
Parameters
Type Name Description
User user
System.String taskName

TaskAlreadyAdded(String)

Declaration
public bool TaskAlreadyAdded(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Boolean

TaskComplete(Boolean)

Declaration
public void TaskComplete(bool skipPopup = false)
Parameters
Type Name Description
System.Boolean skipPopup

TasksComplete(IEnumerable<String>)

Declaration
public bool TasksComplete(IEnumerable<string> names)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> names
Returns
Type Description
System.Boolean

TryAddActiveTask(String)

Declaration
public bool TryAddActiveTask(string taskName)
Parameters
Type Name Description
System.String taskName
Returns
Type Description
System.Boolean

TryShowTutorialPopup(TutorialTaskPopup)

Show a popup and track it as seen as a tutorial.

Declaration
public void TryShowTutorialPopup(TutorialTaskPopup popup)
Parameters
Type Name Description
TutorialTaskPopup popup

Tutorials(User)

Declaration
[ChatCommand]
public static void Tutorials(User user)
Parameters
Type Name Description
User user

UnlockUI(User)

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

UpdatePopupsFromClient(User)

Declaration
public void UpdatePopupsFromClient(User user)
Parameters
Type Name Description
User user

Events

PropertyChanged

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

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods