Squirrel/Server/Functions/Players/Spawn

Latest revision as of 00:31, 25 October 2010

This function forces a player to spawn.

bool Player.Spawn( [ SpawnClass spawn ] )

spawn - This is an optional pointer to a spawn class which you wish the player to use. If this argument is not used the player will use their current class

This command will make yourself spawn.

 
function onPlayerCommand( player, cmd, text )
{
    if ( cmd == "spawnme" )
    {
        player.Spawn();
    }
    
    return 1;
}

The call onPlayerCommand was used in in this example. More info about this in the corresponding page.

@@ Line 1: / Line 1: @@
 {{Squirrel/Title|Player.Spawn}}
 This function forces a player to spawn.
+== Syntax ==
+<code>bool Player.Spawn( [ SpawnClass spawn ] )</code>
 == Arguments ==
-* ''' player ''' - The player to be spawned.
+* '''spawn''' - This is an optional pointer to a spawn class which you wish the player to use. If this argument is not used the player will use their current class
 == Example ==