Class BaseDungeonLocalizedStringsConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.Dungeon
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseDungeonLocalizedStringsConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintDungeonLocalizedStrings where TBuilder : BaseDungeonLocalizedStringsConfigurator<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 SourceBaseDungeonLocalizedStringsConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseDungeonLocalizedStringsConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddToLeaderboardCharacterValues(BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[])
Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValues
Declaration
public TBuilder AddToLeaderboardCharacterValues(params BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[] leaderboardCharacterValues)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[] | leaderboardCharacterValues |
Returns
| Type | Description |
|---|---|
| TBuilder |
AddToLeaderboardRecordValues(BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[])
Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValues
Declaration
public TBuilder AddToLeaderboardRecordValues(params BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[] leaderboardRecordValues)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[] | leaderboardRecordValues |
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearLeaderboardCharacterValues()
Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValues
Declaration
public TBuilder ClearLeaderboardCharacterValues()
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearLeaderboardRecordValues()
Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValues
Declaration
public TBuilder ClearLeaderboardRecordValues()
Returns
| Type | Description |
|---|---|
| TBuilder |
CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonLocalizedStrings>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonLocalizedStrings>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings>> | 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<BlueprintDungeonLocalizedStrings>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonLocalizedStrings>> blueprint, params Type[] componentTypes)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings>> | 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();
ModifyExperienceGained(Action<LocalizedString>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.ExperienceGained by invoking the provided action.
Declaration
public TBuilder ModifyExperienceGained(Action<LocalizedString> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyLeaderboardCharacterValues(Action<BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValues by invoking the provided action on each element.
Declaration
public TBuilder ModifyLeaderboardCharacterValues(Action<BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyLeaderboardRecordValues(Action<BlueprintDungeonLocalizedStrings.LeaderboardRecordValue>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValues by invoking the provided action on each element.
Declaration
public TBuilder ModifyLeaderboardRecordValues(Action<BlueprintDungeonLocalizedStrings.LeaderboardRecordValue> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValue> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyStageNameParameterized(Action<LocalizedString>)
Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.StageNameParameterized by invoking the provided action.
Declaration
public TBuilder ModifyStageNameParameterized(Action<LocalizedString> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromLeaderboardCharacterValues(BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[])
Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValues
Declaration
public TBuilder RemoveFromLeaderboardCharacterValues(params BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[] leaderboardCharacterValues)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[] | leaderboardCharacterValues |
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromLeaderboardCharacterValues(Func<BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue, Boolean>)
Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValues that match the provided predicate.
Declaration
public TBuilder RemoveFromLeaderboardCharacterValues(Func<BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue, bool> predicate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue, System.Boolean> | predicate |
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromLeaderboardRecordValues(BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[])
Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValues
Declaration
public TBuilder RemoveFromLeaderboardRecordValues(params BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[] leaderboardRecordValues)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[] | leaderboardRecordValues |
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromLeaderboardRecordValues(Func<BlueprintDungeonLocalizedStrings.LeaderboardRecordValue, Boolean>)
Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValues that match the provided predicate.
Declaration
public TBuilder RemoveFromLeaderboardRecordValues(Func<BlueprintDungeonLocalizedStrings.LeaderboardRecordValue, bool> predicate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValue, System.Boolean> | predicate |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetExperienceGained(LocalString)
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.ExperienceGained
Declaration
public TBuilder SetExperienceGained(LocalString experienceGained)
Parameters
| Type | Name | Description |
|---|---|---|
| LocalString | experienceGained | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetLeaderboardCharacterValues(BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[])
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValues
Declaration
public TBuilder SetLeaderboardCharacterValues(params BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[] leaderboardCharacterValues)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardCharacterValue[] | leaderboardCharacterValues |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetLeaderboardRecordValues(BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[])
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValues
Declaration
public TBuilder SetLeaderboardRecordValues(params BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[] leaderboardRecordValues)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.LeaderboardRecordValue[] | leaderboardRecordValues |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetStageNameParameterized(LocalString)
Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonLocalizedStrings.StageNameParameterized
Declaration
public TBuilder SetStageNameParameterized(LocalString stageNameParameterized)
Parameters
| Type | Name | Description |
|---|---|---|
| LocalString | stageNameParameterized | Tooltip: {text} will be with stage number You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
| Type | Description |
|---|---|
| TBuilder |