Class BaseGlobalMapEdgeConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.Globalmap
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseGlobalMapEdgeConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintGlobalMapEdge where TBuilder : BaseGlobalMapEdgeConfigurator<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 SourceBaseGlobalMapEdgeConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseGlobalMapEdgeConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceCopyFrom(Blueprint<BlueprintReference<BlueprintGlobalMapEdge>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintGlobalMapEdge>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge>> | 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<BlueprintGlobalMapEdge>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintGlobalMapEdge>> blueprint, params Type[] componentTypes)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge>> | 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();
ModifyLockCondition(Action<ConditionsChecker>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.LockCondition by invoking the provided action.
Declaration
public TBuilder ModifyLockCondition(Action<ConditionsChecker> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.ElementsSystem.ConditionsChecker> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyPoint1(Action<BlueprintGlobalMapPoint.Reference>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.m_Point1 by invoking the provided action.
Declaration
public TBuilder ModifyPoint1(Action<BlueprintGlobalMapPoint.Reference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPoint.Reference> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyPoint2(Action<BlueprintGlobalMapPoint.Reference>)
Modifies Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.m_Point2 by invoking the provided action.
Declaration
public TBuilder ModifyPoint2(Action<BlueprintGlobalMapPoint.Reference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPoint.Reference> | action |
Returns
Type | Description |
---|---|
TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
SetLength(Single)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.Length
Declaration
public TBuilder SetLength(float length)
Parameters
Type | Name | Description |
---|---|---|
System.Single | length |
Returns
Type | Description |
---|---|
TBuilder |
SetLockCondition(ConditionsBuilder)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.LockCondition
Declaration
public TBuilder SetLockCondition(ConditionsBuilder lockCondition)
Parameters
Type | Name | Description |
---|---|---|
ConditionsBuilder | lockCondition |
Returns
Type | Description |
---|---|
TBuilder |
SetPoint1(Blueprint<BlueprintGlobalMapPoint.Reference>)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.m_Point1
Declaration
public TBuilder SetPoint1(Blueprint<BlueprintGlobalMapPoint.Reference> point1)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPoint.Reference> | point1 | Blueprint of type BlueprintGlobalMapPoint. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetPoint2(Blueprint<BlueprintGlobalMapPoint.Reference>)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.m_Point2
Declaration
public TBuilder SetPoint2(Blueprint<BlueprintGlobalMapPoint.Reference> point2)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPoint.Reference> | point2 | Blueprint of type BlueprintGlobalMapPoint. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetPriority(GlobalMapEdgePriority)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.Priority
Declaration
public TBuilder SetPriority(GlobalMapEdgePriority priority)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Globalmap.Blueprints.GlobalMapEdgePriority | priority |
Returns
Type | Description |
---|---|
TBuilder |
SetType(GlobalMapEdgeType)
Sets the value of Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapEdge.Type
Declaration
public TBuilder SetType(GlobalMapEdgeType type)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Globalmap.Blueprints.GlobalMapEdgeType | type |
Returns
Type | Description |
---|---|
TBuilder |