Class ProfileModule

Allows you to add support for new games/applications while utilizing Artemis' profile engine

Inheritance
System.Object
CorePropertyChanged
PluginFeature
DataModelPluginFeature
Module
ProfileModule
ProfileModule<T>
Implements
System.IDisposable
Inherited Members
Namespace: Artemis.Core.Modules
Assembly: Artemis.Core.dll
Syntax
public abstract class ProfileModule : Module, INotifyPropertyChanged, IDisposable

Constructors

| Improve this Doc View Source

ProfileModule()

Creates a new instance of the ProfileModule class

Declaration
protected ProfileModule()

Fields

| Improve this Doc View Source

HiddenPropertiesList

Gets a list of all properties ignored at runtime using IgnoreProperty(x => x.y)

Declaration
protected readonly List<PropertyInfo> HiddenPropertiesList
Field Value
Type Description
System.Collections.Generic.List<System.Reflection.PropertyInfo>

Properties

| Improve this Doc View Source

ActiveProfile

Gets the currently active profile

Declaration
public Profile ActiveProfile { get; }
Property Value
Type Description
Profile
| Improve this Doc View Source

AnimatingProfileChange

Indicates whether or not a profile change is being animated

Declaration
public bool AnimatingProfileChange { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

HiddenProperties

Gets a list of all properties ignored at runtime using IgnoreProperty(x => x.y)

Declaration
public ReadOnlyCollection<PropertyInfo> HiddenProperties { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<System.Reflection.PropertyInfo>
| Improve this Doc View Source

IsProfileUpdatingDisabled

Disables updating the profile, rendering does continue

Declaration
public bool IsProfileUpdatingDisabled { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

OpacityOverride

Overrides the opacity of the root folder

Declaration
public double OpacityOverride { get; set; }
Property Value
Type Description
System.Double

Methods

| Improve this Doc View Source

AddDefaultProfile(String)

Adds a default profile by reading it from the file found at the provided path

Declaration
protected bool AddDefaultProfile(string file)
Parameters
Type Name Description
System.String file

A path pointing towards a profile file. May be relative to the plugin directory.
Returns
Type Description
System.Boolean

true if the default profile was added; false if it was not because it is already in the list.
| Improve this Doc View Source

OnActiveProfileChanged()

Invokes the ActiveProfileChanged event

Declaration
protected virtual void OnActiveProfileChanged()
| Improve this Doc View Source

ProfileRendered(Double, SKCanvas, SKImageInfo)

Called after the profile has rendered

Declaration
public virtual void ProfileRendered(double deltaTime, SKCanvas canvas, SKImageInfo canvasInfo)
Parameters
Type Name Description
System.Double deltaTime

Time since the last render
SkiaSharp.SKCanvas canvas
SkiaSharp.SKImageInfo canvasInfo
| Improve this Doc View Source

ProfileUpdated(Double)

Called after the profile has updated

Declaration
public virtual void ProfileUpdated(double deltaTime)
Parameters
Type Name Description
System.Double deltaTime

Time in seconds since the last update

Events

| Improve this Doc View Source

ActiveProfileChanged

Occurs when the ActiveProfile has changed

Declaration
public event EventHandler ActiveProfileChanged
Event Type
Type Description
System.EventHandler

Implements

System.IDisposable