Squirrel/Server/Functions/Players/ForceToSpawnScreen
From Liberty Unleashed Wiki
(Difference between revisions)
(Created page with '{{Squirrel/Title|Player.ForceToSpawnScreen}} This ''Player'' class member returns whether the player will be forced to the spawn screen next time they die. == Syntax == You can…') |
|||
Line 1: | Line 1: | ||
{{Squirrel/Title|Player.ForceToSpawnScreen}} | {{Squirrel/Title|Player.ForceToSpawnScreen}} | ||
− | This ''Player'' class member | + | This ''Player'' class member will force the player to the spawn screen. |
== Syntax == | == Syntax == | ||
− | + | <code>bool Player.ForceToSpawnScreen()</code> | |
− | + | ||
− | <code>bool Player.ForceToSpawnScreen | + | |
− | + | ||
== Arguments == | == Arguments == | ||
− | * ''' | + | * '''none''' |
− | == Example | + | == Example == |
<code lang="squirrel"> | <code lang="squirrel"> | ||
+ | This example sends the playe to the spawn screen when they type '/spawnscreen'. | ||
+ | |||
function onPlayerCommand( pPlayer, szCommand, szText ) | function onPlayerCommand( pPlayer, szCommand, szText ) | ||
{ | { | ||
if ( szCommand == "spawnscreen" ) | if ( szCommand == "spawnscreen" ) | ||
{ | { | ||
− | + | pPlayer.ForceToSpawnScreen(); | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
} | } | ||
Revision as of 19:04, 1 October 2010
This Player class member will force the player to the spawn screen.
Syntax
bool Player.ForceToSpawnScreen()
Arguments
- none
Example
This example sends the playe to the spawn screen when they type '/spawnscreen'. function onPlayerCommand( pPlayer, szCommand, szText ) { if ( szCommand == "spawnscreen" ) { pPlayer.ForceToSpawnScreen(); } return 1; }
Notes
The event onPlayerCommand was used in this example. More info about this in the corresponding page.
Related Functions
- FindPlayer
- GetClosestPlayer
- Player.Alpha
- Player.Angle
- Player.Armour
- Player.Cash
- Player.Class
- Player.ClearWeapons
- Player.Colour
- Player.ColouredName
- Player.EnterVehicle
- Player.ExitVehicle
- Player.ForceToSpawnScreen
- Player.Frozen
- Player.GetBoundariesLower
- Player.GetBoundariesUpper
- Player.GetIgnored
- Player.Health
- Player.ID
- Player.IP
- Player.Immune
- Player.Island
- Player.LUID
- Player.Marker
- Player.MarkerScale
- Player.MarkerSprite
- Player.Muted
- Player.Name
- Player.Nametag
- Player.NametagColour
- Player.Ping
- Player.Pos
- Player.RemoveFromVehicle
- Player.RemoveLimb
- Player.Score
- Player.SetAnim
- Player.SetBoundaries
- Player.SetIgnored
- Player.SetIgnoredBy
- Player.SetVehicleEnterDoor
- Player.SetWeapon
- Player.Skin
- Player.Spawn
- Player.Spawned
- Player.Team
- Player.Train
- Player.Vehicle
- Player.VehicleSeat
- Player.Velocity
- Player.VirtualWorld
- Player.WantedLevel
- Player.Weapon
- Player.SetWeapon
- Player.WeaponAmmo
- Player.WeaponState