This site has been archived and made available for preservation purposes. No edits can be made.

OnPlayerRequestGame

This is an old revision of this page, as edited 04-06-2012, 03:24 PM by foxtacles (contribs). It may differ significantly from the current revision.
Gets called when a Player requests to play on this server (before OnSpawn and after OnClientAuthenticate). It is recommended to make sure that every Player gets a unique vaultmp::Base.

[top]Declaration

<code cpp>
VAULTSCRIPT vaultmp::Base OnPlayerRequestGame(vaultmp::ID);
forward OnPlayerRequestGame(ID);
</code>

[top]Parameters

vaultmp::ID - the ID of the Player

[top]Return value

You have to return a vaultmp::Base. This is the model which will represent the Player in-game.

[top]Usage example (C++)

<code cpp>
vaultmp::Base VAULTSCRIPT OnPlayerRequestGame(vaultmp::ID player)
{
vaultmp::Base base = 0x00000000;
base = 0x00030D82; // Carter from Fallout 3
return base;
}
</code>