VoidExpanse/Consumable scripting - Revision history

Ai enabled: /* Consumables Scripting */

2015-04-20T08:08:45Z

Consumables Scripting

← Older revision		Revision as of 08:08, 20 April 2015
Line 23:		Line 23:
	}		}
	</pre>		</pre>
			(Please note: OnInit() method is executed only for Global and Internal scripts)

	After that, every time a player uses a consumable with the xml-id "consumable_ballistic_ammo", function "onBallisticAmmoConsumableUsed" will be called.		After that, every time a player uses a consumable with the xml-id "consumable_ballistic_ammo", function "onBallisticAmmoConsumableUsed" will be called.

Atomic-admin at 08:09, 6 January 2015

2015-01-06T08:09:21Z

← Older revision		Revision as of 08:09, 6 January 2015
Line 1:		Line 1:
			{{Draft}}

	== Consumables Scripting ==		== Consumables Scripting ==

Line 38:		Line 40:

	That's all, now we have a consumable that refills ammo the of all ballistic weapons!		That's all, now we have a consumable that refills ammo the of all ballistic weapons!

			{{Modding}}

Tjmonk15: Grammar, punctuation, phrasing edits.

2014-07-25T03:16:09Z

Grammar, punctuation, phrasing edits.

← Older revision		Revision as of 03:16, 25 July 2014
Line 1:		Line 1:
	== Consumables Scripting ==		== Consumables Scripting ==

	In most cases, standard xml-structures are more ~~then~~ enough to implement consumable ~~effect~~. However, if we need		In most cases the standard xml-structures are more than enough to implement consumable effects. However, if we need
	to do something special, for example, restock ammo, self-destruct, teleport or kill all ships in front of ~~ship~~, you~~'ll~~ need scripts.		to do something special, for example, restock ammo, self-destruct, teleport or kill all ships in front of the player, you will need scripts.

	There are no hard rules ~~about~~ consumables ~~scripting. Here~~ are just a couple of tips.		There are no hard rules for scripting consumables, here are just a couple of tips.
	For example, we need to create a consumable, that refills ammo in all ballistic weapons.		For example, if we need to create a consumable that refills ammo in all of the players ballistic weapons.
	First of all, we need to create ~~an empty~~ consumable xml~~. Under "~~empty~~" I mean with no~~ effects.		First of all, we need to create a basic consumable xml, with an empty effects node.
	<pre>		<pre>
	<effects>		<effects>
Line 13:		Line 13:
	</pre>		</pre>

	Then, you create a new global script in folder /scripts/globals/, in which you ~~hooks~~ some function to a special trigger:		Then, you create a new global script in folder /scripts/globals/, in which you hook some function to a special trigger:
	<pre>		<pre>
	function OnInit()		function OnInit()
Line 21:		Line 21:
	}		}
	</pre>		</pre>
	After ~~then~~, every time ~~you use~~ consumable with xml-id "consumable_ballistic_ammo", function "onBallisticAmmoConsumableUsed" will be called.		After that, every time a player uses a consumable with the xml-id "consumable_ballistic_ammo", function "onBallisticAmmoConsumableUsed" will be called.

	Now, all that's left is to implement ammo refill:		Now, all that's left is to implement the actual ammo refill:
	<pre>		<pre>
	function onBallisticAmmoConsumableUsed( args )		function onBallisticAmmoConsumableUsed( args )
Line 37:		Line 37:
	</pre>		</pre>

	That's all, now we have consumable, that refills ammo of ballistic weapons!		That's all, now we have a consumable that refills ammo the of all ballistic weapons!

Damonwall: Created page with "== Consumables Scripting == In most cases, standard xml-structures are more then enough to implement consumable effect. However, if we need to do something special, for examp..."

2014-03-07T10:27:01Z

Created page with "== Consumables Scripting == In most cases, standard xml-structures are more then enough to implement consumable effect. However, if we need to do something special, for examp..."

New page

== Consumables Scripting ==

In most cases, standard xml-structures are more then enough to implement consumable effect. However, if we need
to do something special, for example, restock ammo, self-destruct, teleport or kill all ships in front of ship, you'll need scripts.

There are no hard rules about consumables scripting. Here are just a couple of tips.
For example, we need to create a consumable, that refills ammo in all ballistic weapons.
First of all, we need to create an empty consumable xml. Under "empty" I mean with no effects.
<pre>
<effects>

</effects>
</pre>

Then, you create a new global script in folder /scripts/globals/, in which you hooks some function to a special trigger:
<pre>
function OnInit()
{
actions.BindToTrigger("onConsumableUsed", "onBallisticAmmoConsumableUsed",
{id: "consumable_ballistic_ammo"});
}
</pre>
After then, every time you use consumable with xml-id "consumable_ballistic_ammo", function "onBallisticAmmoConsumableUsed" will be called.

Now, all that's left is to implement ammo refill:
<pre>
function onBallisticAmmoConsumableUsed( args )
{
var ballisticWeapons = ship.GetWeaponsOfType( args.ship_id, 2 );
if(ballisticWeapons == null) return;

for(var i =0; i < ballisticWeapons.length; i++)
{
ship.RefillAmmoForWeapon( args.ship_id, ballisticWeapons[i] );
}
}
</pre>

That's all, now we have consumable, that refills ammo of ballistic weapons!