Class ContextRankConfigs

Helper class for creating Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig objects.

Inheritance

System.Object

ContextRankConfigs

Namespace: BlueprintCore.Utils.Types

Assembly: BlueprintCore.dll

Syntax

public static class ContextRankConfigs

Remarks

Functions are split into two classes:

ContextRankConfigs Base class which creates a config with a specific base value type. A context rank config can only have one type so you should only call one of these functions for a config.
ProgressionExtensions Extension class which applies progressions. Like the base value, you can only have a single progression type so you should only call one of these functions for a config.

See ContextRankConfig on the wiki for more details about the component and ContextRankConfig Calculator for help determining which progression to use.

Create a rank based on Kingmaker.EntitySystem.Stats.StatType.Strength modifier with a bonus value of 2 and a max value of 30:

  var rankConfig = ContextRankConfigs.StatBonus(StatType.Strength, max: 30).WithBonusValueProgression(2);

Methods

| Improve this Doc View Source

BaseAttack(AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.BaseAttack

Declaration

public static ContextRankConfig BaseAttack(AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
Kingmaker.Enums.AbilityRankType	type	Type of config. Links the config to ContextValues with the same AbilityRankType.
System.Nullable<System.Int32>	max	Sets the max resulting value.
System.Nullable<System.Int32>	min	Sets the minimum resulting value.

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

BaseStat(StatType, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.BaseStat

Declaration

public static ContextRankConfig BaseStat(StatType stat, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
Kingmaker.EntitySystem.Stats.StatType	stat
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

Bombs(String, String[], String[], Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.Bombs

Declaration

public static ContextRankConfig Bombs(string feature, string[] classes, string[] archetypes, bool excludeClasses = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String	feature	Kingmaker.Blueprints.Classes.BlueprintFeature
System.String[]	classes	Kingmaker.Blueprints.Classes.BlueprintCharacterClass
System.String[]	archetypes	Kingmaker.Blueprints.Classes.BlueprintArchetype
System.Boolean	excludeClasses
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

BuffRank(String, Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.CasterBuffRank and Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.TargetBuffRank

Declaration

public static ContextRankConfig BuffRank(string buff, bool useTarget = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String	buff	Kingmaker.UnitLogic.Buffs.Blueprints.BlueprintBuff
System.Boolean	useTarget
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

CasterCR(AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.CasterCR

Declaration

public static ContextRankConfig CasterCR(AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
Kingmaker.Enums.AbilityRankType	type	Type of config. Links the config to ContextValues with the same AbilityRankType.
System.Nullable<System.Int32>	max	Sets the max resulting value.
System.Nullable<System.Int32>	min	Sets the minimum resulting value.

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

CasterLevel(Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.CasterLevel and Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.MaxCasterLevel

Declaration

public static ContextRankConfig CasterLevel(bool useMax = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.Boolean	useMax
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

CharacterLevel(AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.CharacterLevel

Declaration

public static ContextRankConfig CharacterLevel(AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
Kingmaker.Enums.AbilityRankType	type	Type of config. Links the config to ContextValues with the same AbilityRankType.
System.Nullable<System.Int32>	max	Sets the max resulting value.
System.Nullable<System.Int32>	min	Sets the minimum resulting value.

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

ClassLevel(String[], Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.ClassLevel

Declaration

public static ContextRankConfig ClassLevel(string[] classes, bool excludeClasses = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String[]	classes	Kingmaker.Blueprints.Classes.BlueprintCharacterClass
System.Boolean	excludeClasses
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

CustomProperty(String, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.CustomProperty

Declaration

public static ContextRankConfig CustomProperty(string property, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String	property	Kingmaker.UnitLogic.Mechanics.Properties.BlueprintUnitProperty
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

DungeonStage(AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.DungeonStage

Declaration

public static ContextRankConfig DungeonStage(AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
Kingmaker.Enums.AbilityRankType	type	Type of config. Links the config to ContextValues with the same AbilityRankType.
System.Nullable<System.Int32>	max	Sets the max resulting value.
System.Nullable<System.Int32>	min	Sets the minimum resulting value.

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

FeatureList(String[], Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.FeatureList and Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.FeatureListRanks

Declaration

public static ContextRankConfig FeatureList(string[] features, bool useRanks = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String[]	features	Kingmaker.Blueprints.Classes.BlueprintFeature
System.Boolean	useRanks
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

FeatureRank(String, Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.FeatureRank and Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.MasterFeatureRank

Declaration

public static ContextRankConfig FeatureRank(string feature, bool useMaster = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String	feature	Kingmaker.Blueprints.Classes.BlueprintFeature
System.Boolean	useMaster
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

MaxClassLevelWithArchetype(String[], String[], Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.MaxClassLevelWithArchetype

Declaration

public static ContextRankConfig MaxClassLevelWithArchetype(string[] classes, string[] archetypes, bool excludeClasses = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String[]	classes	Kingmaker.Blueprints.Classes.BlueprintCharacterClass
System.String[]	archetypes	Kingmaker.Blueprints.Classes.BlueprintArchetype
System.Boolean	excludeClasses
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

MaxCustomProperty(String[], AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.MaxCustomProperty

Declaration

public static ContextRankConfig MaxCustomProperty(string[] properties, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String[]	properties	Kingmaker.UnitLogic.Mechanics.Properties.BlueprintUnitProperty
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

MythicLevel(Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.MythicLevel and Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.MasterMythicLevel

Declaration

public static ContextRankConfig MythicLevel(bool useMaster = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.Boolean	useMaster
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

MythicLevelPlusBuffRank(String, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.MythicLevelPlusBuffRank

Declaration

public static ContextRankConfig MythicLevelPlusBuffRank(string buff, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String	buff	Kingmaker.UnitLogic.Buffs.Blueprints.BlueprintBuff
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

StatBonus(StatType, ModifierDescriptor, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.StatBonus

Declaration

public static ContextRankConfig StatBonus(StatType stat, ModifierDescriptor modDescriptor = ModifierDescriptor.None, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
Kingmaker.EntitySystem.Stats.StatType	stat
Kingmaker.Enums.ModifierDescriptor	modDescriptor
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

| Improve this Doc View Source

SumClassLevelWithArchetype(String[], String[], Boolean, Boolean, AbilityRankType, Nullable<Int32>, Nullable<Int32>)

Implements Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.OwnerSummClassLevelWithArchetype and Kingmaker.UnitLogic.Mechanics.Components.ContextRankBaseValueType.SummClassLevelWithArchetype

Declaration

public static ContextRankConfig SumClassLevelWithArchetype(string[] classes, string[] archetypes, bool excludeClasses = false, bool useOwner = false, AbilityRankType type = AbilityRankType.Default, int? max = null, int? min = null)

Parameters

Type	Name	Description
System.String[]	classes	Kingmaker.Blueprints.Classes.BlueprintCharacterClass
System.String[]	archetypes	Kingmaker.Blueprints.Classes.BlueprintArchetype
System.Boolean	excludeClasses
System.Boolean	useOwner
Kingmaker.Enums.AbilityRankType	type
System.Nullable<System.Int32>	max
System.Nullable<System.Int32>	min

Returns

Type	Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig