GetVehiclePanelState: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | <!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getvehiclePanelState ( vehicle thevehicle, int panel ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 12: | Line 12: | ||
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | <!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | ||
*'''argumentName:''' description | *'''argumentName:''' description | ||
<!-- Only include this section below if there are optional arguments --> | <!-- Only include this section below if there are optional arguments --> | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
| Line 21: | Line 20: | ||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns ''true'' if blah, ''false'' otherwise. | *Returns ''true'' if blah, ''false'' otherwise. | ||
*returns state as integer for the panel | |||
==Example== | ==Example== | ||
| Line 37: | Line 37: | ||
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | <!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | ||
{{FunctionArea_functions}} | {{FunctionArea_functions}} | ||
[[Category:Incomplete]] -- leave this unless you complete the function | [[Category:Incomplete]] -- leave this unless you complete the function | ||
Revision as of 20:31, 13 April 2007
This fake function is for use with blah & blah and does blahblahblabhalbhl
Syntax
int getvehiclePanelState ( vehicle thevehicle, int panel )
Required Arguments
- argumentName: description
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- argumentName2: description
- argumentName3: description
Returns
- Returns true if blah, false otherwise.
- returns state as integer for the panel
Example
This example does...
--This line does... blabhalbalhb --abababa --This line does this... mooo
See Also
Template:FunctionArea functions -- leave this unless you complete the function