Show / Hide Table of Contents

Class UserTask

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

Constructors

UserTask()

Declaration
public UserTask()

Fields

ChainedTasksCompleted

Declaration
public int ChainedTasksCompleted
Field Value
Type Description
System.Int32

IsOpened

Declaration
public bool IsOpened
Field Value
Type Description
System.Boolean

OnComplete

Declaration
public ThreadSafeAction<bool> OnComplete
Field Value
Type Description
ThreadSafeAction<System.Boolean>

Properties

ActionsAtEnd

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

AutoSkip

Declaration
public Func<User, bool> AutoSkip { get; }
Property Value
Type Description
System.Func<User, System.Boolean>

ChainedTaskNames

Declaration
public IEnumerable<string> ChainedTaskNames { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

Complete

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

CompletedOnClient

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

ControllerID

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

DisplayPosition

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

LocalizedTitle

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

Popup

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

ShouldSkip

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

Skipped

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

SubTasks

Declaration
public ControllerList<UserSubTask> SubTasks { get; }
Property Value
Type Description
ControllerList<UserSubTask>

TargetUIName

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

Title

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

TutorialIndex

Declaration
public float TutorialIndex { get; }
Property Value
Type Description
System.Single

UIStateToSet

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

Methods

Added()

Declaration
public virtual void Added()

DeInit()

Declaration
public void DeInit()

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

GetPopup()

Declaration
public TutorialTaskPopup GetPopup()
Returns
Type Description
TutorialTaskPopup

GiveItems(User, Boolean)

Declaration
public void GiveItems(User user, bool forceGive = false)
Parameters
Type Name Description
User user
System.Boolean forceGive

Initialize(User, UserTaskTemplate)

Declaration
public void Initialize(User user, UserTaskTemplate template)
Parameters
Type Name Description
User user
UserTaskTemplate template

OnEnteredWorld()

Declaration
public void OnEnteredWorld()

Reset()

Declaration
public void Reset()

ResetSubTasks()

Declaration
public void ResetSubTasks()

ResetSubTasksState()

Declaration
public void ResetSubTasksState()

SkipTask(Player)

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

TriggerFromChainedTaskComplete()

Declaration
public void TriggerFromChainedTaskComplete()

Events

PropertyChanged

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

Implements

IController
IViewController
IHasUniversalID
System.ComponentModel.INotifyPropertyChanged

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾