Table of Contents

Class ProfileConfiguration

Namespace
Artemis.Core
Assembly
Artemis.Core.dll

Represents the configuration of a profile, contained in a ProfileCategory

public class ProfileConfiguration : BreakableModel, IBreakableModel, IStorageModel, IDisposable, IPluginFeatureDependent
Inheritance
object
CorePropertyChanged
ProfileConfiguration
Implements
Inherited Members

Fields

Empty

Represents an empty profile.

public static readonly ProfileConfiguration Empty

Field Value

ProfileConfiguration

Properties

ActivationBehaviour

Gets or sets the behaviour of when this profile is activated

public ActivationBehaviour ActivationBehaviour { get; set; }

Property Value

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

public NodeScript<bool> ActivationCondition { get; }

Property Value

NodeScript<bool>

ActivationConditionMet

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

public bool ActivationConditionMet { get; }

Property Value

bool

BrokenDisplayName

Gets the display name of this breakable model

public override string BrokenDisplayName { get; }

Property Value

string

Category

Gets or sets the category of this profile configuration

public ProfileCategory Category { get; }

Property Value

ProfileCategory

DisableHotkey

Gets or sets the hotkey used to disable the profile

public Hotkey? DisableHotkey { get; set; }

Property Value

Hotkey

EnableHotkey

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

public Hotkey? EnableHotkey { get; set; }

Property Value

Hotkey

Entity

Gets the entity used by this profile config

public ProfileContainerEntity Entity { get; }

Property Value

ProfileContainerEntity

FadeInAndOut

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

public bool FadeInAndOut { get; set; }

Property Value

bool

HotkeyMode

Gets or sets the ProfileConfigurationHotkeyMode used to determine hotkey behaviour

public ProfileConfigurationHotkeyMode HotkeyMode { get; set; }

Property Value

ProfileConfigurationHotkeyMode

Icon

Gets the icon configuration

public ProfileConfigurationIcon Icon { get; }

Property Value

ProfileConfigurationIcon

IsMissingModule

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

public bool IsMissingModule { get; }

Property Value

bool

IsSuspended

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

public bool IsSuspended { get; set; }

Property Value

bool

Module

Gets or sets the module this profile uses

public Module? Module { get; set; }

Property Value

Module

Name

Gets or sets the name of this profile configuration

public string Name { get; set; }

Property Value

string

Order

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

public int Order { get; set; }

Property Value

int

Profile

Gets the profile of this profile configuration

public Profile? Profile { get; }

Property Value

Profile

ProfileId

Gets the ID of the profile of this profile configuration

public Guid ProfileId { get; }

Property Value

Guid

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetFeatureDependencies()

Gets the plugin features this class depends on, may contain the same plugin feature twice if depending on it in multiple ways.

public IEnumerable<PluginFeature> GetFeatureDependencies()

Returns

IEnumerable<PluginFeature>

A List<T> of PluginFeature this class depends on.

Load()

Loads the model from its associated entity

public void Load()

Save()

Saves the model to its associated entity

public void Save()

ShouldBeActive(bool)

Determines whether the profile of this configuration should be active

public bool ShouldBeActive(bool includeActivationCondition)

Parameters

includeActivationCondition bool

Whether or not to take activation conditions into consideration

Returns

bool

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Update()

Updates this configurations activation condition status

public void Update()