Class ProfileConfiguration

Represents the configuration of a profile, contained in a ProfileCategory

Inheritance

object

CorePropertyChanged

BreakableModel

ProfileConfiguration

Implements

IBreakableModel

IStorageModel

IDisposable

Inherited Members

BreakableModel.OnBrokenStateChanged()

BreakableModel.TryOrBreak(Action, string)

BreakableModel.SetBrokenState(string, Exception)

BreakableModel.ClearBrokenState(string)

BreakableModel.GetBrokenHierarchy()

BreakableModel.BrokenState

BreakableModel.BrokenStateException

BreakableModel.BrokenStateChanged

Namespace: Artemis.Core

Assembly: Artemis.Core.dll

Syntax

public class ProfileConfiguration : BreakableModel, IBreakableModel, IStorageModel, IDisposable

Fields

Empty

Represents an empty profile.

Declaration

public static readonly ProfileConfiguration Empty

Field Value

Type	Description
ProfileConfiguration

Properties

ActivationBehaviour

Gets or sets the behaviour of when this profile is activated

Declaration

public ActivationBehaviour ActivationBehaviour { get; set; }

Property Value

Type	Description
ActivationBehaviour

ActivationCondition

Gets the data model condition that must evaluate to true for this profile to be activated alongside any activation requirements of the Module, if set

Declaration

public NodeScript<bool> ActivationCondition { get; }

Property Value

Type	Description
NodeScript<bool>

ActivationConditionMet

Gets a boolean indicating whether the activation conditions where met during the last Update() call

Declaration

public bool ActivationConditionMet { get; }

Property Value

Type	Description
bool

BrokenDisplayName

Gets the display name of this breakable model

Declaration

public override string BrokenDisplayName { get; }

Property Value

Type	Description
string

Overrides

BreakableModel.BrokenDisplayName

Category

Gets or sets the category of this profile configuration

Declaration

public ProfileCategory Category { get; }

Property Value

Type	Description
ProfileCategory

DisableHotkey

Gets or sets the hotkey used to disable the profile

Declaration

public Hotkey? DisableHotkey { get; set; }

Property Value

Type	Description
Hotkey

EnableHotkey

Gets or sets the hotkey used to enable or toggle the profile

Declaration

public Hotkey? EnableHotkey { get; set; }

Property Value

Type	Description
Hotkey

Entity

Gets the entity used by this profile config

Declaration

public ProfileConfigurationEntity Entity { get; }

Property Value

Type	Description
ProfileConfigurationEntity

FadeInAndOut

Gets or sets a boolean indicating whether this profile should fade in and out when enabling or disabling

Declaration

public bool FadeInAndOut { get; set; }

Property Value

Type	Description
bool

HotkeyMode

Gets or sets the ProfileConfigurationHotkeyMode used to determine hotkey behaviour

Declaration

public ProfileConfigurationHotkeyMode HotkeyMode { get; set; }

Property Value

Type	Description
ProfileConfigurationHotkeyMode

Icon

Gets the icon configuration

Declaration

public ProfileConfigurationIcon Icon { get; }

Property Value

Type	Description
ProfileConfigurationIcon

IsMissingModule

Gets a boolean indicating whether this profile configuration is missing any modules

Declaration

public bool IsMissingModule { get; }

Property Value

Type	Description
bool

IsSuspended

Gets or sets a boolean indicating whether this profile is suspended, disabling it regardless of the ActivationCondition

Declaration

public bool IsSuspended { get; set; }

Property Value

Type	Description
bool

Module

Gets or sets the module this profile uses

Declaration

public Module? Module { get; set; }

Property Value

Type	Description
Module

Name

Gets or sets the name of this profile configuration

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Order

The order in which this profile appears in the update loop and sidebar

Declaration

public int Order { get; set; }

Property Value

Type	Description
int

Profile

Gets the profile of this profile configuration

Declaration

public Profile? Profile { get; }

Property Value

Type	Description
Profile

ProfileId

Gets the ID of the profile of this profile configuration

Declaration

public Guid ProfileId { get; }

Property Value

Type	Description
Guid

Methods

Dispose()

Declaration

public void Dispose()

Load()

Loads the model from its associated entity

Declaration

public void Load()

Save()

Saves the model to its associated entity

Declaration

public void Save()

ShouldBeActive(bool)

Determines whether the profile of this configuration should be active

Declaration

public bool ShouldBeActive(bool includeActivationCondition)

Parameters

Type	Name	Description
bool	includeActivationCondition	Whether or not to take activation conditions into consideration

Returns

Type	Description
bool

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Update()

Updates this configurations activation condition status

Declaration

public void Update()

Implements

IBreakableModel

IStorageModel

IDisposable