SelectionLock 
| 📊 Overview: 3 Properties | 1 Constructor | 2 Functions |
📝 Description
Attempts to lock all entities in provided entity selections, optionally unlocking all on failure
🕐 Last updated: 2025-12-10T11:45:24.285Z
📑 Table of Contents
- 📋 Properties (3)
- 🏗️ Constructor (2 params)
- ⚙️ Functions
- Regular Functions
- displayAlert (2 params)
- unlock
- Regular Functions
Properties
| Property | Type | Default | Description |
|---|---|---|---|
LockedEntityCollection | Collection | - | Collection of successfully locked entities |
FailedLockObjectCollection | Collection | - | Collection of lock failure objects with entity references |
Success | Boolean | - | True if all entities locked successfully |
Constructor
constructor
[🏗️ constructor]
Class constructor($EntitySelectionCollection : Collection; $UnlockOnError : Boolean)
Attempts to lock all entities in provided entity selections, optionally unlocking all on failure
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$EntitySelectionCollection | Collection | - | - |
$UnlockOnError | Boolean | - | - |
Functions
Regular Functions
displayAlert
Function displayAlert($Unlock : Boolean; $DisplayForAllEntities : Boolean)
Displays alert for each failed lock, optionally unlocking all locked entities first
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$Unlock | Boolean | - | - |
$DisplayForAllEntities | Boolean | - | - |
unlock
Function unlock
Unlocks all successfully locked entities in the collection
Generated from SelectionLock.4dm