Template:LuaCallout: Difference between revisions
From Spring
Jump to navigationJump to search
falafel |
m Added description |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{{ | <includeonly>{{prefix|{{{prefix}}}}}{{name|{{anchor|{{{name}}}}}[[#{{{name}}}|{{{name}}}]]}} | ||
( {{var|1= | |||
{{#if: {{{arg1}}} | {{{arg1}}} | }}{{#if: {{{arg2}}} |, | }} | |||
{{#if: {{{arg2}}} | {{{arg2}}} | }}{{#if: {{{arg3}}} |, | }} | |||
{{#if: {{{arg3}}} | {{{arg3}}} | }}{{#if: {{{arg4}}} |, | }} | |||
{{#if: {{{arg4}}} | {{{arg4}}} | }}{{#if: {{{arg5}}} |, | }} | |||
{{#if: {{{arg5}}} | {{{arg5}}} | }}{{#if: {{{arg6}}} |, | }} | |||
{{#if: {{{arg6}}} | {{{arg6}}} | }}{{#if: {{{arg7}}} |, | }} | |||
{{#if: {{{arg7}}} | {{{arg7}}} | }}{{#if: {{{arg8}}} |, | }} | |||
{{#if: {{{arg8}}} | {{{arg8}}} | }}{{#if: {{{arg9}}} |, | }} | |||
{{#if: {{{arg9}}} | {{{arg9}}} | }} | |||
}} ) | |||
{{#if: {{{return|}}}|<br>return: {{var|1={{{return}}}}}|}} | |||
:{{#if: {{{info|}}} | {{{info}}} | }}</includeonly><noinclude> | |||
==Lua Callout usage example== | |||
This template creates an anchored entry meant for Lua functions. It allows for a function prefix, funtion name, up to 9 function argument slots, info about the returned variable(s) and a description. | |||
<pre> | |||
{{LuaCallout | |||
|prefix = Spring. | |||
|name = UseTeamResource | |||
|arg1 = {{type|number}} teamID | |||
|arg2 = {{type|string}} "metal" {{pipe}} "energy" | |||
|arg3 = {{type|number}} amount {{pipe}} { metal = {{type|number}} amount, energy = {{type|number}} amount } | |||
|arg4 = | |||
|arg5 = | |||
|arg6 = | |||
|arg7 = | |||
|arg8 = | |||
|arg9 = | |||
|return = {{type|nil}} {{pipe}} {{type|bool}} hadEnough | |||
|info = Imposes a one-off usage of resources on the given team. The return value indicates whether or not the team had sufficient resources to meet the usage demand. | |||
}}</pre> | |||
{{LuaCallout | {{LuaCallout | ||
| | |prefix = Spring. | ||
|name = UseTeamResource | |name = UseTeamResource | ||
| | |arg1 = {{type|number}} teamID | ||
|return = nil | bool hadEnough | |arg2 = {{type|string}} "metal" {{pipe}} "energy" | ||
| | |arg3 = {{type|number}} amount {{pipe}} { metal = {{type|number}} amount, energy = {{type|number}} amount } | ||
</noinclude> | |arg4 = | ||
|arg5 = | |||
|arg6 = | |||
|arg7 = | |||
|arg8 = | |||
|arg9 = | |||
|return = {{type|nil}} {{pipe}} {{type|bool}} hadEnough | |||
|info = Imposes a one-off usage of resources on the given team. The return value indicates whether or not the team had sufficient resources to meet the usage demand. | |||
}}</noinclude> | |||
Latest revision as of 22:19, 28 February 2021
Lua Callout usage example
This template creates an anchored entry meant for Lua functions. It allows for a function prefix, funtion name, up to 9 function argument slots, info about the returned variable(s) and a description.
{{LuaCallout
|prefix = Spring.
|name = UseTeamResource
|arg1 = {{type|number}} teamID
|arg2 = {{type|string}} "metal" {{pipe}} "energy"
|arg3 = {{type|number}} amount {{pipe}} { metal = {{type|number}} amount, energy = {{type|number}} amount }
|arg4 =
|arg5 =
|arg6 =
|arg7 =
|arg8 =
|arg9 =
|return = {{type|nil}} {{pipe}} {{type|bool}} hadEnough
|info = Imposes a one-off usage of resources on the given team. The return value indicates whether or not the team had sufficient resources to meet the usage demand.
}}
Spring.UseTeamResource
( number teamID,
string "metal" | "energy",
number amount | { metal = number amount, energy = number amount } )
return: nil | bool hadEnough
- Imposes a one-off usage of resources on the given team. The return value indicates whether or not the team had sufficient resources to meet the usage demand.
