Interface IModifierService

This IService manages and applies the IModifier and IModifiable.

Inherited Members
Namespace: IdleKit.Framework
Assembly: cs.temp.dll.dll
Syntax
public interface IModifierService : IService, IInjectable

Methods

ApplyModifiers<TModifierFormula>(IModifiable, ref Double, IModifier[])

Get the result of the modified value based on its IModifiable and IModifierFormula. Does not alter modifiedValue if IModifierFormula of cannot be found.

Declaration
void ApplyModifiers<TModifierFormula>(IModifiable modifiable, ref double modifiedValue, IModifier[] excludedModifier = null)
    where TModifierFormula : IModifierFormula
Parameters
Type Name Description
IModifiable modifiable
Double modifiedValue
IModifier[] excludedModifier
Type Parameters
Name Description
TModifierFormula

ApplyModifiers<TModifierFormula>(IModifiable, ref Double, Int32, IModifier[])

Get the result of the modified value based on its IModifiable and IModifierFormula. Does not alter modifiedValue if IModifierFormula of cannot be found. additionalLevels is there so the user can use this function to check the modifiedValue if the IModifier is upgraded further.

Declaration
void ApplyModifiers<TModifierFormula>(IModifiable modifiable, ref double modifiedValue, int additionalLevels, IModifier[] excludedModifier = null)
    where TModifierFormula : IModifierFormula
Parameters
Type Name Description
IModifiable modifiable
Double modifiedValue
Int32 additionalLevels
IModifier[] excludedModifier
Type Parameters
Name Description
TModifierFormula

GetAllModifiablesOfType<T>()

Returns an array of all IModifiableof a given type.

Declaration
T[] GetAllModifiablesOfType<T>()
    where T : class, IModifiable
Returns
Type Description
T[]
Type Parameters
Name Description
T

GetAllModifiersOfType<T>()

Returns an array of all IModifierof a given type.

Declaration
T[] GetAllModifiersOfType<T>()
    where T : class, IModifier
Returns
Type Description
T[]
Type Parameters
Name Description
T

GetModifiable<T>(String)

Returns a IModifiable of a given type and id.

Declaration
T GetModifiable<T>(string id)
    where T : class, IModifiable
Parameters
Type Name Description
String id
Returns
Type Description
T
Type Parameters
Name Description
T

GetModifiablesAffectedByModifier(IModifier)

Returns an array of all IModifiable affected by the given modifier

Declaration
IModifiable[] GetModifiablesAffectedByModifier(IModifier modifier)
Parameters
Type Name Description
IModifier modifier
Returns
Type Description
IModifiable[]

GetModifiablesAffectedByModifier(Type, IModifier)

Returns an array of all IModifiable objects affected by the given modifier. Use modifierFormulaType and the IModifierGroupData referenced in the formula to filter the results. Returns empty array if IModifierFormula of modifierFormulaType cannot be found.

Declaration
IModifiable[] GetModifiablesAffectedByModifier(Type modifierFormulaType, IModifier modifier)
Parameters
Type Name Description
Type modifierFormulaType
IModifier modifier
Returns
Type Description
IModifiable[]

GetModifiablesAffectedByModifier<TModifierFormula>(IModifier)

Returns an array of all IModifiable objects affected by the given modifier. Use TModifierFormula and the IModifierGroupData referenced in the formula to filter the results. Returns empty array if IModifierFormula of TModifierFormula cannot be found.

Declaration
IModifiable[] GetModifiablesAffectedByModifier<TModifierFormula>(IModifier modifier)
    where TModifierFormula : IModifierFormula
Parameters
Type Name Description
IModifier modifier
Returns
Type Description
IModifiable[]
Type Parameters
Name Description
TModifierFormula

GetModifier<T>(String)

Returns a IModifier of a given type and id.

Declaration
T GetModifier<T>(string id)
    where T : class, IModifier
Parameters
Type Name Description
String id
Returns
Type Description
T
Type Parameters
Name Description
T

GetModifiersAffectingModifiable(IModifiable)

Returns an array of all IModifier affecting the given modifiable.

Declaration
IModifier[] GetModifiersAffectingModifiable(IModifiable modifiable)
Parameters
Type Name Description
IModifiable modifiable
Returns
Type Description
IModifier[]

GetModifiersAffectingModifiable(Type, IModifiable)

Returns an array of all IModifier objects affecting the given modifiable. Use the IModifierFormula type and the IModifierGroupData referenced in the formula to filter the results. Returns empty array if IModifierFormula of modifierFormulaType cannot be found.

Declaration
IModifier[] GetModifiersAffectingModifiable(Type modifierFormulaType, IModifiable modifiable)
Parameters
Type Name Description
Type modifierFormulaType
IModifiable modifiable
Returns
Type Description
IModifier[]

GetModifiersAffectingModifiable<TModifierFormula>(IModifiable)

Returns an array of all IModifier affecting the given modifiable . Use the TModifierFormula and the IModifierGroupData referenced in the formula to filter the results. Returns empty array if IModifierFormula of TModifierFormula cannot be found.

Declaration
IModifier[] GetModifiersAffectingModifiable<TModifierFormula>(IModifiable modifiable)
    where TModifierFormula : IModifierFormula
Parameters
Type Name Description
IModifiable modifiable
Returns
Type Description
IModifier[]
Type Parameters
Name Description
TModifierFormula