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"]vaultmp::Base[/wiki].
[h="2"] Declaration [/h]
<code cpp>
VAULTSCRIPT vaultmp::Base OnPlayerRequestGame(vaultmp::ID);
forward OnPlayerRequestGame(ID);
</code>
[h="2"] Parameters [/h]
[b][wiki="ID"]vaultmp::ID[/wiki][/b] - the ID of the [wiki]Player[/wiki]
[h="2"] Return value [/h]
You have to return a [wiki="Base"]vaultmp::Base[/wiki]. This is the model which will represent the [wiki]Player[/wiki] in-game.
[h="2"] Usage example (C++) [/h]
<code cpp>
vaultmp::Base VAULTSCRIPT OnPlayerRequestGame(vaultmp::ID player)
{
vaultmp::Base base = 0x00000000;
base = 0x00030D82; // Carter from Fallout 3
return base;
}
</code>
[category]VaultMP interface[/category]
[category]Scripting callbacks[/category]