/ HALion Developer Resource / HALion Script / Reference /

addLayerPassword

addLayerPassword(pwd)

Description

Function that gives access to protected layers. By default, protected layers cannot be accessed by scripts. The parameters of a protected layer and any elements inside of it are hidden for scripts. This prevents someone unauthorized from parsing the Program Tree to retrieve hidden information. By calling this function with the correct password, the calling script can access the corresponding protected layers again.

❕ To hide the password in addLayerPassword, you must also protect the script module. See Managing Script Modules for details.

Available in: Controller.

Arguments

Example

-- Access the protected layer(s) which have the password "abc123".

addLayerPassword("abc123")

See also: Protecting Layers