Class BaseKingdomEventBaseConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseKingdomEventBaseConfigurator<T, TBuilder>
BaseCrusadeEventConfigurator<T, TBuilder>
BaseKingdomEventConfigurator<T, TBuilder>
BaseKingdomProjectConfigurator<T, TBuilder>
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.Kingdom
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseKingdomEventBaseConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintKingdomEventBase where TBuilder : BaseKingdomEventBaseConfigurator<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

BaseKingdomEventBaseConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddEventFinalResults(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, EventResult[])

Adds Kingmaker.Kingdom.Blueprints.EventFinalResults

Declaration
public TBuilder AddEventFinalResults(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, EventResult[] results = 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.
Kingmaker.Kingdom.Blueprints.EventResult[] results
Returns
Type Description
TBuilder
Remarks

  • AeonQ10_StartKTC9b7fdf9a6d722d942879c7922daa507f
  • KTC_EveryoneVSLocust8c158f6492b0ce04da8485e942f15825
  • WenduagKTC_WenduagComeNeathholmb0281d9068d670845927a1827be6e7bb
| Improve this Doc View Source

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

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

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintKingdomEventBase>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase>> 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<BlueprintKingdomEventBase>>, Type[])

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

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintKingdomEventBase>> blueprint, params Type[] componentTypes)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase>> 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

ModifyDefaultResolutionDescription(Action<LocalizedString>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.DefaultResolutionDescription by invoking the provided action.

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

ModifyLocalizedDescription(Action<LocalizedString>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.LocalizedDescription by invoking the provided action.

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

ModifyLocalizedName(Action<LocalizedString>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.LocalizedName by invoking the provided action.

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

ModifySolutions(Action<PossibleEventSolutions>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.Solutions by invoking the provided action.

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

ModifyTriggerCondition(Action<ConditionsChecker>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.TriggerCondition by invoking the provided action.

Declaration
public TBuilder ModifyTriggerCondition(Action<ConditionsChecker> action)
Parameters
Type Name Description
System.Action<Kingmaker.ElementsSystem.ConditionsChecker> 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

SetAICanCheat(Boolean)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.AICanCheat

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

SetAIStopping(Boolean)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.AIStopping

Declaration
public TBuilder SetAIStopping(bool aIStopping = true)
Parameters
Type Name Description
System.Boolean aIStopping

Tooltip: If true, this event would stop AI when it is resolved, or its recurrence ticks

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAutoResolveResult(EventResult.MarginType)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.AutoResolveResult

Declaration
public TBuilder SetAutoResolveResult(EventResult.MarginType autoResolveResult)
Parameters
Type Name Description
Kingmaker.Kingdom.Blueprints.EventResult.MarginType autoResolveResult
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDefaultResolutionDescription(LocalString)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.DefaultResolutionDescription

Declaration
public TBuilder SetDefaultResolutionDescription(LocalString defaultResolutionDescription)
Parameters
Type Name Description
LocalString defaultResolutionDescription

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

SetDefaultResolutionType(LeaderType)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.DefaultResolutionType

Declaration
public TBuilder SetDefaultResolutionType(LeaderType defaultResolutionType)
Parameters
Type Name Description
Kingmaker.Kingdom.LeaderType defaultResolutionType
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetInfoType(KingomEventInfoType)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.InfoType

Declaration
public TBuilder SetInfoType(KingomEventInfoType infoType)
Parameters
Type Name Description
Kingmaker.Kingdom.Blueprints.KingomEventInfoType infoType
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLocalizedDescription(LocalString)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.LocalizedDescription

Declaration
public TBuilder SetLocalizedDescription(LocalString localizedDescription)
Parameters
Type Name Description
LocalString localizedDescription

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

SetLocalizedName(LocalString)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.LocalizedName

Declaration
public TBuilder SetLocalizedName(LocalString localizedName)
Parameters
Type Name Description
LocalString localizedName

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

SetNeedToVisitTheThroneRoom(Boolean)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.NeedToVisitTheThroneRoom

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

SetResolutionDC(Int32)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.ResolutionDC

Declaration
public TBuilder SetResolutionDC(int resolutionDC)
Parameters
Type Name Description
System.Int32 resolutionDC
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetResolutionTime(Int32)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.ResolutionTime

Declaration
public TBuilder SetResolutionTime(int resolutionTime)
Parameters
Type Name Description
System.Int32 resolutionTime
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetResolveAutomatically(Boolean)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.ResolveAutomatically

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

SetSkipRoll(Boolean)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.SkipRoll

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

SetSolutions(PossibleEventSolutions)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.Solutions

Declaration
public TBuilder SetSolutions(PossibleEventSolutions solutions)
Parameters
Type Name Description
Kingmaker.Kingdom.Blueprints.PossibleEventSolutions solutions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTriggerCondition(ConditionsBuilder)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintKingdomEventBase.TriggerCondition

Declaration
public TBuilder SetTriggerCondition(ConditionsBuilder triggerCondition)
Parameters
Type Name Description
ConditionsBuilder triggerCondition
Returns
Type Description
TBuilder