Squirrel/Server/Functions/Game/CloseGarage

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
 
Line 10: Line 10:
 
* '''garage''' - This is the ID of the garage you want to close. List of garage IDs can be found from [[Squirrel/Server/Constants#Garages|here]]
 
* '''garage''' - This is the ID of the garage you want to close. List of garage IDs can be found from [[Squirrel/Server/Constants#Garages|here]]
  
−
== Example ==
+
== Example I ==
  
 
This will close the Portland hideout garage when the player types /closesesame
 
This will close the Portland hideout garage when the player types /closesesame
Line 22: Line 22:
 
}
 
}
 
 
 +
return 1;
 +
}
 +
</code>
 +
 +
== Example II ==
 +
 +
This will close an garage by ID. List of garage IDs can be found from [[Squirrel/Server/Constants#Garages|here]]
 +
<code lang="squirrel">
 +
function onPlayerCommand ( pPlayer, szCommand, szParams )
 +
{
 +
if ( szCommand == "closegarage" )
 +
{
 +
if ( !szParams ) MessagePlayer ( "You need to write the ID of the garage to close.", pPlayer );
 +
else CloseGarage ( szParams.tointeger ( ) );
 +
}
 +
 
return 1;
 
return 1;
 
}
 
}

Latest revision as of 23:57, 15 November 2013

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function closes the given garage door. List of garage IDs can be found from here.

[edit] Syntax 

  1. bool CloseGarage( int garage )

[edit] Arguments

  • garage - This is the ID of the garage you want to close. List of garage IDs can be found from here

[edit] Example I

This will close the Portland hideout garage when the player types /closesesame 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "closesesame" )
  5. 	{
  6. 		CloseGarage( PORTLAND_HIDEOUT_GARAGE );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Example II

This will close an garage by ID. List of garage IDs can be found from here 

  1.  
  2. function onPlayerCommand ( pPlayer, szCommand, szParams )
  3. {
  4. 	if ( szCommand == "closegarage" )
  5. 	{
  6. 		if ( !szParams ) MessagePlayer ( "You need to write the ID of the garage to close.", pPlayer );
  7. 		else CloseGarage ( szParams.tointeger ( ) );
  8. 	}
  9.  
  10. 	return 1;
  11. }
  12.  

[edit] Notes

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

[edit] Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Game/CloseGarage&oldid=41303"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox