Squirrel/Server/Functions/Game/IsSSVBridgeUp
From Liberty Unleashed Wiki
(Difference between revisions)
(New page: __NOTOC__ {{Squirrel/LUOnly}} This function returns whether the lift bridge leading to Shoreside Vale is up or down. == Syntax == <code>bool IsSSVBridgeUp()</code> == Arguments == * ''...) |
m |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Squirrel/LUOnly}} | {{Squirrel/LUOnly}} | ||
− | This function returns whether the lift bridge leading to Shoreside Vale is up or down. | + | This function returns whether the lift bridge leading to Shoreside Vale is up (going up) or down (going down). |
== Syntax == | == Syntax == | ||
Line 13: | Line 13: | ||
== Example == | == Example == | ||
− | This command will tell the player | + | This command will tell the player the status of the SSV bridge when they type '/bridge'. |
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( plr, cmd, text ) | function onPlayerCommand( plr, cmd, text ) | ||
{ | { | ||
− | if ( cmd == " | + | if ( cmd == "bridge" ) |
{ | { | ||
if ( IsSSVBridgeUp() ) MessagePlayer( "Shoreside Vale bridge is currently up.", plr ); | if ( IsSSVBridgeUp() ) MessagePlayer( "Shoreside Vale bridge is currently up.", plr ); |
Revision as of 09:52, 28 November 2009
This function returns whether the lift bridge leading to Shoreside Vale is up (going up) or down (going down).
Syntax
bool IsSSVBridgeUp()
Arguments
- none
Example
This command will tell the player the status of the SSV bridge when they type '/bridge'.
function onPlayerCommand( plr, cmd, text ) { if ( cmd == "bridge" ) { if ( IsSSVBridgeUp() ) MessagePlayer( "Shoreside Vale bridge is currently up.", plr ); else MessagePlayer( "Shoreside Vale bridge is currently open.", plr ); } }
Notes
The function MessagePlayer and call onPlayerCommand were used in in this example. More info about them in corresponding pages.
Related Functions
- CloseGarage
- CloseSSVBridge
- EnableTrains
- GetBoundariesLower
- GetBoundariesUpper
- GetFriendlyFire
- GetGamespeed
- GetGravity
- GetHour
- GetIslands
- GetMinute
- GetSSVBridgeLock
- GetSSVBridgeUpdateTime
- GetSurfaceTraction
- GetTimeLock
- GetWeather
- GetWeatherLock
- IsSSVBridgeUp
- OpenGarage
- OpenSSVBridge
- SetBoundaries
- SetFriendlyFire
- SetGamespeed
- SetGravity
- SetIslands
- SetSSVBridgeLock
- SetSSVBridgeUpdateTime
- SetSurfaceTraction
- SetTime
- SetTimeLock
- SetWeather
- SetWeatherLock