Class BaseAreaEnterPointConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseAreaEnterPointConfigurator<T, TBuilder>
AreaEnterPointConfigurator
Inherited Members
BaseBlueprintConfigurator<T, TBuilder>.AdditionalDiceOnAttack(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<AdditionalDiceOnAttack.WeaponOptions>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, List<AdditionalDiceOnAttack.DamageEntry>, DamageTypeDescription, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>, ContextDiceValue, Blueprint<BlueprintWeaponTypeReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddRuleCalculateDamageWithWeaponTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<PhysicalDamageForm>, Nullable<Boolean>, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, Nullable<Boolean>, Blueprint<BlueprintItemWeaponReference>, Blueprint<BlueprintWeaponTypeReference>)
Namespace: BlueprintCore.Blueprints.Configurators.Area
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseAreaEnterPointConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintAreaEnterPoint where TBuilder : BaseAreaEnterPointConfigurator<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 Source

BaseAreaEnterPointConfigurator(Blueprint<BlueprintReference<T>>)

Declaration
protected BaseAreaEnterPointConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> blueprint

Methods

| Improve this Doc View Source

AddAllowOnZoneSettings(GlobalMapZone[], Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.RandomEncounters.Settings.AllowOnZoneSettings

Declaration
public TBuilder AddAllowOnZoneSettings(GlobalMapZone[] allowedNaturalSettings = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
Kingmaker.Enums.GlobalMapZone[] allowedNaturalSettings
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

  • Trader_Desertfbe119150585526469ae85a3aff8094d
  • Trader_Karelia70e1898c5d62e2b47bba99330f447660
  • Trader_Winterac97038913a452d4789e11f4c3eedc66
| Improve this Doc View Source

AddToTooltipList(LocalString[])

Adds to the contents of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_TooltipList

Declaration
public TBuilder AddToTooltipList(params LocalString[] tooltipList)
Parameters
Type Name Description
LocalString[] tooltipList

You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearTooltipList()

Removes all elements from Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_TooltipList

Declaration
public TBuilder ClearTooltipList()
Returns
Type Description
TBuilder
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<BlueprintAreaEnterPoint>>, Predicate<BlueprintComponent>)

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintAreaEnterPoint>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint>> blueprint
System.Predicate<Kingmaker.Blueprints.BlueprintComponent> componentMatcher

Any components in blueprint matching the predicate are copied. These are shallow copies that are shared by both blueprints.
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();
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<BlueprintAreaEnterPoint>>, Type[])

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintAreaEnterPoint>> blueprint, params Type[] componentTypes)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint>> blueprint
System.Type[] componentTypes

Any components in blueprint of the listed types are copied. These are shallow copies that are shared by both blueprints.
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();
| Improve this Doc View Source

ModifyArea(Action<BlueprintAreaReference>)

Modifies Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_Area by invoking the provided action.

Declaration
public TBuilder ModifyArea(Action<BlueprintAreaReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.BlueprintAreaReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyAreaPart(Action<BlueprintAreaPartReference>)

Modifies Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_AreaPart by invoking the provided action.

Declaration
public TBuilder ModifyAreaPart(Action<BlueprintAreaPartReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.BlueprintAreaPartReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyHoverIcon(Action<Sprite>)

Modifies Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.HoverIcon by invoking the provided action.

Declaration
public TBuilder ModifyHoverIcon(Action<Sprite> action)
Parameters
Type Name Description
System.Action<UnityEngine.Sprite> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyIcon(Action<Sprite>)

Modifies Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.Icon by invoking the provided action.

Declaration
public TBuilder ModifyIcon(Action<Sprite> action)
Parameters
Type Name Description
System.Action<UnityEngine.Sprite> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyTooltip(Action<LocalizedString>)

Modifies Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_Tooltip by invoking the provided action.

Declaration
public TBuilder ModifyTooltip(Action<LocalizedString> action)
Parameters
Type Name Description
System.Action<Kingmaker.Localization.LocalizedString> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyTooltipList(Action<LocalizedString>)

Modifies Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_TooltipList by invoking the provided action on each element.

Declaration
public TBuilder ModifyTooltipList(Action<LocalizedString> action)
Parameters
Type Name Description
System.Action<Kingmaker.Localization.LocalizedString> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

OnConfigureCompleted()

Declaration
protected override void OnConfigureCompleted()
Overrides
BlueprintCore.Blueprints.CustomConfigurators.RootConfigurator<T, TBuilder>.OnConfigureCompleted()
| Improve this Doc View Source

RemoveFromTooltipList(LocalString[])

Removes elements from Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_TooltipList

Declaration
public TBuilder RemoveFromTooltipList(params LocalString[] tooltipList)
Parameters
Type Name Description
LocalString[] tooltipList

You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromTooltipList(Func<LocalizedString, Boolean>)

Removes elements from Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_TooltipList that match the provided predicate.

Declaration
public TBuilder RemoveFromTooltipList(Func<LocalizedString, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Localization.LocalizedString, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetArea(Blueprint<BlueprintAreaReference>)

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_Area

Declaration
public TBuilder SetArea(Blueprint<BlueprintAreaReference> area)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAreaReference> area

Blueprint of type BlueprintArea. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAreaPart(Blueprint<BlueprintAreaPartReference>)

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_AreaPart

Declaration
public TBuilder SetAreaPart(Blueprint<BlueprintAreaPartReference> areaPart)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAreaPartReference> areaPart

Blueprint of type BlueprintAreaPart. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetCanBeOutsideNavmesh(Boolean)

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_CanBeOutsideNavmesh

Declaration
public TBuilder SetCanBeOutsideNavmesh(bool canBeOutsideNavmesh = true)
Parameters
Type Name Description
System.Boolean canBeOutsideNavmesh

Tooltip: If true, party can teleport to this point even if it&apos;s not on the navmesh. See PF-329173

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetHoverIcon(Asset<Sprite>)

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.HoverIcon

Declaration
public TBuilder SetHoverIcon(Asset<Sprite> hoverIcon)
Parameters
Type Name Description
Asset<UnityEngine.Sprite> hoverIcon

You can pass in the animation using a Sprite or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIcon(Asset<Sprite>)

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.Icon

Declaration
public TBuilder SetIcon(Asset<Sprite> icon)
Parameters
Type Name Description
Asset<UnityEngine.Sprite> icon

You can pass in the animation using a Sprite or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIsClearGFXMemory(Boolean)

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.IsClearGFXMemory

Declaration
public TBuilder SetIsClearGFXMemory(bool isClearGFXMemory = true)
Parameters
Type Name Description
System.Boolean isClearGFXMemory
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTooltip(LocalString)

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_Tooltip

Declaration
public TBuilder SetTooltip(LocalString tooltip)
Parameters
Type Name Description
LocalString tooltip

You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTooltipList(LocalString[])

Sets the value of Kingmaker.Blueprints.Area.BlueprintAreaEnterPoint.m_TooltipList

Declaration
public TBuilder SetTooltipList(params LocalString[] tooltipList)
Parameters
Type Name Description
LocalString[] tooltipList

You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Returns
Type Description
TBuilder