User:Flozi

From Spring
Revision as of 22:06, 15 June 2016 by Flozi (talk | contribs) (→Template:Tag: courier is too thin, try lucida)
Jump to navigationJump to search

My User Subpages

Scratchpad

Template:Tag

bool burnblow   default: false   lua: selfExplode

Does the weapon explode when it reaches its maximum range or continue on its path? The name is an OTAism.

float range   default: 10.0

The maximum range in elmos that the weapon can fire at.

float weaponVelocity   default: 0.0

The velocity in elmos per second of the weapon projectile. Since 99.0 maxVelocity is a synonym.

Template:API proposal

Note that the number of 'arg1' etc is fixed (i.e. 10) but can be omitted without issue. the 'type' template is just a way to make inserting different styles within the param list easier, Template:Pipe already exists and is required as it is a special char within mediawiki syntax, could use {{!}} as a shorter alternative to pipe.

{{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.

TODO:

Major

Minor

Undocumented Features

Template:LuaCallout Examples

{{{prefix}}}UseTeamResource ( {{{arg1}}}, {{{arg2}}}, {{{arg3}}}, {{{arg4}}}, {{{arg5}}}, {{{arg6}}}, {{{arg7}}}, {{{arg8}}}, {{{arg9}}} )
return: nil | bool hadEnough