SetCinematicBorder: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
No edit summary
No edit summary
 
Line 1: Line 1:
{{Scripting/Needs_Text}}
This function is used to set cinematic borders for the specific player.


== Syntax ==
== Syntax ==
Line 6: Line 6:
SetCinematicBorder( player, false );</pre>
SetCinematicBorder( player, false );</pre>


{{Scripting/Needs_Example}}
== Parameters ==
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] - ''Player'' to set borders for.
* ''bool'' - true/false.
 
== Example ==
In this example, we are going to set cinematic borders when a player joins and remove them when the player spawns.
 
<source lang = squirrel>
function onPlayerJoin( player )
{
SetCinematicBorder( player, true );
}
 
function onPlayerSpawn( player )
{
SetCinematicBorder( player, false );
}
</source>
 
== Notes ==
call [[onPlayerJoin]] and [[onPlayerSpawn]] were used in this example.
 
== Related Functions ==
{{Scripting/Squirrel/Functions/Player_Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Latest revision as of 19:40, 4 August 2017

This function is used to set cinematic borders for the specific player.

Syntax

SetCinematicBorder( player, true );
SetCinematicBorder( player, false );

Parameters

  • Player - Player to set borders for.
  • bool - true/false.

Example

In this example, we are going to set cinematic borders when a player joins and remove them when the player spawns.

function onPlayerJoin( player )
{
SetCinematicBorder( player, true );
}

function onPlayerSpawn( player )
{
SetCinematicBorder( player, false );
}

Notes

call onPlayerJoin and onPlayerSpawn were used in this example.

Related Functions

Player Game Functions

These functions exist for compatibility with the R2 Squirrel server.