This site has been archived and made available for preservation purposes. No edits can be made.
OnPlayerRequestGame
(Difference between revisions)
Return to current revision
-
Gets called when a [wiki]Player[/wiki] requests to play on this server (before [wiki]OnSpawn[/wiki] and after [wiki]OnClientAuthenticate[/wiki]). It is recommended to make sure that every [wiki]Player[/wiki] gets a unique [wiki="Base"]Base[/wiki].
[h="2"] Declaration [/h]
[highlight=cpp]
VAULTSCRIPT VAULTSPACE Base OnPlayerRequestGame(VAULTSPACE ID) VAULTCPP(noexcept);
[/highlight]
[highlight=c]
forward OnPlayerRequestGame(ID);
[/highlight]
[h="2"] Parameters [/h]
[b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Player[/wiki]
[h="2"] Return value [/h]
You have to return a [wiki="Base"]Base[/wiki]. This is the model which will represent the [wiki]Player[/wiki] in-game. By returning zero, vaultmp will automatically choose a currently unused model.
[h="2"] Usage example (C++) [/h]
[highlight=cpp]
Base VAULTSCRIPT OnPlayerRequestGame(ID player)
{
-
-
Base base = static_cast<Base>(0x00030D82); // Carter from Fallout 3
-
+
Base base = static_cast<Base>(0x00000000); // let vaultmp choose
-
return base;
}
[/highlight]
[category]VaultMP interface[/category]
[category]Scripting callbacks[/category]
