Template:API: Difference between revisions

From Spring
Jump to navigationJump to search
← Older editNewer edit →
Flozi (talk | contribs)
0 edits
no break if no return or output
Flozi (talk | contribs)
0 edits
m remove callin example now
Line 3: Line 3:
:{{{info}}}
:{{{info}}}
</includeonly><noinclude>
</includeonly><noinclude>
{{API
|prefix = Spring.
|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 }
|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.
}}


<pre>
<pre>
Line 28: Line 20:


:Deduct the specified amount from the team's metal or energy resource.
:Deduct the specified amount from the team's metal or energy resource.
vs.
<pre>
{{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.
}}</pre>
{{prefix|addon.}}{{name|AllowUnitTransfer}}{{var|1=({{type|number}} unitID, {{type|number}} unitDefID, {{type|number}} oldTeam,
{{type|number}} newTeam, {{type|bool}} capture)}}
return: {{var|{{type|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.</noinclude>

Revision as of 15:10, 18 June 2016


{{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.
Retrieved from "https://springrts-wiki.p2004a.com/mediawiki/index.php?title=Template:API&oldid=22314"