Class ConditionsBuilderAreaEx

Extension to ConditionsBuilder for conditions involving the game map, dungeons, or locations. See also KingdomEx.

Inheritance

System.Object

ConditionsBuilderAreaEx

Namespace: BlueprintCore.Conditions.Builder.AreaEx

Assembly: BlueprintCore.dll

Syntax

public static class ConditionsBuilderAreaEx

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

AreaVisited(ConditionsBuilder, Blueprint<BlueprintAreaReference>, Boolean)

Adds AreaVisited(ConditionsBuilder, Blueprint<BlueprintAreaReference>, Boolean)

Declaration

public static ConditionsBuilder AreaVisited(this ConditionsBuilder builder, Blueprint<BlueprintAreaReference> area = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
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.
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

Answer_00074df71c9b1ab9d174eaf66587e483dc61
PF-424113fe7866961dd849eabea8c01ae5c0e9a9
YellowPuzzleMechanic7e0ebe7249b75724a836537405e988bb

| Improve this Doc View Source

CurrentAreaIs(ConditionsBuilder, Blueprint<BlueprintAreaReference>, Boolean)

Adds CurrentAreaIs(ConditionsBuilder, Blueprint<BlueprintAreaReference>, Boolean)

Declaration

public static ConditionsBuilder CurrentAreaIs(this ConditionsBuilder builder, Blueprint<BlueprintAreaReference> area = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
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.
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

AeonEyeEnemyVisualBuff9815f77129674e8e886de2d458ecdf49
Cue_640e8be804be2a4a97b102a3f36d21f240
WoljifQd79f05dbd35b468fa16312f30d61a5e1

| Improve this Doc View Source

DungeonIsBoon(ConditionsBuilder, Blueprint<BlueprintDungeonBoonReference>, Boolean)

Adds DungeonIsBoon(ConditionsBuilder, Blueprint<BlueprintDungeonBoonReference>, Boolean)

Declaration

public static ConditionsBuilder DungeonIsBoon(this ConditionsBuilder builder, Blueprint<BlueprintDungeonBoonReference> boon = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoonReference>	boon	Blueprint of type BlueprintDungeonBoon. 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

CheckBoonFlags87a65a30a6f5424b86fed226dbc2d101

| Improve this Doc View Source

DungeonIsTier(ConditionsBuilder, Boolean, Blueprint<BlueprintDungeonTierReference>)

Adds DungeonIsTier(ConditionsBuilder, Boolean, Blueprint<BlueprintDungeonTierReference>)

Declaration

public static ConditionsBuilder DungeonIsTier(this ConditionsBuilder builder, bool negate = false, Blueprint<BlueprintDungeonTierReference> tier = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonTierReference>	tier	Blueprint of type BlueprintDungeonTier. 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

Blessing_Interactionff4a347df77e4cad971249c25d9a1589
DLC3_WildMagic_Spells_Tier39966b4a4042745aca41d79420dc0d271
RewardTrader_Tier3b92e487220524c0f945a36436994d2f8

| Improve this Doc View Source

DungeonIsTierReached(ConditionsBuilder, Boolean, Blueprint<BlueprintDungeonTierReference>)

Adds DungeonIsTierReached(ConditionsBuilder, Boolean, Blueprint<BlueprintDungeonTierReference>)

Declaration

public static ConditionsBuilder DungeonIsTierReached(this ConditionsBuilder builder, bool negate = false, Blueprint<BlueprintDungeonTierReference> tier = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonTierReference>	tier	Blueprint of type BlueprintDungeonTier. 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

RewardLoot_BesmaraBossbc8bf25e3038475e9a2cc9cfddfc1ee6
RewardLoot_ConsumablePotion_Tier1_closef96a1f37fcd6427d81c85cf0cd7ba92b
RewardObject_LegacyExp_close36158ab6a3f54e75bdbb462453871efa

| Improve this Doc View Source

DungeonStage(ConditionsBuilder, Nullable<Int32>, Nullable<Int32>, Boolean)

Adds Kingmaker.UnitLogic.Mechanics.Conditions.ContextConditionDungeonStage

Declaration

public static ConditionsBuilder DungeonStage(this ConditionsBuilder builder, int? maxLevel = null, int? minLevel = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Int32>	maxLevel
System.Nullable<System.Int32>	minLevel
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

DLC3_BoonsTutorial656933737f3d4ee4b8be54a54df48d3f

| Improve this Doc View Source

InCapital(ConditionsBuilder, Boolean)

Adds InCapital(ConditionsBuilder, Boolean)

Declaration

public static ConditionsBuilder InCapital(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
TriceratopsStatuetteCorrectBuff4366d9550c8345da8bedece00a19b7a8

| Improve this Doc View Source

IsLootEmpty(ConditionsBuilder, Nullable<Boolean>, EntityReference, MapObjectEvaluator, Boolean)

Adds IsLootEmpty(ConditionsBuilder, Nullable<Boolean>, EntityReference, MapObjectEvaluator, Boolean)

Declaration

public static ConditionsBuilder IsLootEmpty(this ConditionsBuilder builder, bool? evaluateMapObject = null, EntityReference lootObject = null, MapObjectEvaluator mapObject = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<System.Boolean>	evaluateMapObject
Kingmaker.Blueprints.EntityReference	lootObject
Kingmaker.ElementsSystem.MapObjectEvaluator	mapObject
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

CavesShortcutUnlockedd1f433e953409144d914f15597db6e34
Green_Slot_1_2_IsNotEmptyd44ba5b7fee49e64684ce203920e5c08
Slot_3_3_IsNotEmpty85c097fd43ebd3940b6ea98b57e6f35e

| Improve this Doc View Source

IsPartyInNaturalSetting(ConditionsBuilder, Boolean, Nullable<GlobalMapZone>)

Adds IsPartyInNaturalSetting(ConditionsBuilder, Boolean, Nullable<GlobalMapZone>)

Declaration

public static ConditionsBuilder IsPartyInNaturalSetting(this ConditionsBuilder builder, bool negate = false, GlobalMapZone? setting = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
System.Nullable<Kingmaker.Enums.GlobalMapZone>	setting

Returns

Type	Description
ConditionsBuilder

Remarks

SE_IngerMaggor40ad6b04835d4c26b4fe62bb267a6143
SE_RenownExplorerb7204ae38aa346f3a584982fd8486ac2

| Improve this Doc View Source

LocationRevealed(ConditionsBuilder, Blueprint<BlueprintGlobalMapPoint.Reference>, Boolean)

Adds LocationRevealed(ConditionsBuilder, Blueprint<BlueprintGlobalMapPoint.Reference>, Boolean)

Declaration

public static ConditionsBuilder LocationRevealed(this ConditionsBuilder builder, Blueprint<BlueprintGlobalMapPoint.Reference> location = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Blueprint<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMapPoint.Reference>	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-25781449a5027d61ec4ab7886acfb6e1daddea
RegillNotInParty_KickedOut2b2cfaa1727070c43b10729920112730

| Improve this Doc View Source

MapObjectDestroyed(ConditionsBuilder, MapObjectEvaluator, Boolean)

Adds MapObjectDestroyed(ConditionsBuilder, MapObjectEvaluator, Boolean)

Declaration

public static ConditionsBuilder MapObjectDestroyed(this ConditionsBuilder builder, MapObjectEvaluator mapObject = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Kingmaker.ElementsSystem.MapObjectEvaluator	mapObject
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

Graveyard_BushesInCheck7d19a4d9deda414194a450b343eac99f
Graveyard_BushesOutCheck2f61e729c22a4a59a810466e9db43a6e

| Improve this Doc View Source

MapObjectRevealed(ConditionsBuilder, MapObjectEvaluator, Boolean)

Adds MapObjectRevealed(ConditionsBuilder, MapObjectEvaluator, Boolean)

Declaration

public static ConditionsBuilder MapObjectRevealed(this ConditionsBuilder builder, MapObjectEvaluator mapObject = null, bool negate = false)

Parameters

Type	Name	Description
ConditionsBuilder	builder
Kingmaker.ElementsSystem.MapObjectEvaluator	mapObject
System.Boolean	negate

Returns

Type	Description
ConditionsBuilder

Remarks

chap095c4212a36594186b509e87d00d2d480
TheiflingRevealDoor39a143d61a83c0fd4ea52262ed924ff72
Thieflings01_TrapReveal5799191689150bff488597bddf7f86c35

| Improve this Doc View Source

PartyInScriptZone(ConditionsBuilder, Nullable<PartyInScriptZone.CheckType>, Boolean, EntityReference)

Adds PartyInScriptZone(ConditionsBuilder, Nullable<PartyInScriptZone.CheckType>, Boolean, EntityReference)

Declaration

public static ConditionsBuilder PartyInScriptZone(this ConditionsBuilder builder, PartyInScriptZone.CheckType? check = null, bool negate = false, EntityReference scriptZone = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Nullable<Kingmaker.Designers.EventConditionActionSystem.Conditions.PartyInScriptZone.CheckType>	check
System.Boolean	negate
Kingmaker.Blueprints.EntityReference	scriptZone

Returns

Type	Description
ConditionsBuilder

Remarks

Answer_90b7d208f5f234f9791097f5aa1d5b8d5
CommandUnitCastSpell4192dd18345944af99cebe2a43c113b81
WatchPoint_SZWall_FoW0f1fdc5a42ea41a4b87da4021e89dabd

| Improve this Doc View Source

UnitInScriptZone(ConditionsBuilder, Boolean, MapObjectEvaluator, UnitEvaluator)

Adds UnitInScriptZone(ConditionsBuilder, Boolean, MapObjectEvaluator, UnitEvaluator)

Declaration

public static ConditionsBuilder UnitInScriptZone(this ConditionsBuilder builder, bool negate = false, MapObjectEvaluator scriptZone = null, UnitEvaluator unit = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
Kingmaker.ElementsSystem.MapObjectEvaluator	scriptZone
Kingmaker.ElementsSystem.UnitEvaluator	unit

Returns

Type	Description
ConditionsBuilder

Remarks

ComponentName: Condition/UnitInScriptZone

Answer_0002d38052d00f394118945e8861f00574f5
DLC1_IZ_Irabeth_startDialog5bc8820627af4f2080c6e19d4ab8c223
TrueLootHideZone9168ca19a2ced8d448a9944c2f0f01d72

| Improve this Doc View Source

UnitIsInAreaPart(ConditionsBuilder, Blueprint<BlueprintAreaPartReference>, Boolean, UnitEvaluator)

Adds UnitIsInAreaPart(ConditionsBuilder, Blueprint<BlueprintAreaPartReference>, Boolean, UnitEvaluator)

Declaration

public static ConditionsBuilder UnitIsInAreaPart(this ConditionsBuilder builder, Blueprint<BlueprintAreaPartReference> areaPart = null, bool negate = false, UnitEvaluator unit = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
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.
System.Boolean	negate
Kingmaker.ElementsSystem.UnitEvaluator	unit

Returns

Type	Description
ConditionsBuilder

Remarks

Answer_00108bbacd42e94344f8a0267b59dfbb4b8b
Cue_00162cec7e312adf465989d916ac69358412
Venduag_Q2_interlude_spawnConditions7d2e7755a041e0241ad6babe959f8454

| Improve this Doc View Source

UnitIsInFogOfWar(ConditionsBuilder, Boolean, UnitEvaluator)

Adds UnitIsInFogOfWar(ConditionsBuilder, Boolean, UnitEvaluator)

Declaration

public static ConditionsBuilder UnitIsInFogOfWar(this ConditionsBuilder builder, bool negate = false, UnitEvaluator target = null)

Parameters

Type	Name	Description
ConditionsBuilder	builder
System.Boolean	negate
Kingmaker.ElementsSystem.UnitEvaluator	target

Returns

Type	Description
ConditionsBuilder

Remarks

ComponentName: Condition/UnitIsInFogOfWar

PeacefullUnitsInCombatStatedff0fbdbd83672e429df0dc14b0db79e