Skip to main content

ExtendedItemRequirementCheckMessage

Callable

  • ExtendedItemRequirementCheckMessage<T>(data: ExtendedItemData<T>, C: Character, item: Item, Option: T, CurrentOption: T, permitExisting?: boolean): string

  • Checks whether the character meets the requirements for an extended type option. This will check against their Bondage skill if applying the item to another character, or their Self Bondage skill if applying the item to themselves.


    Type parameters

    Parameters

    • data: ExtendedItemData<T>
    • C: Character

      The character in question

    • item: Item

      The item in question

    • Option: T

      The selected type definition

    • CurrentOption: T

      The current type definition

    • permitExisting: boolean = false

      Determines whether the validation should allow the new option and previous option to be identical. Defaults to false.

    Returns string

    null if the player meets the option requirements. Otherwise a string message informing them of the requirements they do not meet