Class BaseLootConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Loot.BlueprintLoot.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseLootConfigurator<T, TBuilder>
LootConfigurator
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.Loot
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseLootConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintLoot where TBuilder : BaseLootConfigurator<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

BaseLootConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToItems(LootEntry[])

Adds to the contents of Kingmaker.Blueprints.Loot.BlueprintLoot.Items

Declaration
public TBuilder AddToItems(params LootEntry[] items)
Parameters
Type Name Description
Kingmaker.Blueprints.Loot.LootEntry[] items
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearItems()

Removes all elements from Kingmaker.Blueprints.Loot.BlueprintLoot.Items

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

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

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

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

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

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

ModifyContainerName(Action<String>)

Modifies Kingmaker.Blueprints.Loot.BlueprintLoot.ContainerName by invoking the provided action.

Declaration
public TBuilder ModifyContainerName(Action<string> action)
Parameters
Type Name Description
System.Action<System.String> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyItems(Action<LootEntry>)

Modifies Kingmaker.Blueprints.Loot.BlueprintLoot.Items by invoking the provided action on each element.

Declaration
public TBuilder ModifyItems(Action<LootEntry> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.Loot.LootEntry> 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

RemoveFromItems(LootEntry[])

Removes elements from Kingmaker.Blueprints.Loot.BlueprintLoot.Items

Declaration
public TBuilder RemoveFromItems(params LootEntry[] items)
Parameters
Type Name Description
Kingmaker.Blueprints.Loot.LootEntry[] items
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromItems(Func<LootEntry, Boolean>)

Removes elements from Kingmaker.Blueprints.Loot.BlueprintLoot.Items that match the provided predicate.

Declaration
public TBuilder RemoveFromItems(Func<LootEntry, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Blueprints.Loot.LootEntry, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetArea(Blueprint<BlueprintAreaReference>)

Sets the value of Kingmaker.Blueprints.Loot.BlueprintLoot.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

SetContainerName(String)

Sets the value of Kingmaker.Blueprints.Loot.BlueprintLoot.ContainerName

Declaration
public TBuilder SetContainerName(string containerName)
Parameters
Type Name Description
System.String containerName
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIdentify(Boolean)

Sets the value of Kingmaker.Blueprints.Loot.BlueprintLoot.Identify

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

SetIsSuperTrash(Boolean)

Sets the value of Kingmaker.Blueprints.Loot.BlueprintLoot.IsSuperTrash

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

SetItems(LootEntry[])

Sets the value of Kingmaker.Blueprints.Loot.BlueprintLoot.Items

Declaration
public TBuilder SetItems(params LootEntry[] items)
Parameters
Type Name Description
Kingmaker.Blueprints.Loot.LootEntry[] items
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSetting(LootSetting)

Sets the value of Kingmaker.Blueprints.Loot.BlueprintLoot.Setting

Declaration
public TBuilder SetSetting(LootSetting setting)
Parameters
Type Name Description
Kingmaker.Enums.LootSetting setting
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetType(LootType)

Sets the value of Kingmaker.Blueprints.Loot.BlueprintLoot.Type

Declaration
public TBuilder SetType(LootType type)
Parameters
Type Name Description
Kingmaker.Blueprints.Loot.LootType type
Returns
Type Description
TBuilder