#Class: AllowList experimental

Beta

Controls the allow list for the server. Only available on dedicated server.

#Properties

#enabled

enabled: boolean

World Mutation Beta

#Remarks

#Privilege

---

#entries

readonly entries: AllowListEntry[]

Beta

#Remarks

The list of entries in the allow list.

#Methods

#add()

add(playerDetails, ignorePlayerLimit?): void

World Mutation Beta

#Parameters

#playerDetails

any

Player or player name that should be added to the allow list.

#ignorePlayerLimit?

boolean

If true, the player will be allowed onto the server even if the server is at its player limit. Defaults to: false

#Returns

void

#Remarks

Adds a player to the server's allow list.

#Privilege

#Throws

This function can throw errors.

AllowListModificationError

InvalidArgumentError

InvalidEntityError

---

#clear()

clear(): void

World Mutation Beta

#Returns

void

#Remarks

Clears the allow list, removing all entries.

#Privilege

---

#contains()

contains(playerDetails): boolean

Beta

#Parameters

#playerDetails

any

Player or player name that should be checked for.

#Returns

boolean

#Remarks

Returns if the player is in the server's allow list.

#Throws

This function can throw errors.

InvalidArgumentError

InvalidEntityError

---

#reloadFile()

reloadFile(): void

World Mutation Beta

#Returns

void

#Remarks

Reloads the server's allow list from disk.

#Privilege

#Throws

This function can throw errors.

AllowListFileReloadError

---

#remove()

remove(playerDetails): void

World Mutation Beta

#Parameters

#playerDetails

any

Player or player name that should be removed from the allow list.

#Returns

void

#Remarks

Removes a player from the server's allow list.

#Privilege

#Throws

This function can throw errors.

AllowListModificationError

InvalidArgumentError

InvalidEntityError