Class BaseLoadingScreenSpriteListConfigurator<T, TBuilder>

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

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseLoadingScreenSpriteListConfigurator<T, TBuilder>
LoadingScreenSpriteListConfigurator
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
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseLoadingScreenSpriteListConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintLoadingScreenSpriteList where TBuilder : BaseLoadingScreenSpriteListConfigurator<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

BaseLoadingScreenSpriteListConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToGenericSpritesLink(AssetLink<SpriteLink>[])

Adds to the contents of Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_GenericSpritesLink

Declaration
public TBuilder AddToGenericSpritesLink(params AssetLink<SpriteLink>[] genericSpritesLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink>[] genericSpritesLink

You can pass in the animation using a SpriteLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToSettingTypeScreensList(BlueprintLoadingScreenSpriteList.SettingTypeScreens[])

Adds to the contents of Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_SettingTypeScreensList

Declaration
public TBuilder AddToSettingTypeScreensList(params BlueprintLoadingScreenSpriteList.SettingTypeScreens[] settingTypeScreensList)
Parameters
Type Name Description
Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.SettingTypeScreens[] settingTypeScreensList
Returns
Type Description
TBuilder
| Improve this Doc View Source

Removes all elements from Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_GenericSpritesLink

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

ClearSettingTypeScreensList()

Removes all elements from Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_SettingTypeScreensList

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

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

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

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

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

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

ModifyGenericSpritesLink(Action<SpriteLink>)

Modifies Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_GenericSpritesLink by invoking the provided action on each element.

Declaration
public TBuilder ModifyGenericSpritesLink(Action<SpriteLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.SpriteLink> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySettingTypeScreensList(Action<BlueprintLoadingScreenSpriteList.SettingTypeScreens>)

Modifies Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_SettingTypeScreensList by invoking the provided action on each element.

Declaration
public TBuilder ModifySettingTypeScreensList(Action<BlueprintLoadingScreenSpriteList.SettingTypeScreens> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.SettingTypeScreens> 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

RemoveFromGenericSpritesLink(AssetLink<SpriteLink>[])

Removes elements from Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_GenericSpritesLink

Declaration
public TBuilder RemoveFromGenericSpritesLink(params AssetLink<SpriteLink>[] genericSpritesLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink>[] genericSpritesLink

You can pass in the animation using a SpriteLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromGenericSpritesLink(Func<SpriteLink, Boolean>)

Removes elements from Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_GenericSpritesLink that match the provided predicate.

Declaration
public TBuilder RemoveFromGenericSpritesLink(Func<SpriteLink, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.ResourceLinks.SpriteLink, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSettingTypeScreensList(BlueprintLoadingScreenSpriteList.SettingTypeScreens[])

Removes elements from Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_SettingTypeScreensList

Declaration
public TBuilder RemoveFromSettingTypeScreensList(params BlueprintLoadingScreenSpriteList.SettingTypeScreens[] settingTypeScreensList)
Parameters
Type Name Description
Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.SettingTypeScreens[] settingTypeScreensList
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSettingTypeScreensList(Func<BlueprintLoadingScreenSpriteList.SettingTypeScreens, Boolean>)

Removes elements from Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_SettingTypeScreensList that match the provided predicate.

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

SetGenericSpritesLink(AssetLink<SpriteLink>[])

Sets the value of Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_GenericSpritesLink

Declaration
public TBuilder SetGenericSpritesLink(params AssetLink<SpriteLink>[] genericSpritesLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink>[] genericSpritesLink

You can pass in the animation using a SpriteLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSettingTypeScreensList(BlueprintLoadingScreenSpriteList.SettingTypeScreens[])

Sets the value of Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.m_SettingTypeScreensList

Declaration
public TBuilder SetSettingTypeScreensList(params BlueprintLoadingScreenSpriteList.SettingTypeScreens[] settingTypeScreensList)
Parameters
Type Name Description
Kingmaker.Blueprints.BlueprintLoadingScreenSpriteList.SettingTypeScreens[] settingTypeScreensList
Returns
Type Description
TBuilder