#
V3 API
Control madness? Check.
This is a technical page, and assumes familiarity with Roblox Studio's Explorer, alongside with Roblox's scripting language, Luau.
DWProx V3 is our most advanced Access Control System, a system like this needs a robust API, so we made one.
This page goes over the DWProxGAPI BindableEvent (Global API)
and DWPROXAPI BindableFunction (Local/Per-Door API; yes, in all-caps).
#
DWProxGAPI
Located directly in Replicated Storage after game start-up, the Global API controls all V3 doors.
For this to work, you need to enable GAPI settings inside the per-door configuration module. (See Configuration for more information.)
The syntax is as follows:
game["ReplicatedStorage"].DWProxGAPI:Fire(Function, Argument)What do these mean?
- Function: (
string) Function for all doors to execute. - Argument: (
any?) Any additional parameters.
GAPI's function list is as follows:
"FIRE": Fire detected mode. (Expects a boolean as Argument)"LOCK": Locks all doors. (Expects a boolean as Argument)"HOLD": Keeps all doors open. (Expects a boolean as Argument)"RESETRELEASES": Resets all releases."OPEN": Opens all doors. (Expects a number as Argument, for how long keep the doors open.)
If no argument is provided, it'll toggle the API. Or in case of "OPEN", it'll use the default time set in per-door configuration module.
game["ReplicatedStorage"].DWProxGAPI:Fire("OPEN", 16)
#
DWPROXAPI
Each V3 door has its own DWPROXAPI after game start-up, or Local API ("LAPI"), used to control the door. The LAPI is identical to the GAPI in terms of functionality.
["DWProx"].DWPROXAPI:Invoke(Function, Argument)What do these mean?
- Function: (
string) Function for all doors to execute. - Argument: (
any?) Any additional parameters.
LAPI's function list is as follows:
"FIRE": Fire detected mode. (Expects a boolean as Argument)"LOCK": Locks all doors. (Expects a boolean as Argument)"HOLD": Keeps all doors open. (Expects a boolean as Argument)"RESETRELEASES": Resets all releases."OPEN": Opens all doors. (Expects a number as Argument, for how long keep the doors open.)
If no argument is provided, it'll toggle the API. Or in case of "OPEN", it'll use the default time set in per-door configuration module.
["DWProx"].DWPROXAPI:Invoke("FIRE", true)Something's unclear? Visit our FAQ Page for help, or contact Whitehill Support via our Discord server for further assistance.