Class BaseGlobalMapPointVariationConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.Globalmap
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseGlobalMapPointVariationConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintGlobalMapPointVariation where TBuilder : BaseGlobalMapPointVariationConfigurator<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 SourceBaseGlobalMapPointVariationConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseGlobalMapPointVariationConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddLocationRestriction(ConditionsBuilder, LocalString, ConditionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, List<Blueprint<BlueprintUnitReference>>)
Adds Kingmaker.Globalmap.Blueprints.LocationRestriction
Declaration
public TBuilder AddLocationRestriction(ConditionsBuilder allowedCondition = null, LocalString description = null, ConditionsBuilder ignoreCondition = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, List<Blueprint<BlueprintUnitReference>> requiredCompanions = null)
Parameters
Type | Name | Description |
---|---|---|
ConditionsBuilder | allowedCondition | |
LocalString | description | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
ConditionsBuilder | ignoreCondition | |
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.Collections.Generic.List<Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>> | requiredCompanions | Blueprint of type BlueprintUnit. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- Location_Daeran_Q2_HeavenDoorstepff7eb82a42780bd46817d9963bb40734
- Location_Lann_Q3_SavamelekhLair_Wenduag2af1ff61a77c88646b5745b44b02ecec
- Point_SeelahCamp7af4eb6fb78a56e40a18a038199fd555
CopyFrom(Blueprint<BlueprintReference<BlueprintGlobalMapPointVariation>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintGlobalMapPointVariation>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation>> | 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<BlueprintGlobalMapPointVariation>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintGlobalMapPointVariation>> blueprint, params Type[] componentTypes)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation>> | 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();
ModifyAreaEntrance(Action<BlueprintAreaEnterPointReference>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.m_AreaEntrance by invoking the provided action.
Declaration
public TBuilder ModifyAreaEntrance(Action<BlueprintAreaEnterPointReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintAreaEnterPointReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyBookEvent(Action<BlueprintDialogReference>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.m_BookEvent by invoking the provided action.
Declaration
public TBuilder ModifyBookEvent(Action<BlueprintDialogReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintDialogReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyConditions(Action<ConditionsChecker>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.Conditions by invoking the provided action.
Declaration
public TBuilder ModifyConditions(Action<ConditionsChecker> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.ElementsSystem.ConditionsChecker> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyDescription(Action<LocalizedString>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.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 |
ModifyEntrances(Action<BlueprintMultiEntranceReference>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.m_Entrances by invoking the provided action.
Declaration
public TBuilder ModifyEntrances(Action<BlueprintMultiEntranceReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintMultiEntranceReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyFakeDescription(Action<LocalizedString>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.FakeDescription by invoking the provided action.
Declaration
public TBuilder ModifyFakeDescription(Action<LocalizedString> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyFakeName(Action<LocalizedString>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.FakeName by invoking the provided action.
Declaration
public TBuilder ModifyFakeName(Action<LocalizedString> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyName(Action<LocalizedString>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.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 |
ModifyNameFromSettlement(Action<BlueprintSettlement.Reference>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.NameFromSettlement by invoking the provided action.
Declaration
public TBuilder ModifyNameFromSettlement(Action<BlueprintSettlement.Reference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Kingdom.BlueprintSettlement.Reference> | action |
Returns
Type | Description |
---|---|
TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
SetAreaEntrance(Blueprint<BlueprintAreaEnterPointReference>)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.m_AreaEntrance
Declaration
public TBuilder SetAreaEntrance(Blueprint<BlueprintAreaEnterPointReference> areaEntrance)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintAreaEnterPointReference> | areaEntrance | Blueprint of type BlueprintAreaEnterPoint. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetBookEvent(Blueprint<BlueprintDialogReference>)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.m_BookEvent
Declaration
public TBuilder SetBookEvent(Blueprint<BlueprintDialogReference> bookEvent)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintDialogReference> | bookEvent | Blueprint of type BlueprintDialog. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetConditions(ConditionsBuilder)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.Conditions
Declaration
public TBuilder SetConditions(ConditionsBuilder conditions)
Parameters
Type | Name | Description |
---|---|---|
ConditionsBuilder | conditions |
Returns
Type | Description |
---|---|
TBuilder |
SetDescription(LocalString)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.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 |
SetEntrances(Blueprint<BlueprintMultiEntranceReference>)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.m_Entrances
Declaration
public TBuilder SetEntrances(Blueprint<BlueprintMultiEntranceReference> entrances)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintMultiEntranceReference> | entrances | Blueprint of type BlueprintMultiEntrance. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetFakeDescription(LocalString)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.FakeDescription
Declaration
public TBuilder SetFakeDescription(LocalString fakeDescription)
Parameters
Type | Name | Description |
---|---|---|
LocalString | fakeDescription | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
Type | Description |
---|---|
TBuilder |
SetFakeName(LocalString)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.FakeName
Declaration
public TBuilder SetFakeName(LocalString fakeName)
Parameters
Type | Name | Description |
---|---|---|
LocalString | fakeName | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
Type | Description |
---|---|
TBuilder |
SetName(LocalString)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.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 |
SetNameFromSettlement(Blueprint<BlueprintSettlement.Reference>)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPointVariation.NameFromSettlement
Declaration
public TBuilder SetNameFromSettlement(Blueprint<BlueprintSettlement.Reference> nameFromSettlement)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Kingdom.BlueprintSettlement.Reference> | nameFromSettlement | Blueprint of type BlueprintSettlement. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |