Class ActionsBuilderStoryEx
Extension to ActionsBuilder for actions related to the story such as companion stories, quests, name changes, and etudes.
Inheritance
System.Object
ActionsBuilderStoryEx
Assembly: BlueprintCore.dll
Syntax
public static class ActionsBuilderStoryEx
Methods
|
Improve this Doc
View Source
ChangeUnitName(ActionsBuilder, LocalString, UnitEvaluator, Nullable<Boolean>)
Declaration
public static ActionsBuilder ChangeUnitName(this ActionsBuilder builder, LocalString newName, UnitEvaluator unit, bool? addToTheName = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
LocalString |
newName |
You can pass in the string using a LocalizedString or the Key to a LocalizedString.
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
System.Nullable<System.Boolean> |
addToTheName |
|
Returns
|
Improve this Doc
View Source
ClearQuestsOnAutoKingdom(ActionsBuilder)
Declaration
public static ActionsBuilder ClearQuestsOnAutoKingdom(this ActionsBuilder builder)
Parameters
Returns
|
Improve this Doc
View Source
CompleteEtude(ActionsBuilder, Blueprint<BlueprintEtudeReference>, BlueprintEvaluator)
Declaration
public static ActionsBuilder CompleteEtude(this ActionsBuilder builder, Blueprint<BlueprintEtudeReference> etude, BlueprintEvaluator etudeEvaluator = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintEtudeReference> |
etude |
Blueprint of type BlueprintEtude. 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.
|
Kingmaker.ElementsSystem.BlueprintEvaluator |
etudeEvaluator |
|
Returns
|
Improve this Doc
View Source
DismissAllCompanions(ActionsBuilder)
Declaration
public static ActionsBuilder DismissAllCompanions(this ActionsBuilder builder)
Parameters
Returns
|
Improve this Doc
View Source
GiveObjective(ActionsBuilder, Blueprint<BlueprintQuestObjectiveReference>)
Declaration
public static ActionsBuilder GiveObjective(this ActionsBuilder builder, Blueprint<BlueprintQuestObjectiveReference> objective = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintQuestObjectiveReference> |
objective |
Blueprint of type BlueprintQuestObjective. 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
|
Improve this Doc
View Source
HideUnit(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, UnitEvaluator, Nullable<Boolean>)
Declaration
public static ActionsBuilder HideUnit(this ActionsBuilder builder, bool? fade = null, bool? setHideInSaves = null, UnitEvaluator target = null, bool? unhide = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
fade |
|
System.Nullable<System.Boolean> |
setHideInSaves |
|
Kingmaker.ElementsSystem.UnitEvaluator |
target |
|
System.Nullable<System.Boolean> |
unhide |
|
Returns
|
Improve this Doc
View Source
HideWeapons(ActionsBuilder, Nullable<Boolean>, UnitEvaluator)
Declaration
public static ActionsBuilder HideWeapons(this ActionsBuilder builder, bool? hide = null, UnitEvaluator target = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
hide |
|
Kingmaker.ElementsSystem.UnitEvaluator |
target |
|
Returns
|
Improve this Doc
View Source
IncrementFlagValue(ActionsBuilder, Blueprint<BlueprintUnlockableFlagReference>, Nullable<Boolean>, IntEvaluator)
Declaration
public static ActionsBuilder IncrementFlagValue(this ActionsBuilder builder, Blueprint<BlueprintUnlockableFlagReference> flag = null, bool? unlockIfNot = null, IntEvaluator value = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintUnlockableFlagReference> |
flag |
Blueprint of type BlueprintUnlockableFlag. 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.Nullable<System.Boolean> |
unlockIfNot |
|
Kingmaker.ElementsSystem.IntEvaluator |
value |
|
Returns
|
Improve this Doc
View Source
InterruptAllActions(ActionsBuilder, UnitEvaluator)
Declaration
public static ActionsBuilder InterruptAllActions(this ActionsBuilder builder, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
LockAlignment(ActionsBuilder, Nullable<AlignmentMaskType>, Nullable<Alignment>, UnitEvaluator)
Declaration
public static ActionsBuilder LockAlignment(this ActionsBuilder builder, AlignmentMaskType? alignmentMask = null, Alignment? targetAlignment = null, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<Kingmaker.UnitLogic.Alignments.AlignmentMaskType> |
alignmentMask |
InfoBox: Current unit alignment will be shifted to the nearest available sector. None selected => removes locking and current alignment remains.
|
System.Nullable<Kingmaker.Enums.Alignment> |
targetAlignment |
InfoBox: Considered as initial alignment. This is usually sector's center (LG for Angel, NE for Lich) Will be ignored for `None` mask (all or none square selected)
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
LockFlag(ActionsBuilder, Blueprint<BlueprintUnlockableFlagReference>)
Declaration
public static ActionsBuilder LockFlag(this ActionsBuilder builder, Blueprint<BlueprintUnlockableFlagReference> flag = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintUnlockableFlagReference> |
flag |
Blueprint of type BlueprintUnlockableFlag. 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
|
Improve this Doc
View Source
Declaration
public static ActionsBuilder MarkAnswersSelected(this ActionsBuilder builder, params Blueprint<BlueprintAnswerReference>[] answers)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintAnswerReference>[] |
answers |
Blueprint of type BlueprintAnswer. 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
|
Improve this Doc
View Source
MarkCuesSeen(ActionsBuilder, Blueprint<BlueprintCueBaseReference>[])
Declaration
public static ActionsBuilder MarkCuesSeen(this ActionsBuilder builder, params Blueprint<BlueprintCueBaseReference>[] cues)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintCueBaseReference>[] |
cues |
Blueprint of type BlueprintCueBase. 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
|
Improve this Doc
View Source
MoveAzataIslandToLocation(ActionsBuilder, Blueprint<BlueprintGlobalMap.Reference>, Blueprint<BlueprintGlobalMapPoint.Reference>)
Declaration
public static ActionsBuilder MoveAzataIslandToLocation(this ActionsBuilder builder, Blueprint<BlueprintGlobalMap.Reference> globalMap = null, Blueprint<BlueprintGlobalMapPoint.Reference> location = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMap.Reference> |
globalMap |
Blueprint of type BlueprintGlobalMap. 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.
|
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.
|
Returns
Remarks
|
Improve this Doc
View Source
MoveAzataIslandToNearestCrossroad(ActionsBuilder, Blueprint<BlueprintGlobalMap.Reference>)
Declaration
public static ActionsBuilder MoveAzataIslandToNearestCrossroad(this ActionsBuilder builder, Blueprint<BlueprintGlobalMap.Reference> globalMap = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMap.Reference> |
globalMap |
Blueprint of type BlueprintGlobalMap. 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
Remarks
|
Improve this Doc
View Source
OverrideUnitReturnPosition(ActionsBuilder, FloatEvaluator, PositionEvaluator, UnitEvaluator)
Declaration
public static ActionsBuilder OverrideUnitReturnPosition(this ActionsBuilder builder, FloatEvaluator orientation = null, PositionEvaluator position = null, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.FloatEvaluator |
orientation |
|
Kingmaker.ElementsSystem.PositionEvaluator |
position |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
PartyMembersAttach(ActionsBuilder)
Declaration
public static ActionsBuilder PartyMembersAttach(this ActionsBuilder builder)
Parameters
Returns
|
Improve this Doc
View Source
PartyMembersDetach(ActionsBuilder, ActionsBuilder, List<Blueprint<BlueprintUnitReference>>, Nullable<Int32>, Nullable<Boolean>)
Declaration
public static ActionsBuilder PartyMembersDetach(this ActionsBuilder builder, ActionsBuilder afterDetach = null, List<Blueprint<BlueprintUnitReference>> detachAllExcept = null, int? partySize = null, bool? restrictPartySize = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
ActionsBuilder |
afterDetach |
|
System.Collections.Generic.List<Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>> |
detachAllExcept |
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.
|
System.Nullable<System.Int32> |
partySize |
|
System.Nullable<System.Boolean> |
restrictPartySize |
|
Returns
|
Improve this Doc
View Source
PartyMembersDetachEvaluated(ActionsBuilder, ActionsBuilder, UnitEvaluator[], Nullable<Int32>, Nullable<Boolean>)
Declaration
public static ActionsBuilder PartyMembersDetachEvaluated(this ActionsBuilder builder, ActionsBuilder afterDetach = null, UnitEvaluator[] detachThese = null, int? partySize = null, bool? restrictPartySize = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
ActionsBuilder |
afterDetach |
|
Kingmaker.ElementsSystem.UnitEvaluator[] |
detachThese |
|
System.Nullable<System.Int32> |
partySize |
|
System.Nullable<System.Boolean> |
restrictPartySize |
|
Returns
|
Improve this Doc
View Source
PartyMembersSwapAttachedAndDetached(ActionsBuilder)
Declaration
public static ActionsBuilder PartyMembersSwapAttachedAndDetached(this ActionsBuilder builder)
Parameters
Returns
Remarks
|
Improve this Doc
View Source
Recruit(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, ActionsBuilder, ActionsBuilder, Recruit.RecruitData[])
Declaration
public static ActionsBuilder Recruit(this ActionsBuilder builder, bool? addToParty = null, bool? matchPlayerXpExactly = null, ActionsBuilder onRecruit = null, ActionsBuilder onRecruitImmediate = null, Recruit.RecruitData[] recruited = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
addToParty |
|
System.Nullable<System.Boolean> |
matchPlayerXpExactly |
|
ActionsBuilder |
onRecruit |
|
ActionsBuilder |
onRecruitImmediate |
|
Kingmaker.Designers.EventConditionActionSystem.Actions.Recruit.RecruitData[] |
recruited |
|
Returns
|
Improve this Doc
View Source
RecruitInactive(ActionsBuilder, Nullable<Boolean>, Blueprint<BlueprintUnitReference>, ActionsBuilder)
Declaration
public static ActionsBuilder RecruitInactive(this ActionsBuilder builder, bool? availableDelay = null, Blueprint<BlueprintUnitReference> companionBlueprint = null, ActionsBuilder onRecruit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
availableDelay |
|
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference> |
companionBlueprint |
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.
|
ActionsBuilder |
onRecruit |
|
Returns
|
Improve this Doc
View Source
RemoveMythicLevels(ActionsBuilder, Blueprint<BlueprintCharacterClassReference>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, UnitEvaluator)
Declaration
public static ActionsBuilder RemoveMythicLevels(this ActionsBuilder builder, Blueprint<BlueprintCharacterClassReference> clazz = null, int? levels = null, bool? specificClass = null, bool? specificUnit = null, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintCharacterClassReference> |
clazz |
Blueprint of type BlueprintCharacterClass. 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.Nullable<System.Int32> |
levels |
|
System.Nullable<System.Boolean> |
specificClass |
|
System.Nullable<System.Boolean> |
specificUnit |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
RemoveQuest(ActionsBuilder, Blueprint<BlueprintQuestReference>)
Declaration
public static ActionsBuilder RemoveQuest(this ActionsBuilder builder, Blueprint<BlueprintQuestReference> quest = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintQuestReference> |
quest |
Blueprint of type BlueprintQuest. 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
|
Improve this Doc
View Source
ResetQuest(ActionsBuilder, List<Blueprint<BlueprintQuestObjectiveReference>>, Blueprint<BlueprintQuestObjectiveReference>, Blueprint<BlueprintQuestReference>)
Declaration
public static ActionsBuilder ResetQuest(this ActionsBuilder builder, List<Blueprint<BlueprintQuestObjectiveReference>> objectivesToReset = null, Blueprint<BlueprintQuestObjectiveReference> objectiveToStart = null, Blueprint<BlueprintQuestReference> quest = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Collections.Generic.List<Blueprint<Kingmaker.Blueprints.BlueprintQuestObjectiveReference>> |
objectivesToReset |
Blueprint of type BlueprintQuestObjective. 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.
|
Blueprint<Kingmaker.Blueprints.BlueprintQuestObjectiveReference> |
objectiveToStart |
Blueprint of type BlueprintQuestObjective. 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.
|
Blueprint<Kingmaker.Blueprints.BlueprintQuestReference> |
quest |
Blueprint of type BlueprintQuest. 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
|
Improve this Doc
View Source
ResetQuestObjective(ActionsBuilder, Blueprint<BlueprintQuestObjectiveReference>)
Declaration
public static ActionsBuilder ResetQuestObjective(this ActionsBuilder builder, Blueprint<BlueprintQuestObjectiveReference> objective = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintQuestObjectiveReference> |
objective |
Blueprint of type BlueprintQuestObjective. 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
|
Improve this Doc
View Source
ResetUnitName(ActionsBuilder, UnitEvaluator)
Declaration
public static ActionsBuilder ResetUnitName(this ActionsBuilder builder, UnitEvaluator unit)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
RespecCompanion(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static ActionsBuilder RespecCompanion(this ActionsBuilder builder, bool? forFree = null, bool? matchPlayerXpExactly = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
forFree |
|
System.Nullable<System.Boolean> |
matchPlayerXpExactly |
|
Returns
|
Improve this Doc
View Source
SetDialogPosition(ActionsBuilder, PositionEvaluator)
Declaration
public static ActionsBuilder SetDialogPosition(this ActionsBuilder builder, PositionEvaluator position = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.PositionEvaluator |
position |
|
Returns
|
Improve this Doc
View Source
SetMythicLevelForMainCharacter(ActionsBuilder, Nullable<Int32>)
Declaration
public static ActionsBuilder SetMythicLevelForMainCharacter(this ActionsBuilder builder, int? desireLevel = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Int32> |
desireLevel |
InfoBox: Main character will get mythic level = DesireLevel. Note: Action won't reduce mythic level
|
Returns
Remarks
|
Improve this Doc
View Source
SetObjectiveStatus(ActionsBuilder, Blueprint<BlueprintQuestObjectiveReference>, Nullable<Boolean>, Nullable<SummonPoolCountTrigger.ObjectiveStatus>)
Declaration
public static ActionsBuilder SetObjectiveStatus(this ActionsBuilder builder, Blueprint<BlueprintQuestObjectiveReference> objective = null, bool? startObjectiveIfNone = null, SummonPoolCountTrigger.ObjectiveStatus? status = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintQuestObjectiveReference> |
objective |
Blueprint of type BlueprintQuestObjective. 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.Nullable<System.Boolean> |
startObjectiveIfNone |
|
System.Nullable<Kingmaker.Designers.Quests.Common.SummonPoolCountTrigger.ObjectiveStatus> |
status |
|
Returns
|
Improve this Doc
View Source
SetPortrait(ActionsBuilder, Blueprint<BlueprintPortraitReference>, UnitEvaluator)
Declaration
public static ActionsBuilder SetPortrait(this ActionsBuilder builder, Blueprint<BlueprintPortraitReference> portrait = null, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintPortraitReference> |
portrait |
Blueprint of type BlueprintPortrait. 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.
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
ShiftAlignment(ActionsBuilder, Nullable<AlignmentShiftDirection>, IntEvaluator, UnitEvaluator)
Declaration
public static ActionsBuilder ShiftAlignment(this ActionsBuilder builder, AlignmentShiftDirection? alignment = null, IntEvaluator amount = null, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<Kingmaker.UnitLogic.Alignments.AlignmentShiftDirection> |
alignment |
|
Kingmaker.ElementsSystem.IntEvaluator |
amount |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
ShowDialogBox(ActionsBuilder, ActionsBuilder, ActionsBuilder, ParametrizedContextSetter, LocalString)
Declaration
public static ActionsBuilder ShowDialogBox(this ActionsBuilder builder, ActionsBuilder onAccept = null, ActionsBuilder onCancel = null, ParametrizedContextSetter parameters = null, LocalString text = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
ActionsBuilder |
onAccept |
|
ActionsBuilder |
onCancel |
|
Kingmaker.Designers.EventConditionActionSystem.NamedParameters.ParametrizedContextSetter |
parameters |
|
LocalString |
text |
You can pass in the string using a LocalizedString or the Key to a LocalizedString.
|
Returns
|
Improve this Doc
View Source
ShowMessageBox(ActionsBuilder, ActionsBuilder, LocalString, Nullable<Int32>)
Declaration
public static ActionsBuilder ShowMessageBox(this ActionsBuilder builder, ActionsBuilder onClose = null, LocalString text = null, int? waitTime = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
ActionsBuilder |
onClose |
|
LocalString |
text |
You can pass in the string using a LocalizedString or the Key to a LocalizedString.
|
System.Nullable<System.Int32> |
waitTime |
|
Returns
|
Improve this Doc
View Source
ShowUIWarning(ActionsBuilder, LocalString, Nullable<WarningNotificationType>)
Declaration
public static ActionsBuilder ShowUIWarning(this ActionsBuilder builder, LocalString stringValue = null, WarningNotificationType? type = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
LocalString |
stringValue |
You can pass in the string using a LocalizedString or the Key to a LocalizedString.
|
System.Nullable<Kingmaker.UI.WarningNotificationType> |
type |
|
Returns
|
Improve this Doc
View Source
SplitUnitGroup(ActionsBuilder, UnitEvaluator)
Declaration
public static ActionsBuilder SplitUnitGroup(this ActionsBuilder builder, UnitEvaluator target = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.UnitEvaluator |
target |
|
Returns
|
Improve this Doc
View Source
StartCombat(ActionsBuilder, UnitEvaluator, UnitEvaluator)
Declaration
public static ActionsBuilder StartCombat(this ActionsBuilder builder, UnitEvaluator unit1 = null, UnitEvaluator unit2 = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit1 |
InfoBox: Unit1 will become enemy of Unit2's Faction
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit2 |
|
Returns
|
Improve this Doc
View Source
StartDialog(ActionsBuilder, BlueprintEvaluator, Blueprint<BlueprintDialogReference>, UnitEvaluator, LocalString)
Declaration
public static ActionsBuilder StartDialog(this ActionsBuilder builder, BlueprintEvaluator dialogEvaluator = null, Blueprint<BlueprintDialogReference> dialogue = null, UnitEvaluator dialogueOwner = null, LocalString speakerName = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.BlueprintEvaluator |
dialogEvaluator |
Tooltip: Evaluator. Works if Dialogue is null
|
Blueprint<Kingmaker.Blueprints.BlueprintDialogReference> |
dialogue |
Tooltip: This dialog overrides dialog in 'Dialogue Owner' if it exists
Blueprint of type BlueprintDialog. 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.
|
Kingmaker.ElementsSystem.UnitEvaluator |
dialogueOwner |
Tooltip: Unit with BlueprintDialog. If unit have no BlueprintDialog or Null - Dialog from field 'Dialog' will be used.
|
LocalString |
speakerName |
Tooltip: Interlocutor name. Uses only if 'Dialogue Owner' is Null
You can pass in the string using a LocalizedString or the Key to a LocalizedString.
|
Returns
|
Improve this Doc
View Source
StartEncounter(ActionsBuilder, Blueprint<BlueprintRandomEncounterReference>)
Declaration
public static ActionsBuilder StartEncounter(this ActionsBuilder builder, Blueprint<BlueprintRandomEncounterReference> encounter = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintRandomEncounterReference> |
encounter |
Blueprint of type BlueprintRandomEncounter. 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
Remarks
|
Improve this Doc
View Source
StartEtude(ActionsBuilder, Blueprint<BlueprintEtudeReference>, BlueprintEvaluator, Nullable<Boolean>)
Declaration
public static ActionsBuilder StartEtude(this ActionsBuilder builder, Blueprint<BlueprintEtudeReference> etude = null, BlueprintEvaluator etudeEvaluator = null, bool? evaluate = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintEtudeReference> |
etude |
Blueprint of type BlueprintEtude. 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.
|
Kingmaker.ElementsSystem.BlueprintEvaluator |
etudeEvaluator |
|
System.Nullable<System.Boolean> |
evaluate |
|
Returns
|
Improve this Doc
View Source
SwitchAzataIsland(ActionsBuilder, Blueprint<BlueprintGlobalMap.Reference>, Nullable<Boolean>)
Declaration
public static ActionsBuilder SwitchAzataIsland(this ActionsBuilder builder, Blueprint<BlueprintGlobalMap.Reference> globalMap = null, bool? isOn = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Globalmap.Blueprints.BlueprintGlobalMap.Reference> |
globalMap |
Blueprint of type BlueprintGlobalMap. 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.Nullable<System.Boolean> |
isOn |
|
Returns
Remarks
|
Improve this Doc
View Source
SwitchChapter(ActionsBuilder, Nullable<Int32>)
Declaration
public static ActionsBuilder SwitchChapter(this ActionsBuilder builder, int? chapter = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Int32> |
chapter |
|
Returns
|
Improve this Doc
View Source
SwitchDoor(ActionsBuilder, Nullable<Boolean>, MapObjectEvaluator, Nullable<Boolean>, Nullable<Boolean>)
Declaration
public static ActionsBuilder SwitchDoor(this ActionsBuilder builder, bool? closeIfAlreadyOpen = null, MapObjectEvaluator door = null, bool? openIfAlreadyClosed = null, bool? unlockIfLocked = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
closeIfAlreadyOpen |
|
Kingmaker.ElementsSystem.MapObjectEvaluator |
door |
|
System.Nullable<System.Boolean> |
openIfAlreadyClosed |
|
System.Nullable<System.Boolean> |
unlockIfLocked |
|
Returns
|
Improve this Doc
View Source
SwitchFaction(ActionsBuilder, Nullable<Boolean>, Blueprint<BlueprintFactionReference>, Nullable<Boolean>, Nullable<Boolean>, UnitEvaluator)
Declaration
public static ActionsBuilder SwitchFaction(this ActionsBuilder builder, bool? changePetsFaction = null, Blueprint<BlueprintFactionReference> faction = null, bool? includeGroup = null, bool? resetAllRelations = null, UnitEvaluator target = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
changePetsFaction |
|
Blueprint<Kingmaker.Blueprints.BlueprintFactionReference> |
faction |
Blueprint of type BlueprintFaction. 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.Nullable<System.Boolean> |
includeGroup |
|
System.Nullable<System.Boolean> |
resetAllRelations |
|
Kingmaker.ElementsSystem.UnitEvaluator |
target |
|
Returns
|
Improve this Doc
View Source
SwitchInteraction(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, MapObjectEvaluator)
Declaration
public static ActionsBuilder SwitchInteraction(this ActionsBuilder builder, bool? disableIfAlreadyEnabled = null, bool? enableIfAlreadyDisabled = null, MapObjectEvaluator mapObject = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
disableIfAlreadyEnabled |
|
System.Nullable<System.Boolean> |
enableIfAlreadyDisabled |
|
Kingmaker.ElementsSystem.MapObjectEvaluator |
mapObject |
|
Returns
|
Improve this Doc
View Source
SwitchRoaming(ActionsBuilder, Nullable<Boolean>, UnitEvaluator)
Declaration
public static ActionsBuilder SwitchRoaming(this ActionsBuilder builder, bool? disable = null, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
disable |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
SwitchToEnemy(ActionsBuilder, Blueprint<BlueprintFactionReference>, UnitEvaluator)
Declaration
public static ActionsBuilder SwitchToEnemy(this ActionsBuilder builder, Blueprint<BlueprintFactionReference> factionToAttack = null, UnitEvaluator target = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintFactionReference> |
factionToAttack |
Blueprint of type BlueprintFaction. 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.
|
Kingmaker.ElementsSystem.UnitEvaluator |
target |
|
Returns
|
Improve this Doc
View Source
SwitchToNeutral(ActionsBuilder, Blueprint<BlueprintFactionReference>, Nullable<Boolean>, UnitEvaluator)
Declaration
public static ActionsBuilder SwitchToNeutral(this ActionsBuilder builder, Blueprint<BlueprintFactionReference> faction = null, bool? includeGroup = null, UnitEvaluator target = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintFactionReference> |
faction |
Blueprint of type BlueprintFaction. 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.Nullable<System.Boolean> |
includeGroup |
|
Kingmaker.ElementsSystem.UnitEvaluator |
target |
InfoBox: Makes the Target unit stop attacking the Faction
|
Returns
|
Improve this Doc
View Source
TimeSkip(ActionsBuilder, Nullable<Boolean>, IntEvaluator, Nullable<Boolean>, Nullable<Boolean>, Nullable<TimeOfDay>, Nullable<TimeSkip.SkipType>)
Declaration
public static ActionsBuilder TimeSkip(this ActionsBuilder builder, bool? matchTimeOfDay = null, IntEvaluator minutesToSkip = null, bool? noFatigue = null, bool? silent = null, TimeOfDay? timeOfDay = null, TimeSkip.SkipType? type = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
System.Nullable<System.Boolean> |
matchTimeOfDay |
|
Kingmaker.ElementsSystem.IntEvaluator |
minutesToSkip |
|
System.Nullable<System.Boolean> |
noFatigue |
|
System.Nullable<System.Boolean> |
silent |
|
System.Nullable<Kingmaker.AreaLogic.TimeOfDay> |
timeOfDay |
|
System.Nullable<Kingmaker.Designers.EventConditionActionSystem.Actions.TimeSkip.SkipType> |
type |
|
Returns
|
Improve this Doc
View Source
UnitLookAt(ActionsBuilder, PositionEvaluator, UnitEvaluator)
Declaration
public static ActionsBuilder UnitLookAt(this ActionsBuilder builder, PositionEvaluator position = null, UnitEvaluator unit = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Kingmaker.ElementsSystem.PositionEvaluator |
position |
|
Kingmaker.ElementsSystem.UnitEvaluator |
unit |
|
Returns
|
Improve this Doc
View Source
UnlockCompanionStory(ActionsBuilder, Blueprint<BlueprintCompanionStoryReference>)
Declaration
public static ActionsBuilder UnlockCompanionStory(this ActionsBuilder builder, Blueprint<BlueprintCompanionStoryReference> story = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintCompanionStoryReference> |
story |
Blueprint of type BlueprintCompanionStory. 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
|
Improve this Doc
View Source
UnlockFlag(ActionsBuilder, Blueprint<BlueprintUnlockableFlagReference>, Nullable<Int32>)
Declaration
public static ActionsBuilder UnlockFlag(this ActionsBuilder builder, Blueprint<BlueprintUnlockableFlagReference> flag = null, int? flagValue = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintUnlockableFlagReference> |
flag |
Blueprint of type BlueprintUnlockableFlag. 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.Nullable<System.Int32> |
flagValue |
|
Returns
|
Improve this Doc
View Source
Declaration
public static ActionsBuilder UnmarkAnswersSelected(this ActionsBuilder builder, params Blueprint<BlueprintAnswerReference>[] answers)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintAnswerReference>[] |
answers |
Blueprint of type BlueprintAnswer. 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
|
Improve this Doc
View Source
Unrecruit(ActionsBuilder, Blueprint<BlueprintUnitReference>, UnitEvaluator, ActionsBuilder, Nullable<Boolean>)
Declaration
public static ActionsBuilder Unrecruit(this ActionsBuilder builder, Blueprint<BlueprintUnitReference> companionBlueprint = null, UnitEvaluator companionEvaluator = null, ActionsBuilder onUnrecruit = null, bool? useEvaluator = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference> |
companionBlueprint |
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.
|
Kingmaker.ElementsSystem.UnitEvaluator |
companionEvaluator |
|
ActionsBuilder |
onUnrecruit |
|
System.Nullable<System.Boolean> |
useEvaluator |
|
Returns
|
Improve this Doc
View Source
UpdateEtudeProgressBar(ActionsBuilder, Blueprint<BlueprintEtudeReference>, IntEvaluator)
Declaration
public static ActionsBuilder UpdateEtudeProgressBar(this ActionsBuilder builder, Blueprint<BlueprintEtudeReference> etude = null, IntEvaluator progress = null)
Parameters
Type |
Name |
Description |
ActionsBuilder |
builder |
|
Blueprint<Kingmaker.Blueprints.BlueprintEtudeReference> |
etude |
Blueprint of type BlueprintEtude. 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.
|
Kingmaker.ElementsSystem.IntEvaluator |
progress |
|
Returns
|
Improve this Doc
View Source
UpdateEtudes(ActionsBuilder)
Declaration
public static ActionsBuilder UpdateEtudes(this ActionsBuilder builder)
Parameters
Returns