Class ConditionsBuilderKingdomEx

Extension to ConditionsBuilder for conditions involving the Kingdom and Crusade system.

Inheritance

System.Object

ConditionsBuilderKingdomEx

Namespace: BlueprintCore.Conditions.Builder.KingdomEx

Assembly: BlueprintCore.dll

Syntax

public static class ConditionsBuilderKingdomEx

Remarks

Conditions are supported using extension methods. Include the extension namespaces as needed.

When Build(Validator) is called the Kingmaker.ElementsSystem.ConditionsChecker is constructed, validated, and returned. If any errors are detected by Validator they will be logged as a warning.

Do not call Build(Validator) twice on the same builder.

If a method calls for a string to represent any type of blueprint, you can pass the blueprint's Kingmaker.Blueprints.SimpleBlueprint.AssetGuid as a string or as a name you already provided using AddGuidsByName().

AreaEx	Conditions involving the game map, dungeons, or locations. See also KingdomEx for location related conditions specifically tied to the Kingdom and Crusade system.
BasicEx	Most game mechanics related conditions not included in ContextEx.
ContextEx	Most Kingmaker.UnitLogic.Mechanics.Conditions.ContextCondition types. Some Kingmaker.UnitLogic.Mechanics.Conditions.ContextCondition types are in more specific extensions such as KingdomEx.
KingdomEx	Conditions involving the Kingdom and Crusade system.
MiscEx	Conditions without a better extension container such as game difficulty.
NewEx	Conditions defined in BlueprintCore and not available in the base game.
StoryEx	Conditions related to the story such as companion stories, quests, name changes, and etudes.

Make a melee attack if the target is in range:

// Provides the MeleeAttack extension for ActionsBuilder
using BlueprintCore.Actions.Builder.ContextEx; 
// Provides the TargetInMeleeRange extension for ConditionsBuilder
using BlueprintCore.Conditions.Builder.NewEx;
var actionList =
ActionsBuilder.New()
.Conditional(
ConditionsBuilder.New().TargetInMeleeRange(),
ifTrue: ActionsBuilder.New().MeleeAttack())
.build();

Methods

| Improve this Doc View Source

AnySettlementUnderSiege(ConditionsBuilder, Boolean)

Adds AnySettlementUnderSiege(ConditionsBuilder, Boolean)

Declaration

public static ConditionsBuilder AnySettlementUnderSiege(this ConditionsBuilder builder, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

PF-23623378ddb7dcceaf4dd5b6178807c258909c

| Improve this Doc View Source

ArmyInLocationDefeated(ConditionsBuilder, Blueprint<BlueprintGlobalMapPointReference>, Boolean)

Adds ArmyInLocationDefeated(ConditionsBuilder, Blueprint<BlueprintGlobalMapPointReference>, Boolean)

Declaration

public static ConditionsBuilder ArmyInLocationDefeated(this ConditionsBuilder builder, Blueprint<BlueprintGlobalMapPointReference> location = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Blueprint<Kingmaker.Blueprints.BlueprintGlobalMapPointReference>	location	Blueprint of type BlueprintGlobalMapPoint. 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.
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

PF-296978983af9815687400f897ef380ec8e6b09

| Improve this Doc View Source

AutoKingdom(ConditionsBuilder, Boolean)

Adds AutoKingdom(ConditionsBuilder, Boolean)

Declaration

public static ConditionsBuilder AutoKingdom(this ConditionsBuilder builder, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

Add3_SearchMoltenScar39a11378f06fff740b8211686247d943
Cue_0479_DaeEvilHeir72401afde04343f4c898efba4b4d1880
WarCamp_CrusadeAnnouncementd95152499fa0696478cc6af83e44f029

| Improve this Doc View Source

GarrisonClear(ConditionsBuilder, Blueprint<BlueprintGlobalMapPointReference>, Boolean)

Adds Kingmaker.UnitLogic.Mechanics.Conditions.ContextConditionGarrisonClear

Declaration

public static ConditionsBuilder GarrisonClear(this ConditionsBuilder builder, Blueprint<BlueprintGlobalMapPointReference> globalMapPoint = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Blueprint<Kingmaker.Blueprints.BlueprintGlobalMapPointReference>	globalMapPoint	Blueprint of type BlueprintGlobalMapPoint. 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.
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

CreateSettlementFort210b7377f7c46c6aa43bf66af6ec618836
CreateSettlementFort56ece5ff5b715642444b692d9d93b64b9c
CreateSettlementRiverGarrison947bf6259557aeb449557e4bc5228ead

| Improve this Doc View Source

HasTacticalMorale(ConditionsBuilder, Boolean)

Adds HasTacticalMorale(ConditionsBuilder, Boolean)

Declaration

public static ConditionsBuilder HasTacticalMorale(this ConditionsBuilder builder, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

Test_Bebilith Blueprint Camping Encounterf2f8355d4bc8aa34195eeb2f5cf66645

| Improve this Doc View Source

KingdomBuffIsActive(ConditionsBuilder, Blueprint<BlueprintKingdomBuffReference>, Boolean, Blueprint<BlueprintRegionReference>)

Adds KingdomBuffIsActive(ConditionsBuilder, Blueprint<BlueprintKingdomBuffReference>, Boolean, Blueprint<BlueprintRegionReference>)

Declaration

public static ConditionsBuilder KingdomBuffIsActive(this ConditionsBuilder builder, Blueprint<BlueprintKingdomBuffReference> blueprint = null, bool negate = false, Blueprint<BlueprintRegionReference> region = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Blueprint<Kingmaker.Blueprints.BlueprintKingdomBuffReference>	blueprint	Blueprint of type BlueprintKingdomBuff. 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.
System.Boolean	negate
Blueprint<Kingmaker.Blueprints.BlueprintRegionReference>	region	Blueprint of type BlueprintRegion. 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
ConditionsBuilder

Remarks

Aeon2FireElementals63364fac363349a99dd7fe96ca86dc7c
Event71DumpExcavationb0ca7e2b70c9447da43f7be86164d43c
Trickster5ThugPaladine83a6a99081d467fb56d8afe1de6a4d5

| Improve this Doc View Source

KingdomChapterWeek(ConditionsBuilder, Boolean, Nullable<Int32>)

Adds KingdomChapterWeek(ConditionsBuilder, Boolean, Nullable<Int32>)

Declaration

public static ConditionsBuilder KingdomChapterWeek(this ConditionsBuilder builder, bool negate = false, int? week = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
System.Nullable<System.Int32>	week	InfoBox: Week number from chapter start. To check chapter use etude checker.

Returns

Type	Description
ConditionsBuilder

Remarks

PF-218150d7696062df7c4b948e1ce3e1b769fc9a

| Improve this Doc View Source

KingdomEventIsBeingResolved(ConditionsBuilder, Blueprint<BlueprintKingdomEventBaseReference>, Boolean)

Adds KingdomEventIsBeingResolved(ConditionsBuilder, Blueprint<BlueprintKingdomEventBaseReference>, Boolean)

Declaration

public static ConditionsBuilder KingdomEventIsBeingResolved(this ConditionsBuilder builder, Blueprint<BlueprintKingdomEventBaseReference> eventValue = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Blueprint<Kingmaker.Blueprints.BlueprintKingdomEventBaseReference>	eventValue	Blueprint of type BlueprintKingdomEventBase. 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.
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

CrusadeEvent04e55f2d8389a14e6e999e23a7d1a6d736
CrusadeEvent464f210692d86841d4bcc6cbeb28bbeeca
PF-378483f5dad497239a41fd96a12d4d1b1b38ef

| Improve this Doc View Source

KingdomExists(ConditionsBuilder, Boolean)

Adds KingdomExists(ConditionsBuilder, Boolean)

Declaration

public static ConditionsBuilder KingdomExists(this ConditionsBuilder builder, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

Chapter0315e0048c7daf0ac4999c2313b58df0e3
CrusadeTutorial_01_Chapter2Intro20073002e0594c88b5af911060e8dde8
CrusadeTutorial_01_Chapter2Intro_Gamepada7ddb70f04c74468b7c05cb6b4275c65

| Improve this Doc View Source

KingdomLeaderIs(ConditionsBuilder, Nullable<Boolean>, Nullable<LeaderType>, Boolean, Blueprint<BlueprintUnitReference>)

Adds KingdomLeaderIs(ConditionsBuilder, Nullable<Boolean>, Nullable<LeaderType>, Boolean, Blueprint<BlueprintUnitReference>)

Declaration

public static ConditionsBuilder KingdomLeaderIs(this ConditionsBuilder builder, bool? allowCustomCompanions = null, LeaderType? leader = null, bool negate = false, Blueprint<BlueprintUnitReference> unit = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Boolean>	allowCustomCompanions
System.Nullable<Kingmaker.Kingdom.LeaderType>	leader
System.Boolean	negate
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>	unit	Blueprint of type BlueprintUnit. 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
ConditionsBuilder

Remarks

Answer_0260fb07588e668af2f4b93ea5628ab833bc
Cue_0263082fed3c287c9054593eebc2101e79b2
Cue_026463845fd8cb8868b4f95bdf5cdc3e73b8

| Improve this Doc View Source

KingdomMoraleFlagCondition(ConditionsBuilder, Blueprint<BlueprintKingdomMoraleFlag.Reference>, Boolean, Nullable<KingdomMoraleFlag.State>)

Adds KingdomMoraleFlagCondition(ConditionsBuilder, Blueprint<BlueprintKingdomMoraleFlag.Reference>, Boolean, Nullable<KingdomMoraleFlag.State>)

Declaration

public static ConditionsBuilder KingdomMoraleFlagCondition(this ConditionsBuilder builder, Blueprint<BlueprintKingdomMoraleFlag.Reference> flag = null, bool negate = false, KingdomMoraleFlag.State? state = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Blueprint<Kingmaker.Kingdom.Flags.BlueprintKingdomMoraleFlag.Reference>	flag	Blueprint of type BlueprintKingdomMoraleFlag. 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.
System.Boolean	negate
System.Nullable<Kingmaker.Kingdom.Flags.KingdomMoraleFlag.State>	state

Returns

Type	Description
ConditionsBuilder

Remarks

MoraleFlagSiegeChapter3Controller_buffbd5bfbd23acd4098b3a89100b61c3ce0
MoraleFlagSiegeChapter5Controller_buff30d599366a9e46fe992f9ca6fdf9365a

| Improve this Doc View Source

KingdomProjectIsAvailable(ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Boolean, Blueprint<BlueprintKingdomProjectReference>)

Adds KingdomProjectIsAvailable(ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Boolean, Blueprint<BlueprintKingdomProjectReference>)

Declaration

public static ConditionsBuilder KingdomProjectIsAvailable(this ConditionsBuilder builder, bool? checkLeader = null, bool? checkResources = null, bool? finishableThisMonth = null, bool negate = false, Blueprint<BlueprintKingdomProjectReference> project = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Boolean>	checkLeader
System.Nullable<System.Boolean>	checkResources
System.Nullable<System.Boolean>	finishableThisMonth
System.Boolean	negate
Blueprint<Kingmaker.Blueprints.BlueprintKingdomProjectReference>	project	Blueprint of type BlueprintKingdomProject. 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
ConditionsBuilder

Remarks

Add4_GotoMoltenScarf6694c696284e2046b0f064f83c320c2
Event61MountTraining775f8746730f47b08008672653b9f52b
Trickster5ThugPaladine83a6a99081d467fb56d8afe1de6a4d5

| Improve this Doc View Source

KingdomProjectIsDone(ConditionsBuilder, Boolean, Blueprint<BlueprintKingdomProjectReference>)

Adds KingdomProjectIsDone(ConditionsBuilder, Boolean, Blueprint<BlueprintKingdomProjectReference>)

Declaration

public static ConditionsBuilder KingdomProjectIsDone(this ConditionsBuilder builder, bool negate = false, Blueprint<BlueprintKingdomProjectReference> project = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
Blueprint<Kingmaker.Blueprints.BlueprintKingdomProjectReference>	project	Blueprint of type BlueprintKingdomProject. 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
ConditionsBuilder

Remarks

CreateSettlementFort210b7377f7c46c6aa43bf66af6ec618836
Cue_00587e1a31d409836274b93e59796d60c19e
PF-4127038cddb1adab904075a656a7d4bf226271

| Improve this Doc View Source

KingdomRankUpConditions(ConditionsBuilder, Boolean, Nullable<Int32>, Nullable<KingdomStats.Type>)

Adds KingdomRankUpConditions(ConditionsBuilder, Boolean, Nullable<Int32>, Nullable<KingdomStats.Type>)

Declaration

public static ConditionsBuilder KingdomRankUpConditions(this ConditionsBuilder builder, bool negate = false, int? nextRank = null, KingdomStats.Type? stat = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
System.Nullable<System.Int32>	nextRank
System.Nullable<Kingmaker.Kingdom.KingdomStats.Type>	stat

Returns

Type	Description
ConditionsBuilder

Remarks

Chapter055b01aa690202e584888dfc600a4aac0a
LogisticsRankUp2Projecte2c032467f1cf0b4d9ee4da1da92857a
MilitaryRankUp8Project11904fe03bcc431d8f8fb0a2d4ca3704

| Improve this Doc View Source

KingdomRegionIsConquered(ConditionsBuilder, Boolean, Blueprint<BlueprintRegionReference>)

Adds KingdomRegionIsConquered(ConditionsBuilder, Boolean, Blueprint<BlueprintRegionReference>)

Declaration

public static ConditionsBuilder KingdomRegionIsConquered(this ConditionsBuilder builder, bool negate = false, Blueprint<BlueprintRegionReference> region = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
Blueprint<Kingmaker.Blueprints.BlueprintRegionReference>	region	Blueprint of type BlueprintRegion. 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
ConditionsBuilder

Remarks

FlagDiplomacy7CrusadeResourcesForRegions8663e81969a647fe9d6e8c3afd7d9172
KingdomMoraleFlagChapter5Regionsb01624ee06444738964b678259f31a20
Obj2_131325a3a01ba44a69d3c205784cc1816

| Improve this Doc View Source

KingdomSettlementCount(ConditionsBuilder, Nullable<Int32>, Nullable<SettlementState.LevelType>, Boolean)

Adds KingdomSettlementCount(ConditionsBuilder, Nullable<Int32>, Nullable<SettlementState.LevelType>, Boolean)

Declaration

public static ConditionsBuilder KingdomSettlementCount(this ConditionsBuilder builder, int? count = null, SettlementState.LevelType? minLevel = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Int32>	count
System.Nullable<Kingmaker.Kingdom.Settlements.SettlementState.LevelType>	minLevel
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

SettlementsTracker_buff71dd611cd70443fcb04f0dce3bda76ef

| Improve this Doc View Source

KingdomStatCheck(ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Boolean, Nullable<KingdomStats.Type>, Nullable<Int32>)

Adds KingdomStatCheck(ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Boolean, Nullable<KingdomStats.Type>, Nullable<Int32>)

Declaration

public static ConditionsBuilder KingdomStatCheck(this ConditionsBuilder builder, bool? atMost = null, bool? checkRank = null, bool negate = false, KingdomStats.Type? statType = null, int? value = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Boolean>	atMost
System.Nullable<System.Boolean>	checkRank
System.Boolean	negate
System.Nullable<Kingmaker.Kingdom.KingdomStats.Type>	statType
System.Nullable<System.Int32>	value

Returns

Type	Description
ConditionsBuilder

Remarks

26!_SadisticGD_Checker_Sum561508e5aeba4d37b7418a363411964d
LogisticsRankUp3Projectde0bfee4dca3ebc4aae466ca6e799e01
PF-252649403f8687be754fe39430819391be0c73

| Improve this Doc View Source

TacticalCombatSquadHitPointsCondition(ConditionsBuilder, Nullable<Boolean>, Boolean, Nullable<CompareOperation.Type>, ContextValue)

Adds TacticalCombatSquadHitPointsCondition(ConditionsBuilder, Nullable<Boolean>, Boolean, Nullable<CompareOperation.Type>, ContextValue)

Declaration

public static ConditionsBuilder TacticalCombatSquadHitPointsCondition(this ConditionsBuilder builder, bool? checkInitiatorHP = null, bool negate = false, CompareOperation.Type? operation = null, ContextValue referenceValue = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Boolean>	checkInitiatorHP	InfoBox: Compares with target's HP by default
System.Boolean	negate
System.Nullable<Kingmaker.UnitLogic.Mechanics.CompareOperation.Type>	operation
Kingmaker.UnitLogic.Mechanics.ContextValue	referenceValue

Returns

Type	Description
ConditionsBuilder

Remarks

ArmyFingerOfDeath16da1e53252444cc9f14bcf1c72f58fb
ArmyMeleeCounterAttackFeature9f86b8f30438920458feda7313591ec2
ArmyRangedCounterAttackFeature4d59f676f59579944948f8c461731ab8

| Improve this Doc View Source

TargetHasArmyTag(ConditionsBuilder, Nullable<Boolean>, Boolean, Nullable<ArmyProperties>)

Adds TargetHasArmyTag(ConditionsBuilder, Nullable<Boolean>, Boolean, Nullable<ArmyProperties>)

Declaration

public static ConditionsBuilder TargetHasArmyTag(this ConditionsBuilder builder, bool? needAllTags = null, bool negate = false, ArmyProperties? tags = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Boolean>	needAllTags
System.Boolean	negate
System.Nullable<Kingmaker.Armies.Components.ArmyProperties>	tags

Returns

Type	Description
ConditionsBuilder

Remarks

Aeon5BaneOfDemonsAbility843145bc1b9b45229c40b1a2128095f0
RangerBlindingTrapAreab4b532d5cd6f81642a6783a93ace06d1
RitualHealAbility08c5571e87eccfc47a8325f530e3693c