Class BaseDungeonExpeditionConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.Dungeon
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseDungeonExpeditionConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintDungeonExpedition where TBuilder : BaseDungeonExpeditionConfigurator<T, TBuilder>
Type Parameters
Name | Description |
---|---|
T | |
TBuilder |
Remarks
Each supported blueprint type has a corresponding Configurator
class to create and modify blueprints of
that type, e.g. FeatureConfigurator supports BlueprintFeature
. Configurators exist for all
blueprint types inheriting from Kingmaker.Blueprints.BlueprintScriptableObject, excluding any that are not used in the
base game.
Creating a Blueprint
Use New(string, string)
to create a blueprint:
FeatureConfigurator.New(MyBlueprintName, MyBlueprintGuid)
Once New()
is called the blueprint is added to the game library and can be referenced.
Using the Configurator
New()
returns a configurator with methods to set or modify blueprint fields and add or modify
Kingmaker.Blueprints.BlueprintComponent:
FeatureConfigurator.New(MyBlueprintName, MyBlueprintGuid).AddToGroups(FeatureGroup.Feat).AddPrerequisiteAlignment(AlignmentMaskType.LawfulGood).Configure();
Each method call returns the configurator allowing you to chain calls. Nothing is modified on the blueprint until
Configure()
is called, at which point the changes are applied and validated. Potential problems with the
blueprint are logged as warnings.
Modifying an Existing Blueprint
Use For(Blueprint)
to modify existing blueprints:
CharacterClassConfigurator.For(WizardClassGuid)
Usage is otherwise identical to creating a new blueprint.
For more information see Using BlueprintCore.
Constructors
| Improve this Doc View SourceBaseDungeonExpeditionConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseDungeonExpeditionConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddToRewards(Blueprint<BlueprintDungeonIslandRewardReference>[])
Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_Rewards
Declaration
public TBuilder AddToRewards(params Blueprint<BlueprintDungeonIslandRewardReference>[] rewards)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonIslandRewardReference>[] | rewards | Tooltip: Possible rewards for completing islands in the expedition, random one from the list per island. Blueprint of type BlueprintDungeonIslandReward. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
ClearRewards()
Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_Rewards
Declaration
public TBuilder ClearRewards()
Returns
Type | Description |
---|---|
TBuilder |
CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonExpedition>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonExpedition>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition>> | blueprint | |
System.Predicate<Kingmaker.Blueprints.BlueprintComponent> | componentMatcher | Any components in |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
NOT A DEEP COPY. This means objects copied are shared between blueprints. Changes to copied objects affect both blueprints.
Recommended when you need to create a nearly identical ability but change some parts such as a
ContextRankConfig
.
// Copy the Undead Bloodline's Incorporeal Form ability, replacing the duration w/ Character Level rounds
AbilityConfigurator.New(NewIncorporealForm, Guids.NewIncorporealForm)
.CopyFrom(
AbilityRefs.BloodlineUndeadIncorporealFormAbility,
typeof(AbilityEffectRunAction),
typeof(AbilityResourceLogic),
typeof(SpellComponent))
.AddContextRankConfig(ContextRankConfigs.CharacterLevel())
.Configure();
CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonExpedition>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonExpedition>> blueprint, params Type[] componentTypes)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition>> | blueprint | |
System.Type[] | componentTypes | Any components in |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
NOT A DEEP COPY. This means objects copied are shared between blueprints. Changes to copied objects affect both blueprints.
Recommended when you need to create a nearly identical ability but change some parts such as a
ContextRankConfig
.
// Copy the Undead Bloodline's Incorporeal Form ability, replacing the duration w/ Character Level rounds
AbilityConfigurator.New(NewIncorporealForm, Guids.NewIncorporealForm)
.CopyFrom(
AbilityRefs.BloodlineUndeadIncorporealFormAbility,
typeof(AbilityEffectRunAction),
typeof(AbilityResourceLogic),
typeof(SpellComponent))
.AddContextRankConfig(ContextRankConfigs.CharacterLevel())
.Configure();
ModifyDescription(Action<LocalizedString>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.Description by invoking the provided action.
Declaration
public TBuilder ModifyDescription(Action<LocalizedString> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyFinalIsland(Action<BlueprintDungeonIslandReference>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_FinalIsland by invoking the provided action.
Declaration
public TBuilder ModifyFinalIsland(Action<BlueprintDungeonIslandReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonIslandReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyName(Action<LocalizedString>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.Name by invoking the provided action.
Declaration
public TBuilder ModifyName(Action<LocalizedString> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyRewards(Action<BlueprintDungeonIslandRewardReference>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_Rewards by invoking the provided action on each element.
Declaration
public TBuilder ModifyRewards(Action<BlueprintDungeonIslandRewardReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonIslandRewardReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromRewards(Blueprint<BlueprintDungeonIslandRewardReference>[])
Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_Rewards
Declaration
public TBuilder RemoveFromRewards(params Blueprint<BlueprintDungeonIslandRewardReference>[] rewards)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonIslandRewardReference>[] | rewards | Tooltip: Possible rewards for completing islands in the expedition, random one from the list per island. Blueprint of type BlueprintDungeonIslandReward. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
RemoveFromRewards(Func<BlueprintDungeonIslandRewardReference, Boolean>)
Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_Rewards that match the provided predicate.
Declaration
public TBuilder RemoveFromRewards(Func<BlueprintDungeonIslandRewardReference, bool> predicate)
Parameters
Type | Name | Description |
---|---|---|
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonIslandRewardReference, System.Boolean> | predicate |
Returns
Type | Description |
---|---|
TBuilder |
SetDescription(LocalString)
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.Description
Declaration
public TBuilder SetDescription(LocalString description)
Parameters
Type | Name | Description |
---|---|---|
LocalString | description | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
Type | Description |
---|---|
TBuilder |
SetFinalIsland(Blueprint<BlueprintDungeonIslandReference>)
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_FinalIsland
Declaration
public TBuilder SetFinalIsland(Blueprint<BlueprintDungeonIslandReference> finalIsland)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonIslandReference> | finalIsland | Tooltip: The last unique island with a boss fight. Blueprint of type BlueprintDungeonIsland. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetModificatorProbability(Single)
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_ModificatorProbability
Declaration
public TBuilder SetModificatorProbability(float modificatorProbability)
Parameters
Type | Name | Description |
---|---|---|
System.Single | modificatorProbability |
Returns
Type | Description |
---|---|
TBuilder |
SetName(LocalString)
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.Name
Declaration
public TBuilder SetName(LocalString name)
Parameters
Type | Name | Description |
---|---|---|
LocalString | name | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
Type | Description |
---|---|
TBuilder |
SetRewards(Blueprint<BlueprintDungeonIslandRewardReference>[])
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonExpedition.m_Rewards
Declaration
public TBuilder SetRewards(params Blueprint<BlueprintDungeonIslandRewardReference>[] rewards)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonIslandRewardReference>[] | rewards | Tooltip: Possible rewards for completing islands in the expedition, random one from the list per island. Blueprint of type BlueprintDungeonIslandReward. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |