# Interfaces

<p class="callout info">**/All/Game/LockpickMinigame/Interfaces**</p>

### BPI\_Lockpickable

#### CanBeLockpicked

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/Cy8image.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/Cy8image.png)

- Function which handles the condition about the object being lockpick able. For e.g. if the object is already lockpicked, this condition should return false.
- It can be used with other logic such as the lock being stuck, so lockpicking can't be started.

#### OnLockpickStarted

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/fbvimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/fbvimage.png)

- Event to be called when the lockpicking starts.
- E.g. can be called when the BP\_Lockpick\_Minigame &amp; W\_Lockpick\_Minigame are spawned and can be used to hide the "Interact" prompt from behind the lockpick widget

#### OnLockpickSuccessful

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/8vHimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/8vHimage.png)

- Event to be called when the lockpick is successful
- Called by the BP\_Lockpick\_Minigame

#### OnLockpickFailed

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/jRAimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/jRAimage.png)

- Event to be called when the lockpick fails for given reason
- Called by the BP\_Lockpick\_Minigame when there are no more lockpicks available

#### OnLockpickClosed

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/LQyimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/LQyimage.png)

- Event to be called when the lockpick minigame is closed by player - without it being successful or failed
- Called by the BP\_Lockpick\_Minigame on "CloseMinigame" event

#### GetLockConfig

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/VKsimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/VKsimage.png)

- Event that can be used to retrieve the current object lock configuration

### BPI\_Lockpicker

#### AddLockpickable

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/jcXimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/jcXimage.png)

- Event that can be used to provide information to the lockpicker that there's a lockpick able object nearby
- Can be used for interaction

#### RemoveLockpickable

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/47fimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/47fimage.png)

- Counterpart event for the "AddLockpickable" event

#### IsLockpickOngoing

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/ZJ7image.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/ZJ7image.png)

- Function with condition for ongoing lockpicking

#### OnLockpickFinished

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/3ytimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/3ytimage.png)

- Event that can be called when lockpicking ends (successful or failed)
- Used by the BP\_Lockpick\_Minigame on "CloseMinigame" event and when lockpick is successful or failed

#### OnLockpickBreak

[![image.png](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/scaled-1680-/29Eimage.png)](https://docs.ccragdollgames.com/uploads/images/gallery/2025-03/29Eimage.png)

- Event that can be called when the pick breaks
- Used by the BP\_Lockpick\_Minigame