IWieldableControllerCC

This interface defines the functionality for a wieldable controller that manages equipping and holstering items in a game. It inherits from ICharacterComponent and includes the following properties and methods:

  • ActiveWieldable: Property that gets the currently equipped wieldable item.

  • State: Property that indicates the current state of the controller (equipping, holstering, etc.).

  • WieldableParent: Property that returns the parent transform of all registered wieldables.

  • Events:

    • HolsteringStarted: Triggered when starting to holster the current wieldable.

    • HolsteringStopped: Triggered when the holstering process is complete.

    • EquippingStarted: Triggered when starting to equip a new wieldable.

    • EquippingStopped: Triggered when the equipping process is complete.

  • TryEquipWieldable(IWieldable wieldable, float holsterSpeedMod, UnityAction equipCallback): Attempts to equip a new wieldable after the current one has been holstered. Returns true if successful.

  • TryHolsterWieldable(IWieldable wieldable, float holsterSpeedMod): Attempts to holster a specified wieldable. Returns true if successful.

  • HolsterAll(): Holsters the currently active wieldable and clears the equip stack.

  • RegisterWieldable(IWieldable wieldable): Registers a new wieldable in the available pool and returns the registered instance.

  • UnregisterWieldable(IWieldable wieldable, bool destroy): Unregisters a specified wieldable from the pool, optionally destroying it.

Last updated