VoidExpanse/scope-game - Revision history

Damonwall: /* List of functions */

2014-07-05T03:51:11Z

List of functions

@@ Line 315: / Line 315: @@
 <pre style="margin:0px;">game.ProjectileFromSystemSetSpeed(15,2524, 0, 0); //stop projectile</pre> |
 Sets projectile linear speed. Useful for manipulating projectile speed, doesn't affect it's direction.
 }}

Damonwall at 08:14, 27 May 2014

2014-05-27T08:14:01Z

← Older revision		Revision as of 08:14, 27 May 2014
Line 59:		Line 59:
	}}		}}

			{{Scripting_api\|GetStationDockedNpcs\|
			* int: station_id\|
			array of int\|
			<pre style="margin:0px;">var npcs = game.GetStationDockedNpcs(25353);</pre> \|
			Returns an array of IDs of all ships, that are docked to a station.
			}}

	{{Scripting_api\|GetItemPrice\|		{{Scripting_api\|GetItemPrice\|

Damonwall at 10:28, 13 March 2014

2014-03-13T10:28:13Z

@@ Line 274: / Line 274: @@
 void |
 array: strings of types |
-<pre style="margin:0px;">var res = station.GetItemTypes();</pre> |
+<pre style="margin:0px;">var res = game.GetItemTypes();</pre> |
 '''not implemented'''
 }}

Damonwall: /* List of functions */

2014-02-18T10:29:46Z

List of functions

← Older revision		Revision as of 10:29, 18 February 2014
Line 263:		Line 263:
	}}		}}

	{{Scripting_api\|~~GetITems~~\|		{{Scripting_api\|GetItems\|
	* int: level		* int: level
	* string[]: item_types \|		* string[]: item_types \|
	array: xml-ids (strings) of items \|		array: xml-ids (strings) of items \|
	<pre style="margin:0px;">var res = game.~~GetITems~~(15, ["Hull", "Consumable"]);</pre> \|		<pre style="margin:0px;">var res = game.GetItems(15, ["Hull", "Consumable"]);</pre> \|
	Gets all items of specified type.		Gets all items of specified type.
	}}		}}

Damonwall at 10:29, 18 February 2014

2014-02-18T10:29:11Z

@@ Line 253: / Line 253: @@
 <pre style="margin:0px;">game.SendNotification("dlirry", "Server notification", "You are great player!");</pre> |
 Sends notification to connected player.
 }}

Damonwall: Created page with " Category:VoidExpanse/api_scopes = Scope game = Used for various in-game functions. '''Visibility:''' Global. == List of functions == {{Scripti..."

2014-02-13T10:37:36Z

Created page with "<noinclude> Category:VoidExpanse/api_scopes </noinclude> = Scope game = Used for various in-game functions. '''Visibility:''' Global. == List of functions == {{Scripti..."

New page

<noinclude>
[[Category:VoidExpanse/api_scopes]]
</noinclude>

= Scope game =
Used for various in-game functions.

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|ApplyForceToObject|
* int: object_id
* double: force_x
* double: force_y |
void |
<pre style="margin:0px;">game.ApplyForceToObject(153, 10, 0); // add x-axis force</pre> |
Applies force to physics object. Will work on any interactive object.
}}

{{Scripting_api|ApplyTorqueToObject|
* int: object_id
* double: torque |
void |
<pre style="margin:0px;">game.ApplyTorqueToObject(153, 10); // add torque</pre> |
Applies torque to physics object. Will work on any interactive object.
}}

{{Scripting_api|DamageProjectile|
* int: system_id
* int: projectile_id
* double: damage |
void |
<pre style="margin:0px;">game.DamageProjectile(1, 12, 10);</pre> |
Damages projectile. Projectile, that took enough damage, will explode.
}}

{{Scripting_api|TryToRemoveContentFromAsteroid|
* int: asteroid_id
* string: name
* int: amount |
int: amount of content extracted from asteroid|
<pre style="margin:0px;">game.TryToRemoveContentFromAsteroid(12, "ResourceOre", 10);</pre> |
Tries to remove specified resource from asteroid's contents. Returns extracted amount.
}}

{{Scripting_api|GetItemEffects|
* string: xml_item_id|
array of objects:
* double: effect_base
* double: effect_cap
* double: effect_per_level
* double: effect_type|
<pre style="margin:0px;">var effects = game.GetItemEffects("SomeItem");</pre> |
Returns an array of all effects of specified item.
}}

{{Scripting_api|GetItemPrice|
* string: xml_item_id|
int: item_price|
<pre style="margin:0px;">var price = game.GetItemPrice("SomeItem");</pre> |
}}

{{Scripting_api|GetItemSID|
* int: unique_item_id |
string: xml_item_id |
<pre style="margin:0px;">var xml_item_id = game.GetItemSID(12352);</pre> |
Returns xml_id of item by it's instance ID.
}}

{{Scripting_api|GetProjectileDescriptionByXmlID|
* string: projectile_xml_id |
object:
* double: damage
* string: damage_type|
<pre style="margin:0px;">var xml_item_id = game.GetProjectileDescriptionByXmlID("wpn_0");</pre> |
Gets projectile description. Projectile xml ID is constructed by the following rule: wpn_id + "_" + projectile_order (starting with 0).
}}

{{Scripting_api|GetSecondsMultiplier|
void |
void |
<pre style="margin:0px;">var multiplier = game.GetSecondsMultiplier();</pre> |
Returns time passed since last frame. Useful when calculating time-depended stuff, like health-regeneration or damage.
}}

{{Scripting_api|GetGameObjectTags|
* int: object_id |
void |
<pre style="margin:0px;">var tags = game.GetGameObjectTags(131);</pre> |
Gets game object tags. Any physical object, such as asteroid, space object, ship or else, has it's own tags. This function can retrieve it. Alias of game.GetTags.
}}

{{Scripting_api|GetTags|
* int: object_id |
void |
<pre style="margin:0px;">var tags = game.GetTags(131);</pre> |
Gets game object tags. Any physical object, such as asteroid, space object, ship or else, has it's own tags. This function can retrieve it. The same as game.GetGameObjectTags.
}}

{{Scripting_api|GetShipOwner|
* int: ship_id |
string: owner_name |
<pre style="margin:0px;">var name = game.GetShipOwner(123142);</pre> |
Returns name of ship's owner. If ship is npc-controller, that would be npc name, else - player's name.
}}

{{Scripting_api|GetAsteroidMiningListByID|
* int: asteroid_id |
array of objects:
* string: xml_id
* int: quantity
* int: extraction|
<pre style="margin:0px;">var list = game.GetAsteroidMiningListByID(1252);</pre> |
Returns actual ateroid mining list.
}}

{{Scripting_api|GetAsteroidDescriptionByID|
* int: asteroid_id |
object:
* int: type
* int: difficulty|
<pre style="margin:0px;">var desc = game.GetAsteroidDescriptionByID(1252);</pre> |
Returns asteroid description.
}}

{{Scripting_api|GetSkillEffects|
* string: skill_xml_id |
array of objects:
* int: cost
* int: page
* string: title|
<pre style="margin:0px;">var effects = game.GetSkillEffects("SomeSkill");</pre> |
Returns array of specified skills' effects.
}}

{{Scripting_api|IsResource|
* string: item_xml_id |
bool: is specified item resource|
<pre style="margin:0px;">var is_res = game.IsResource("SomeItemOrResource");</pre> |
}}

{{Scripting_api|IsHull|
* string: item_xml_id |
bool: is specified item is hull|
<pre style="margin:0px;">var is_hull = game.IsHull("SomeItemOrResource");</pre> |
}}

{{Scripting_api|IsDevice|
* string: item_xml_id |
bool: is specified item is device|
<pre style="margin:0px;">var is_dev = game.IsDevice("SomeItemOrResource");</pre> |
}}

{{Scripting_api|IsWeapon|
* string: item_xml_id |
bool: is specified item is weapon|
<pre style="margin:0px;">var is_wpn = game.IsWeapon("SomeItemOrResource");</pre> |
}}

{{Scripting_api|IsShipPlayerControlled|
* int: ship_id |
bool: is ship controlled by player|
<pre style="margin:0px;">var is_player = game.IsShipPlayerControlled(123252);</pre> |
}}

{{Scripting_api|GetSystemJumpgates|
* int: system_id |
array: IDs of system jumpgates |
<pre style="margin:0px;">var jumpgates = game.GetSystemJumpgates(1);</pre> |
Returns all jumpgates of specified system.
}}

{{Scripting_api|GetSystemBases|
* int: system_id |
array: IDs of system bases |
<pre style="margin:0px;">var bases = game.GetSystemBases(1);</pre> |
Returns all bases of specified system.
}}

{{Scripting_api|GetSystemShips|
* int: system_id |
array: IDs of system ships |
<pre style="margin:0px;">var ships = game.GetSystemShips(1);</pre> |
Returns all ships of specified system.
}}

{{Scripting_api|GetSystemShipsOfClass|
* int: system_id
* string: tags_class |
array: IDs of system ships |
<pre style="margin:0px;">var miner_ships = game.GetSystemShipsOfClass(1, "miner");</pre> |
Returns all ships of specified system, which tag "class" is equal to specified value.
}}

{{Scripting_api|GetSystemPlayersShips|
* int: system_id |
array: IDs of system players' ships |
<pre style="margin:0px;">var ships = game.GetSystemPlayersShips(1);</pre> |
Returns all player-controlled ships of specified system.
}}

{{Scripting_api|GetObjectCoordinates|
* int: system_id
* int: object_id |
vector2: coordinates |
<pre style="margin:0px;">var coords = game.GetObjectCoordinates(1, 25442);</pre> |
Returns coordinates of specified object.
}}

{{Scripting_api|DeleteGameObject|
* int: object_id |
void |
<pre style="margin:0px;">game.DeleteGameObject(25442);</pre> |
Deletes game object from game world.
}}

{{Scripting_api|GetBaseEntryPointsByID|
* int: base_id |
array of vector2 |
<pre style="margin:0px;">var points = game.GetBaseEntryPointsByID(353);</pre> |
Returns bases' actual entry points coordinates.
}}

{{Scripting_api|SetSecondsBetweenStarSystemUpdates|
* int: system_id
* int: seconds |
void |
<pre style="margin:0px;">game.SetSecondsBetweenStarSystemUpdates(1, 60);</pre> |
Sets interval between event "OnStarSystemUpdate" for this system calls.
}}

{{Scripting_api|SendNotification|
* string: player_name
* string: title
* string: message |
void |
<pre style="margin:0px;">game.SendNotification("dlirry", "Server notification", "You are great player!");</pre> |
Sends notification to connected player.
}}