Squirrel/BlankFunctionPage
From Liberty Unleashed Wiki
(Difference between revisions)
(New page: __NOTOC__ <!-- Write a short description about the function. If the function returns any special values these should also be mentioned here. --> == Syntax == <!-- List the function param...) |
m |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- Write a short description about the function. If the function returns any special values these should also be mentioned here. --> | <!-- Write a short description about the function. If the function returns any special values these should also be mentioned here. --> | ||
+ | This function does nothing special. This function always returns false. | ||
== Syntax == | == Syntax == | ||
<!-- List the function parameters/syntax here: --> | <!-- List the function parameters/syntax here: --> | ||
− | + | <code>return_type FunctionName( param_1_type param1, param_2_type param2, ... )</code> | |
<!-- If this is an instance variable for a class (for example Player, Vehicle...), which can be used to set/return values use the following syntax: --> | <!-- If this is an instance variable for a class (for example Player, Vehicle...), which can be used to set/return values use the following syntax: --> | ||
<!-- <code>return_type classname.Variable | <!-- <code>return_type classname.Variable | ||
− | |||
classname.Variable = param_type value --> | classname.Variable = param_type value --> | ||
== Arguments == | == Arguments == | ||
− | |||
<!-- The list of parameters the function allows - One parameter per line. For example: --> | <!-- The list of parameters the function allows - One parameter per line. For example: --> | ||
− | + | * '''param1''' - This is parameter 1<!-- If the function has no parameters, add *'''None''' --> | |
− | + | ||
− | <!-- If the function has no parameters, add *'''None''' --> | + | |
== Example == | == Example == | ||
<!-- Write a simple example here with a description. --> | <!-- Write a simple example here with a description. --> | ||
+ | <!-- If this is an instance variable for a class (for example Player, Vehicle...), which can be used to set/return values, replace == Example == with separate examples for getting the value and setting the value. --> | ||
− | < | + | <code lang="squirrel"> |
+ | // [EXAMPLE HERE] | ||
− | + | function onFoo() | |
+ | { | ||
+ | Bar(); | ||
+ | } | ||
+ | </code> | ||
<!-- If you added an example, remove the following line so that this page is removed from the Needs example list. Otherwise leave it there. --> | <!-- If you added an example, remove the following line so that this page is removed from the Needs example list. Otherwise leave it there. --> | ||
Line 33: | Line 36: | ||
<!-- List possible notes for the example. At least list the functions/events used in the example here. For example: --> | <!-- List possible notes for the example. At least list the functions/events used in the example here. For example: --> | ||
− | + | The function [[link/to/the/function|Bar]] was used in in this example. More info about this in the corresponding page. | |
== Related Functions == | == Related Functions == | ||
<!-- Change this template link to correspond with this page. --> | <!-- Change this template link to correspond with this page. --> | ||
− | + | {{Squirrel/Server/ExampleList}} |
Revision as of 04:28, 14 November 2009
This function does nothing special. This function always returns false.
Syntax
return_type FunctionName( param_1_type param1, param_2_type param2, ... )
Arguments
- param1 - This is parameter 1
Example
// [EXAMPLE HERE] function onFoo() { Bar(); }
This function needs an example. You can help us complete the wiki by writing one, or maybe even more :o
Notes
The function Bar was used in in this example. More info about this in the corresponding page.
Related Functions
- BlankFunctionPage
- FooBar
- Sandbox
- Scripting Issues