VoidExpanse/scope-ship - Revision history

Ai enabled: /* List of functions */

2015-04-20T09:22:09Z

List of functions

← Older revision		Revision as of 09:22, 20 April 2015
Line 17:		Line 17:
	* int: quantity - amount added		* int: quantity - amount added
	* string: type - "item" or "resource"\|		* string: type - "item" or "resource"\|
	<pre style="margin:0px;">var obj = ship.~~Add~~(24556, "SomeItem2", 5);</pre> \|		<pre style="margin:0px;">var obj = ship.AddItem(24556, "SomeItem2", 5);</pre> \|
	Adds item to ship's inventory.		Adds item to ship's inventory.
	}}		}}

Atomic-admin at 04:38, 15 August 2014

2014-08-15T04:38:59Z

← Older revision		Revision as of 04:38, 15 August 2014
Line 152:		Line 152:
	bool: if player's ship has item of specified type\|		bool: if player's ship has item of specified type\|
	<pre style="margin:0px;">var hasItem = ship.HasItemOfType(24556, "SomeItem1");</pre> \|		<pre style="margin:0px;">var hasItem = ship.HasItemOfType(24556, "SomeItem1");</pre> \|
			Useful in quests.
			}}

			{{Scripting_api\|HasItemOfTypeEquipped\|
			* int: ship_id
			* string: item_id\|
			bool: if player's ship has item of specified type equipped\|
			<pre style="margin:0px;">var hasItem = ship.HasItemOfTypeEquipped(24556, "SomeItem1");</pre> \|
	Useful in quests.		Useful in quests.
	}}		}}
Line 286:		Line 294:
	<pre style="margin:0px;">var skills = ship.GetSkills(24556);</pre> \|		<pre style="margin:0px;">var skills = ship.GetSkills(24556);</pre> \|
	Returns all current skills of ship.		Returns all current skills of ship.
			}}

			{{Scripting_api\|GetSkill\|
			* int: ship_id
			* string: skill_id\|
			* int: skill level (or 0 if no skill)\|
			<pre style="margin:0px;">var skill = ship.GetSkill(24556,"some_skill_1");</pre> \|
			Returns level of specified skill, or 0 if the ship doesn't have that skill.
	}}		}}

Line 301:		Line 317:
	}}		}}

	{{Scripting_api\|~~GetTags~~\|		{{Scripting_api\|GetTag\|
	* int: ship_id\|		* int: ship_id
	~~object~~: ~~tags~~ of a ~~ship~~\|		* string: tag_id\|
	<pre style="margin:0px;">var ~~tags~~ = ship.~~GetTags~~(24556);</pre> \|		string: value of a tag or null\|
			<pre style="margin:0px;">var value = ship.GetTag(24556,"qwe");</pre> \|
	}}		}}

Line 524:		Line 541:
	<pre style="margin:0px;">var dmg = ship.SetDamageByShip(24556, 44535);</pre> \|		<pre style="margin:0px;">var dmg = ship.SetDamageByShip(24556, 44535);</pre> \|
	Gets damage by ship, which was set by ship.SetDamageByShip method.		Gets damage by ship, which was set by ship.SetDamageByShip method.
			}}

			{{Scripting_api\|GetTotalCargoAmount\|
			* int: ship_id\|
			int: amount\|
			<pre style="margin:0px;">var value = ship.GetTotalCargoAmount(24556);</pre> \|
			Returns total current amount of cargo stored in a ship.
	}}		}}

Damonwall: /* List of functions */

2014-07-05T04:02:15Z

List of functions

@@ Line 49: / Line 49: @@
 void|
 <pre style="margin:0px;">ship.RemoveItemByType(24556, "SomeItem2");</pre> |
 Removes item from PLAYER's inventory by type. If there's no item of specified type in ship's
 inventory, nothing will happen.
@@ Line 144: / Line 154: @@
 Useful in quests.
 }}
 {{Scripting_api|GetBuffs|

Damonwall at 08:21, 27 May 2014

2014-05-27T08:21:10Z

← Older revision		Revision as of 08:21, 27 May 2014
Line 395:		Line 395:
	Alters current value to specified value. Value will be clamped automatically between 0 and it's max value (which is governed by ship params.)		Alters current value to specified value. Value will be clamped automatically between 0 and it's max value (which is governed by ship params.)
	}}		}}

			{{Scripting_api\|SetCurrentArea\|
			* int: ship_id
			* string: area_id\|
			void\|
			<pre style="margin:0px;">ship.SetCurrentArea(24556, "command_deck");</pre> \|
			Sets current area of a player to specified one. Area determines in which section on a station NPC or player is.
			}}

			{{Scripting_api\|GetCurrentArea\|
			* int: ship_id\|
			string: area_id\|
			<pre style="margin:0px;">var area = ship.GetCurrentArea(24556);</pre> \|
			Gets current area of the ship.
			}}

Damonwall at 08:17, 27 May 2014

2014-05-27T08:17:33Z

← Older revision		Revision as of 08:17, 27 May 2014
Line 120:		Line 120:
	}}		}}

			{{Scripting_api\|GetFreeInventorySlots\|
			* int: ship_id\|
			int: number of free slots\|
			<pre style="margin:0px;">var slotsNum= ship.GetFreeInventorySlots(24556);</pre> \|
			Returns number of empty inventory slots in ship's inventory.
			}}

	{{Scripting_api\|HasCargoAmount\|		{{Scripting_api\|HasCargoAmount\|

Damonwall: /* List of functions */

2014-03-13T10:21:20Z

List of functions

@@ Line 87: / Line 87: @@
 <pre style="margin:0px;">var left = ship.GetCargoAmount(24556, "SomeCargo");</pre> |
 Returns amount of specified cargo in player's inventory.
 }}
@@ Line 146: / Line 177: @@
 Returns all current values of ship.
 }}

Damonwall: /* List of functions */

2014-03-11T10:43:52Z

List of functions

← Older revision		Revision as of 10:43, 11 March 2014
Line 64:		Line 64:
	}}		}}


			{{Scripting_api\|AddSkillPointsToPlayer\|
			* string: player_name
			* int: skillpoints\|
			void\|
			<pre style="margin:0px;">ship.AddSkillPointsToPlayer("DLirry", 20);</pre> \|
			Adds skill points to specified player.
			}}

			{{Scripting_api\|AddSkillPointsToShip\|
			* int: ship_id
			* int: skillpoints\|
			void\|
			<pre style="margin:0px;">ship.AddSkillPointsToShip(12335, 20);</pre> \|
			Adds skill points to specified ship (works only on player's ships, non-npc).
			}}

	{{Scripting_api\|GetCargoAmount\|		{{Scripting_api\|GetCargoAmount\|

Damonwall: /* List of functions */

2014-03-07T04:00:19Z

List of functions

← Older revision		Revision as of 04:00, 7 March 2014
Line 139:		Line 139:
	}}		}}

			{{Scripting_api\|GetWeapons\|
			* int: ship_id\|
			array: unique IDs (int) of equipped weapons\|
			<pre style="margin:0px;">var weapons = ship.GetWeapons(24556);</pre> \|
			Returns currently equipped weapons of a ship. Npc ship has no equipment, so it cannot be retireved this way.
			}}


			{{Scripting_api\|GetWeaponsOfType\|
			* int: ship_id
			* int: weapon_type (1 for energy, 2 for ballistic, 3 for missile)\|
			array: unique IDs (int) of equipped weapons\|
			<pre style="margin:0px;">var weapons = ship.GetWeapons(24556);</pre> \|
			Returns currently equipped weapons of a ship of a specified type. Npc ship has no equipment, so it cannot be retireved this way.
			}}


			{{Scripting_api\|RefillAmmoForWeapon\|
			* int: ship_id
			* int: weapon_id\|
			void\|
			<pre style="margin:0px;">ship.RefillAmmoForWeapon(24556, 15252);</pre> \|
			Refills ammo for weapon with specified unique in-game id (GID).
			}}

	{{Scripting_api\|GetHullXmlID\|		{{Scripting_api\|GetHullXmlID\|

Damonwall: /* List of functions */

2014-03-03T09:38:45Z

List of functions

@@ Line 19: / Line 19: @@
 <pre style="margin:0px;">var obj = ship.Add(24556, "SomeItem2", 5);</pre> |
 Adds item to ship's inventory.
 }}

Damonwall at 04:23, 14 February 2014

2014-02-14T04:23:08Z

← Older revision		Revision as of 04:23, 14 February 2014
Line 96:		Line 96:
	{{Scripting_api\|GetBuffsCache\|		{{Scripting_api\|GetBuffsCache\|
	* int: ship_id \|		* int: ship_id \|
	array: key -> value \|		array: key - value \|
	<pre style="margin:0px;">var cache = ship.GetBuffsCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetBuffsCache(24556);</pre> \|
	Returns current buffs cache. Used in FinalCacheCalculations.		Returns current buffs cache. Used in FinalCacheCalculations.
Line 137:		Line 137:
	{{Scripting_api\|GetEquipmentCache\|		{{Scripting_api\|GetEquipmentCache\|
	* int: ship_id\|		* int: ship_id\|
	array: key=>value\|		array: key-value\|
	<pre style="margin:0px;">var cache = ship.GetEquipmentCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetEquipmentCache(24556);</pre> \|
	Returns current equipment cache of ship.		Returns current equipment cache of ship.
Line 144:		Line 144:
	{{Scripting_api\|GetFinalCache\|		{{Scripting_api\|GetFinalCache\|
	* int: ship_id\|		* int: ship_id\|
	array: key=>value\|		array: key-value\|
	<pre style="margin:0px;">var cache = ship.GetFinalCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetFinalCache(24556);</pre> \|
	Returns current final cache of ship.		Returns current final cache of ship.
Line 170:		Line 170:
	{{Scripting_api\|GetSkillsCache\|		{{Scripting_api\|GetSkillsCache\|
	* int: ship_id\|		* int: ship_id\|
	array: key=>value\|		array: key-value\|
	<pre style="margin:0px;">var cache = ship.GetSkillsCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetSkillsCache(24556);</pre> \|
	Returns current skills cache.		Returns current skills cache.

← Older revision		Revision as of 04:23, 14 February 2014
Line 96:		Line 96:
	{{Scripting_api\|GetBuffsCache\|		{{Scripting_api\|GetBuffsCache\|
	* int: ship_id \|		* int: ship_id \|
	array: key -> value \|		array: key - value \|
	<pre style="margin:0px;">var cache = ship.GetBuffsCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetBuffsCache(24556);</pre> \|
	Returns current buffs cache. Used in FinalCacheCalculations.		Returns current buffs cache. Used in FinalCacheCalculations.
Line 137:		Line 137:
	{{Scripting_api\|GetEquipmentCache\|		{{Scripting_api\|GetEquipmentCache\|
	* int: ship_id\|		* int: ship_id\|
	array: key=>value\|		array: key-value\|
	<pre style="margin:0px;">var cache = ship.GetEquipmentCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetEquipmentCache(24556);</pre> \|
	Returns current equipment cache of ship.		Returns current equipment cache of ship.
Line 144:		Line 144:
	{{Scripting_api\|GetFinalCache\|		{{Scripting_api\|GetFinalCache\|
	* int: ship_id\|		* int: ship_id\|
	array: key=>value\|		array: key-value\|
	<pre style="margin:0px;">var cache = ship.GetFinalCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetFinalCache(24556);</pre> \|
	Returns current final cache of ship.		Returns current final cache of ship.
Line 170:		Line 170:
	{{Scripting_api\|GetSkillsCache\|		{{Scripting_api\|GetSkillsCache\|
	* int: ship_id\|		* int: ship_id\|
	array: key=>value\|		array: key-value\|
	<pre style="margin:0px;">var cache = ship.GetSkillsCache(24556);</pre> \|		<pre style="margin:0px;">var cache = ship.GetSkillsCache(24556);</pre> \|
	Returns current skills cache.		Returns current skills cache.