V5 DocsAthena.controllers.dynamicDoors.interfaces.DoorInfo ​
server/controllers/dynamicDoors/interfaces.DoorInfo
Properties ​
afterEnter ​
• Optional afterEnter: (player: Player, doorInfo: DoorInfo) => void
Type declaration ​
Usage
Athena.controllers.dynamicDoors.interfaces.DoorInfo.(player, doorInfo): void
A callback to trigger when entering through the door.
Memberof
DoorInfo
Parameters ​
| Name | Type |
|---|---|
player | Player |
doorInfo | DoorInfo |
Returns ​
void
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:98
allowVehicles ​
• Optional allowVehicles: true
Set this to true to allow vehicles to move through the door.
Memberof
DynamicDoor
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:19
beforeEnter ​
• Optional beforeEnter: (player: Player, doorInfo: DoorInfo) => boolean
Type declaration ​
Usage
Athena.controllers.dynamicDoors.interfaces.DoorInfo.(player, doorInfo): boolean
Trigger a callback before opening.
Return true if permitted to enter the door.
Otherwise, return false to prevent player from entering the door.
Memberof
DoorInfo
Parameters ​
| Name | Type |
|---|---|
player | Player |
doorInfo | DoorInfo |
Returns ​
boolean
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:91
dimension ​
• Optional dimension: number
If a dimension is specified, it will be used.
Otherwise the door is available everywhere.
The dimension to set when using this door.
Memberof
DoorInfo
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:39
ipl ​
• Optional ipl: string
An IPL to load when the door is triggered
Memberof
DoorInfo
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:56
iplUnload ​
• Optional iplUnload: string
An IPL to unload when the door is triggered
Memberof
DoorInfo
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:64
marker ​
• Optional marker: Marker
A marker to generate for the door.
Memberof
DoorInfo
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:48
pos ​
• pos: IVector3
Automatically subtracts 1 on creation.
Memberof
DoorInfo
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:11
text ​
• Optional text: string
A label for the door, will create a text label if present.
Memberof
DoorInfo
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:27
ytyp ​
• Optional ytyp: string
A YTYP to load when the door is triggered.
Memberof
DoorInfo
Defined in ​
server/controllers/dynamicDoors/interfaces.ts:72
ytypUnload ​
• Optional ytypUnload: string
A YTYP to unload when the door is triggered.
Memberof
DoorInfo