Template:API: Difference between revisions
From Spring
Jump to navigationJump to search
draft #1 |
m #2 |
||
| Line 1: | Line 1: | ||
<includeonly>{{prefix|{{{prefix}}}}}{{name|{{{name}}}}}{{var|1=({{{args}}})}} | <includeonly>{{prefix|{{{prefix}}}}}{{name|{{{name}}}}}{{var|1=({{{args}}})}} | ||
{{#if: {{{return|}}}|return: {{var|1={{{return}}}}}|}} | {{#if: {{{return|}}}|return: {{var|1={{{return}}}}}|}}{{#if: {{{output|}}}|{{var|1=-> {{{output}}}}}|}} | ||
{{#if: {{{output|}}}|{{var|1=-> {{{output}}}}}|}} | |||
:{{{info}}} | :{{{info}}} | ||
| Line 8: | Line 7: | ||
{{API | {{API | ||
|prefix = Spring | |prefix = Spring. | ||
|name = UseTeamResource | |name = UseTeamResource | ||
|args = {{type|number}} teamID, {{type|string}} {{value|"metal"}} {{pipe}} {{value|"energy"}}, {{type|number}} amount {{pipe}} { metal = {{type|number}} amount, energy = {{type|number}} amount } | |args = {{type|number}} teamID, {{type|string}} {{value|"metal"}} {{pipe}} {{value|"energy"}}, {{type|number}} amount {{pipe}} { metal = {{type|number}} amount, energy = {{type|number}} amount } | ||
Revision as of 22:31, 16 June 2016
Spring.UseTeamResource(number teamID, string "metal" | "energy", number amount | { metal = number amount, energy = number amount })
-> 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.
{{API <!-- Callout example -->
|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 }
|output = {{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 })
-> nil | bool hadEnough
- Deduct the specified amount from the team's metal or energy resource.
vs.
{{API <!-- Callin example -->
|prefix = addon <!-- May use gadget: instead? -->
|name = AllowUnitTransfer
|arg1 = {{type|number}} unitID
|arg2 = {{type|number}} unitDefID
|arg3 = {{type|number}} oldTeam
|arg4 = {{type|number}} newTeam
|arg5 = {{type|bool}} capture
|return = {{type|bool}} allow <!-- note that this is a different entry than output above -->
|info = Called just before a unit is transferred to a different team, the boolean return value determines whether or not the transfer is permitted.
}}
addon.AllowUnitTransfer(number unitID, number unitDefID, number oldTeam,
number newTeam, bool capture)
return: bool allow
- Called just before a unit is transferred to a different team, the boolean return value determines whether or not the transfer is permitted.