Class ProfileModule<T>
Allows you to add support for new games/applications while utilizing Artemis' profile engine and your own data model
Inheritance
Implements
Inherited Members
Namespace: Artemis.Core.Modules
Assembly: Artemis.Core.dll
Syntax
public abstract class ProfileModule<T> : ProfileModule, INotifyPropertyChanged, IDisposable where T : DataModel
Type Parameters
Name | Description |
---|---|
T |
Properties
| Improve this Doc View SourceDataModel
The data model driving this module
Note: This default data model is automatically registered upon plugin enable
Declaration
public T DataModel { get; }
Property Value
Type | Description |
---|---|
T |
ExpandsDataModel
Gets or sets whether this module must also expand the main data model
Note: If expanding the main data model is all you want your plugin to do, create a BaseDataModelExpansion plugin instead.
Declaration
public bool ExpandsDataModel { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
| Improve this Doc View SourceGetDataModelDescription()
Override to provide your own data model description. By default this returns a description matching your plugin name and description
Declaration
public virtual DataModelPropertyAttribute GetDataModelDescription()
Returns
Type | Description |
---|---|
DataModelPropertyAttribute |
HideProperty<TProperty>(Expression<Func<T, TProperty>>)
Hide the provided property using a lambda expression, e.g. HideProperty(dm => dm.TimeDataModel.CurrentTimeUTC)
Declaration
public void HideProperty<TProperty>(Expression<Func<T, TProperty>> propertyLambda)
Parameters
Type | Name | Description |
---|---|---|
System.Linq.Expressions.Expression<System.Func<T, TProperty>> | propertyLambda | A lambda expression pointing to the property to ignore |
Type Parameters
Name | Description |
---|---|
TProperty |
ShowProperty<TProperty>(Expression<Func<T, TProperty>>)
Stop hiding the provided property using a lambda expression, e.g. ShowProperty(dm => dm.TimeDataModel.CurrentTimeUTC)
Declaration
public void ShowProperty<TProperty>(Expression<Func<T, TProperty>> propertyLambda)
Parameters
Type | Name | Description |
---|---|---|
System.Linq.Expressions.Expression<System.Func<T, TProperty>> | propertyLambda | A lambda expression pointing to the property to stop ignoring |
Type Parameters
Name | Description |
---|---|
TProperty |