Help
Remember Me?
Home
Forum
Download
Scripting docs
Wiki
Main
Special Pages
Books
Recent Changes
Blogs
Wiki
Main
OnClientAuthenticate
This site has been archived and made available for preservation purposes. No edits can be made.
If this is your first visit, be sure to check out the
FAQ
by clicking the link above. You may have to
register
before you can post: click the register link above to proceed. To start viewing messages, select the forum that you want to visit from the selection below.
article
discussion
source
history
Viewing source for:
OnClientAuthenticate
Gets called when a client attempts to connect to the server. [h="2"] Declaration [/h] [highlight=cpp] VAULTSCRIPT VAULTSPACE State OnClientAuthenticate(VAULTSPACE cRawString, VAULTSPACE cRawString) VAULTCPP(noexcept); [/highlight] [highlight=c] forward OnClientAuthenticate(const name{}, const pwd{}); [/highlight] [h="2"] Parameters [/h] [image]Authenticate.png|right|thumb|This is what gets passed to the callback[/image] [b][wiki]cRawString[/wiki][/b] - the name of the client (guaranteed to be at least 3 and at maximum [wiki]MAX_PLAYER_NAME[/wiki] characters long) [b][wiki]cRawString[/wiki][/b] - the password of the client (guaranteed to be at maximum [wiki]MAX_PASSWORD_SIZE[/wiki] characters long) [h="2"] Return value [/h] If returned [wiki]True[/wiki], the client is allowed to connect and play on this server. If returned [wiki]False[/wiki], the client gets kicked (authentication denied). [h="2"] Usage examples[/h] [highlight=cpp] State VAULTSCRIPT OnClientAuthenticate(cRawString name, cRawString pwd) { return True; // Everybody is allowed to connect } [/highlight] [highlight=c] public OnClientAuthenticate(const name {}, const pwd {}) { return true; // Everybody is allowed to connect } [/highlight] [category]VaultMP interface[/category] [category]Scripting callbacks[/category]