Module pilotoutfit
Lua bindings to interact with pilot outfits.
Functions
| clear (po) | Clears all the temporary ship stat modifiers of the pilot outfit. |
| id (po) | Gets the ID of an outfit slot. |
| munition (po, p[, o=po:outfit()[, t=nil[, dir=p:dir()[, pos=p:pos()[, vel=p:vel()[, noaim=false]]]]]]) | Creates a munition. |
| outfit (po) | Gets the outfit of the PilotOutfit. |
| progress (po, progress) | Sets the state progress of the PilotOutfit. |
| set (po, mod, val) | Sets a temporary ship stat modifier of the pilot outfit. |
| shoot (po, p[, t=nil[, stagger=false]]) | Shoots at an object. |
| slot (po) | Gets the properties of the outfit slot. |
| state (po, state) | Sets the state of the PilotOutfit. |
Functions
- clear (po)
-
Clears all the temporary ship stat modifiers of the pilot outfit.
Parameters:
- po PilotOutfit Pilot outfit to clear temporary modifiers from.
- id (po)
-
Gets the ID of an outfit slot.
Parameters:
- po PilotOutfit Pilot outfit to get ID of.
Returns:
-
integer
The corresponding ID.
- munition (po, p[, o=po:outfit()[, t=nil[, dir=p:dir()[, pos=p:pos()[, vel=p:vel()[, noaim=false]]]]]])
-
Creates a munition.
Parameters:
- po PilotOutfit Pilot outfit originating the munition.
- p Pilot Pilot generating the munition, used for faction and damaging purposes.
- o Outfit Outfit to be used as a reference for the munition. (default po:outfit())
- t Pilot, Munition, Asteroid or nil Target pilot to shoot at. (default nil)
- dir number Direction the munition should face. (default p:dir())
- pos Vec2 Position to create the munition at. (default p:pos())
- vel Vec2 Initial velocity of the munition. The munition's base velocity gets added to this. (default p:vel())
- noaim boolean Whether or not to disable the tracking and aiming framework when shooting. (default false)
Returns:
-
Munition
The newly created munition.
- outfit (po)
-
Gets the outfit of the PilotOutfit.
Parameters:
- po PilotOutfit Pilot outfit to get the outfit of.
Returns:
-
Outfit
Outfit corresponding to the Pilot outfit.
- progress (po, progress)
-
Sets the state progress of the PilotOutfit.
Parameters:
- po PilotOutfit Pilot outfit to set the state of.
- progress number Progress of the current state with 1 being started and 0 being done.
- set (po, mod, val)
-
Sets a temporary ship stat modifier of the pilot outfit.
Parameters:
- po PilotOutfit Pilot outfit to set the modifier of.
- mod string Modifier name to set to. Same as in the XML definition.
- val number Value to set the modifier to. In the case of booleans, 0 indicates false, while 1 indicates true.
- shoot (po, p[, t=nil[, stagger=false]])
-
Shoots at an object.
Parameters:
- po PilotOutfit Pilot outfit originating the munition.
- p Pilot Pilot shooting, used for faction and damaging purposes.
- t Pilot, Munition, Asteroid or nil Target pilot to shoot at. (default nil)
- stagger boolean Whether or not to stagger similar outfits. (default false)
Returns:
-
boolean
true if was able to shoot, false otherwise.
- slot (po)
-
Gets the properties of the outfit slot.
exclusive=boolean, locked=boolean} (string in English)
Parameters:
- po PilotOutfit Pilot outfit to get the outfit of.
Returns:
-
{size=string, type=string, property=string, required=boolean,
- state (po, state)
-
Sets the state of the PilotOutfit.
Note on setting state("on"): this will bypass and ignore the weapon sets so you can set an outfit on in the update(...) function and it will be set as on until it is toggled off or the state is changed. A single exception is when it is set as "on" during an ontoggle(...) function call that returns true. In that case, it will behave like non-Lua outfits and be turned off whenever it is toggled off again.
Parameters:
- po PilotOutfit Pilot outfit to set the state of.
- state string State to set the pilot outfit to. Can be either "off", "warmup", "on", or "cooldown".