Squirrel/Server/Functions/Players/ForceToSpawnScreen

Revision as of 18:38, 1 October 2010

This Player class member returns whether the player will be forced to the spawn screen next time they die.

Syntax

You can either return or set a new value using this member:

bool Player.ForceToSpawnScreen

Player.ForceToSpawnScreen = bool force

Arguments

• force - A boolean representing whether the player is being forced to the spawn screen (true) or simply respawning (false)

Example 1. Returning

 
function onPlayerCommand( pPlayer, szCommand, szText )
{
	if ( szCommand == "spawnscreen" )
	{
		MessagePlayer( "Your force to spawn screen state is currently set to " + pPlayer.ForceToSpawnScreen, pPlayer );
	}
	
	return 1;
}
 

Notes

The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

Example 2. Setting

 
function onPlayerCommand( pPlayer, szCommand, szText )
{
	if ( szCommand == "spawnscreen2" )
	{
		pPlayer.ForceToSpawnScreen = true;
	}
	
	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