Class BaseDlcConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.DLC.BlueprintDlc.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.DLC
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseDlcConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintDlc where TBuilder : BaseDlcConfigurator<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 SourceBaseDlcConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseDlcConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddDlcStoreCheat(Nullable<Boolean>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
Adds Kingmaker.DLC.DlcStoreCheat
Declaration
public TBuilder AddDlcStoreCheat(bool? isAvailableInDevBuild = null, bool? isAvailableInEditor = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Boolean> | isAvailableInDevBuild | Tooltip: Is the DLC available in development build |
System.Nullable<System.Boolean> | isAvailableInEditor | Tooltip: Is the DLC available in editor playmode |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- DlcKickstarterPremium1cf79baad3874b3aaf700b6187c7f0e1
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddDlcStoreConsoleFree(Nullable<DlcStoreConsoleFree.PlatformsType>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
Adds Kingmaker.DLC.DlcStoreConsoleFree
Declaration
public TBuilder AddDlcStoreConsoleFree(DlcStoreConsoleFree.PlatformsType? availableOn = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<Kingmaker.DLC.DlcStoreConsoleFree.PlatformsType> | availableOn | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- FreeDlc1d185af74fc5b4c198600e0202ca11de8
- FreeDlc3aa65dbd3c0bb44b49343b020c9a4c8a3
- FreeDlc4a9262dad08654d3dbad64476978c0f95
AddDlcStoreEpic(String, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
Adds Kingmaker.DLC.DlcStoreEpic
Declaration
public TBuilder AddDlcStoreEpic(string epicId = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type | Name | Description |
---|---|---|
System.String | epicId | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- DlcKickstarterPremium1cf79baad3874b3aaf700b6187c7f0e1
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddDlcStoreGog(Nullable<UInt64>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
Adds Kingmaker.DLC.DlcStoreGog
Declaration
public TBuilder AddDlcStoreGog(ulong? gogId = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.UInt64> | gogId | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- DlcKickstarterPremium1cf79baad3874b3aaf700b6187c7f0e1
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddDlcStoreNintendo(Nullable<Boolean>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, String, Nullable<UInt32>)
Adds Kingmaker.DLC.DlcStoreNintendo
Declaration
public TBuilder AddDlcStoreNintendo(bool? canMountSwitch = null, bool? isFree = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, string nintendoId = null, uint? nintendoIndex = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Boolean> | canMountSwitch | |
System.Nullable<System.Boolean> | isFree | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
System.String | nintendoId | |
System.Nullable<System.UInt32> | nintendoIndex |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- Dlc6c2340df3fdaf403baffe824ae7a0a547
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddDlcStorePS4(String, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Int32>)
Adds Kingmaker.DLC.DlcStorePS4
Declaration
public TBuilder AddDlcStorePS4(string entitlementLabel = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, int? serviceLabel = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | entitlementLabel | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
System.Nullable<System.Int32> | serviceLabel |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- Dlc435b89606cfe9405085a35b02cf15017f
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddDlcStorePS5(List<DlcStorePS5.ConditionalItem>, String, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Int32>)
Adds Kingmaker.DLC.DlcStorePS5
Declaration
public TBuilder AddDlcStorePS5(List<DlcStorePS5.ConditionalItem> conditionalEntitlementLabels = null, string defaultEntitlementLabel = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, int? serviceLabel = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<Kingmaker.DLC.DlcStorePS5.ConditionalItem> | conditionalEntitlementLabels | |
System.String | defaultEntitlementLabel | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
System.Nullable<System.Int32> | serviceLabel |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- Dlc435b89606cfe9405085a35b02cf15017f
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddDlcStoreSteam(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<UInt32>)
Adds Kingmaker.DLC.DlcStoreSteam
Declaration
public TBuilder AddDlcStoreSteam(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, uint? steamId = null)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
System.Nullable<System.UInt32> | steamId |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- DlcKickstarterPremium1cf79baad3874b3aaf700b6187c7f0e1
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddDlcStoreXbox(String, String, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, String)
Adds Kingmaker.DLC.DlcStoreXbox
Declaration
public TBuilder AddDlcStoreXbox(string displayName = null, string identityName = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, string productId = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | displayName | |
System.String | identityName | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
System.String | productId |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Dlc18576a633c8fe4ce78530b55c1f0d14e5
- Dlc435b89606cfe9405085a35b02cf15017f
- FreeDlc55510e434b3974f90b99dae681d7c6e9a
AddToRewardReferences(Blueprint<BlueprintDlcRewardReference>[])
Adds to the contents of Kingmaker.DLC.BlueprintDlc.RewardReferences
Declaration
public TBuilder AddToRewardReferences(params Blueprint<BlueprintDlcRewardReference>[] rewardReferences)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintDlcRewardReference>[] | rewardReferences | Blueprint of type BlueprintDlcReward. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
ClearRewardReferences()
Removes all elements from Kingmaker.DLC.BlueprintDlc.RewardReferences
Declaration
public TBuilder ClearRewardReferences()
Returns
Type | Description |
---|---|
TBuilder |
CopyFrom(Blueprint<BlueprintReference<BlueprintDlc>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDlc>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.DLC.BlueprintDlc>> | 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<BlueprintDlc>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDlc>> blueprint, params Type[] componentTypes)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.DLC.BlueprintDlc>> | 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();
ModifyDefaultDescription(Action<LocalizedString>)
Modifies Kingmaker.DLC.BlueprintDlc.DefaultDescription by invoking the provided action.
Declaration
public TBuilder ModifyDefaultDescription(Action<LocalizedString> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyDefaultKeyArtLink(Action<SpriteLink>)
Modifies Kingmaker.DLC.BlueprintDlc.DefaultKeyArtLink by invoking the provided action.
Declaration
public TBuilder ModifyDefaultKeyArtLink(Action<SpriteLink> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.ResourceLinks.SpriteLink> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyDefaultTitle(Action<LocalizedString>)
Modifies Kingmaker.DLC.BlueprintDlc.DefaultTitle by invoking the provided action.
Declaration
public TBuilder ModifyDefaultTitle(Action<LocalizedString> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyDescription(Action<LocalizedString>)
Modifies Kingmaker.DLC.BlueprintDlc.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 |
ModifyRewardReferences(Action<BlueprintDlcRewardReference>)
Modifies Kingmaker.DLC.BlueprintDlc.RewardReferences by invoking the provided action on each element.
Declaration
public TBuilder ModifyRewardReferences(Action<BlueprintDlcRewardReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintDlcRewardReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromRewardReferences(Blueprint<BlueprintDlcRewardReference>[])
Removes elements from Kingmaker.DLC.BlueprintDlc.RewardReferences
Declaration
public TBuilder RemoveFromRewardReferences(params Blueprint<BlueprintDlcRewardReference>[] rewardReferences)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintDlcRewardReference>[] | rewardReferences | Blueprint of type BlueprintDlcReward. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
RemoveFromRewardReferences(Func<BlueprintDlcRewardReference, Boolean>)
Removes elements from Kingmaker.DLC.BlueprintDlc.RewardReferences that match the provided predicate.
Declaration
public TBuilder RemoveFromRewardReferences(Func<BlueprintDlcRewardReference, bool> predicate)
Parameters
Type | Name | Description |
---|---|---|
System.Func<Kingmaker.Blueprints.BlueprintDlcRewardReference, System.Boolean> | predicate |
Returns
Type | Description |
---|---|
TBuilder |
SetDefaultDescription(LocalString)
Sets the value of Kingmaker.DLC.BlueprintDlc.DefaultDescription
Declaration
public TBuilder SetDefaultDescription(LocalString defaultDescription)
Parameters
Type | Name | Description |
---|---|---|
LocalString | defaultDescription | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
Type | Description |
---|---|
TBuilder |
SetDefaultKeyArtLink(AssetLink<SpriteLink>)
Sets the value of Kingmaker.DLC.BlueprintDlc.DefaultKeyArtLink
Declaration
public TBuilder SetDefaultKeyArtLink(AssetLink<SpriteLink> defaultKeyArtLink)
Parameters
Type | Name | Description |
---|---|---|
AssetLink<Kingmaker.ResourceLinks.SpriteLink> | defaultKeyArtLink | You can pass in the animation using a SpriteLink or it's AssetId. |
Returns
Type | Description |
---|---|
TBuilder |
SetDefaultTitle(LocalString)
Sets the value of Kingmaker.DLC.BlueprintDlc.DefaultTitle
Declaration
public TBuilder SetDefaultTitle(LocalString defaultTitle)
Parameters
Type | Name | Description |
---|---|---|
LocalString | defaultTitle | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
Type | Description |
---|---|
TBuilder |
SetDescription(LocalString)
Sets the value of Kingmaker.DLC.BlueprintDlc.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 |
SetRewardReferences(Blueprint<BlueprintDlcRewardReference>[])
Sets the value of Kingmaker.DLC.BlueprintDlc.RewardReferences
Declaration
public TBuilder SetRewardReferences(params Blueprint<BlueprintDlcRewardReference>[] rewardReferences)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintDlcRewardReference>[] | rewardReferences | Blueprint of type BlueprintDlcReward. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |