AtomicTorchWiki - User contributions [en]

VoidExpanse/scope-ship

2014-07-05T04:02:15Z

Damonwall: /* List of functions */

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

= Scope ship =
Used to get info and manipulate objects if type "ship".

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|AddItem|
* int: ship_id
* string: xml_item_type
* int: quantity|
object:
* int: quantity - amount added
* string: type - "item" or "resource"|
<pre style="margin:0px;">var obj = ship.Add(24556, "SomeItem2", 5);</pre> |
Adds item to ship's inventory.
}}

{{Scripting_api|AddItemToStorage|
* int: ship_id
* string: xml_item_type
* int: quantity|
object:
* int: quantity - amount added
* string: type - "item" or "resource"|
<pre style="margin:0px;">var obj = ship.AddItemToStorage(24556, "BFG", 0);</pre> |
Adds item to ship's storage, not inventory (only works on a base). Useful when you need to add new hull through scripts, but
it cannot be added to inventory, only to storage.
}}

{{Scripting_api|RemoveItem|
* int: ship_id
* int: item_id|
void|
<pre style="margin:0px;">ship.RemoveItem(24556, 5562);</pre> |
Removes item from ship's inventory.
}}

{{Scripting_api|RemoveItemByType|
* int: ship_id
* string: item_xml_type|
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.
}}

{{Scripting_api|RemoveItemByTypeCount|
* int: ship_id
* string: item_xml_type
* int: quantity|
void|
<pre style="margin:0px;">ship.RemoveItemByTypeCount(24556, "SomeItem2", 5);</pre> |
Removes item from PLAYER's inventory by type. If there's no item of specified type in ship's
inventory, nothing will happen.
}}

{{Scripting_api|RemoveCargoByType|
* int: ship_id
* string: cargo_type
* ''(optional) int: cargo_quantity''|
void|
<pre style="margin:0px;">ship.RemoveCargoByType(24556, "SomeCargo");</pre> |
Removes cargo from PLAYER's inventory by type. If there's no cargo of specified type in ship's
inventory, nothing will happen.
}}

{{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|
* int: ship_id
* string: cargo_type|
int: amount|
<pre style="margin:0px;">var left = ship.GetCargoAmount(24556, "SomeCargo");</pre> |
Returns amount of specified cargo in player's inventory.
}}

{{Scripting_api|GetCoordinates|
* int: ship_id|
vector2: coordinates|
<pre style="margin:0px;">var coords = ship.GetCoordinates(24556);</pre> |
Returns current coordinates of specified ship. Alias of GetPosition.
}}

{{Scripting_api|GetShipsInScope|
* int: ship_id|
array of int: ids|
<pre style="margin:0px;">var ships = ship.GetShipsInScope(24556);</pre> |
Returns IDs of all ships, that are currently in specified ship's scope.
}}

{{Scripting_api|GetProjectilesInScope|
* int: ship_id|
array of int: ids|
<pre style="margin:0px;">var bullets = ship.GetProjectilesInScope(24556);</pre> |
Returns IDs of all projectiles, that are currently in specified ship's scope.
}}

{{Scripting_api|GetDistanceToObj|
* int: ship_id
* int: object_id |
double: distance|
<pre style="margin:0px;">var dist = ship.GetDistanceToObj(24556, 25225);</pre> |
Returns distance from specified ship to specified object.
}}

{{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|
* int: ship_id
* string: cargo_type
* int: amount|
bool|
<pre style="margin:0px;">var hasCargo = ship.HasCargoAmount(24556, "SomeCargo", 14);</pre> |
Checks if player has specified amount of cargo.
}}

{{Scripting_api|HasItemOfType|
* int: ship_id
* string: item_id|
bool: if player's ship has item of specified type|
<pre style="margin:0px;">var hasItem = ship.HasItemOfType(24556, "SomeItem1");</pre> |
Useful in quests.
}}

{{Scripting_api|CountItemOfType|
* int: ship_id
* string: item_id|
int: count|
<pre style="margin:0px;">var quantity = ship.CountItemOfType(24556, "SomeItem1");</pre> |
Useful in quests.
}}

{{Scripting_api|CountItemOfType|
* int: ship_id
* string: item_id|
int: count|
<pre style="margin:0px;">var quantity = ship.CountItemOfType(24556, "SomeItem1");</pre> |
Useful in quests.
}}

{{Scripting_api|GetBuffs|
* int: ship_id|
array of objects:
* int: caster - id of ship casted this active effect
* double: time_left - time left
* double: effect_base
* double: effect_cap
* double: effect_per_level
* string: effect_type|
<pre style="margin:0px;">var effects = ship.GetBuffs(24556);</pre> |
Returns all specified ship's active effects. Active effects are temporary effects, which are usually
effects of consumables or devices.
}}

{{Scripting_api|GetBuffsCache|
* int: ship_id |
array: key - value |
<pre style="margin:0px;">var cache = ship.GetBuffsCache(24556);</pre> |
Returns current buffs cache. Used in FinalCacheCalculations.
}}

{{Scripting_api|GetCurrentValue|
* int: ship_id
* string: name|
double: current value with specified key|
<pre style="margin:0px;">var val = ship.GetCurrentValue(24556, "structure");</pre> |
Returns current value of ship.
}}

{{Scripting_api|GetCurrentValuesList|
* int: ship_id|
array: key -> value|
<pre style="margin:0px;">var values = ship.GetCurrentValuesList(24556);</pre> |
Returns all current values of ship.
}}

{{Scripting_api|GetEquipment|
* int: ship_id|
array: unique IDs (int) of equipped items|
<pre style="margin:0px;">var equipment = ship.GetEquipment(24556);</pre> |
Returns current equipment of player's ship. Npc ship has no equipment, so it cannot be retreieved this way.
}}

{{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|
* int: ship_id |
string: current ship's hull's xml type|
<pre style="margin:0px;">var hull = ship.GetHullXmlID(24556);</pre> |
Returns currently equipped hull's xml_id.
}}

{{Scripting_api|GetEquipmentCache|
* int: ship_id|
array: key-value|
<pre style="margin:0px;">var cache = ship.GetEquipmentCache(24556);</pre> |
Returns current equipment cache of ship.
}}

{{Scripting_api|GetFinalCache|
* int: ship_id|
array: key-value|
<pre style="margin:0px;">var cache = ship.GetFinalCache(24556);</pre> |
Returns current final cache of ship.
}}

{{Scripting_api|GetFinalCacheValue|
* int: ship_id
* string: name|
double: specified cache value|
<pre style="margin:0px;">var val = ship.GetFinalCacheValue(24556, "structure");</pre> |
Returns final cache value.
}}

{{Scripting_api|GetSkills|
* int: ship_id|
array of objects:
* string: id
* int: level
* string: skill_id|
<pre style="margin:0px;">var skills = ship.GetSkills(24556);</pre> |
Returns all current skills of ship.
}}

{{Scripting_api|GetSkillsCache|
* int: ship_id|
array: key-value|
<pre style="margin:0px;">var cache = ship.GetSkillsCache(24556);</pre> |
Returns current skills cache.
}}

{{Scripting_api|GetLevel|
* int: ship_id|
int: current level of ship|
<pre style="margin:0px;">var level = ship.GetLevel(24556);</pre> |
}}

{{Scripting_api|GetTags|
* int: ship_id|
object: tags of a ship|
<pre style="margin:0px;">var tags = ship.GetTags(24556);</pre> |
}}

{{Scripting_api|GetSystemID|
* int: ship_id|
int: ID of ship's current system|
<pre style="margin:0px;">var sys_id = ship.GetSystemID(24556);</pre> |
}}

{{Scripting_api|IsDocked|
* int: ship_id|
bool: returns whether ship is currently docked|
<pre style="margin:0px;">var docked = ship.IsDocked(24556);</pre> |
}}

{{Scripting_api|EnteringJumpgate|
* int: ship_id|
int: returns ID of jumpgate ship is entering (or 0 if none)|
<pre style="margin:0px;">var current_jumpgate = ship.EnteringJumpgate(24556);</pre> |
}}

{{Scripting_api|GetCurrentBase|
* int: ship_id|
int: returns ID of base to which ship is docked (or -1 if none)|
<pre style="margin:0px;">var current_base = ship.GetCurrentBase(24556);</pre> |
}}

{{Scripting_api|GetTimeSinceLastHit|
* int: ship_id|
double: time since ship last time dealt damage to someone|
<pre style="margin:0px;">var time = ship.GetTimeSinceLastHit(24556);</pre> |
Used in AI
}}

{{Scripting_api|GetTimeSinceLastHitted|
* int: ship_id|
double: time since ship last time took damage from someone|
<pre style="margin:0px;">var time = ship.GetTimeSinceLastHitted(24556);</pre> |
Used in ship's shield reestablishment calculations.
}}

{{Scripting_api|IsShieldUp|
* int: ship_id|
bool: returns whether ship's shield is up|
<pre style="margin:0px;">var shield_up = ship.IsShieldUp(24556);</pre> |
}}

{{Scripting_api|IsNpc|
* int: ship_id|
bool: returns whether ship is npc-controlled|
<pre style="margin:0px;">var is_npc = ship.IsNpc(24556);</pre> |
}}

{{Scripting_api|IsEngineOn|
* int: ship_id|
bool: returns whether ship's engine is working|
<pre style="margin:0px;">var is_engine_on = ship.IsEngineOn(24556);</pre> |
}}

{{Scripting_api|RegenerateWeapons|
* int: ship_id
* double: energy
* double: mult|
double: amount of energy spent on weapons regeneration|
<pre style="margin:0px;">var energy_spent = ship.RegenerateWeapons(24556);</pre> |
Hardcoded part - trying to regenerate weapons with energy. Only usable on PLAYER's ships. Returns amount of energy spent on weapons regeneration.
}}

{{Scripting_api|ReleaseGrappler|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ReleaseGrappler(24556);</pre> |
Release all current grappled objects.
}}

{{Scripting_api|GetGrappledCount|
* int: ship_id|
int: number of grappled objects|
<pre style="margin:0px;">var grappled = ship.GetGrappledCount(24556);</pre> |
Get number of grappled objects. Useful in caluclation of grappler energy consumption.
}}

{{Scripting_api|SetBuffsCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetBuffsCacheValue(24556, "structure", 2);</pre> |
Sets buff cache value.
}}

{{Scripting_api|ClearBuffsCache|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ClearBuffsCache(24556);</pre> |
Clears all current buffs cache values.
}}

{{Scripting_api|SetCurrentValue|
* int: ship_id
* string: field_name
* double: val|
void|
<pre style="margin:0px;">ship.SetCurrentValue(24556, "structure", 59);</pre> |
Sets current value of ship
}}

{{Scripting_api|SetCurrentValueDelta|
* int: ship_id
* string: field_name
* double: val|
void|
<pre style="margin:0px;">ship.SetCurrentValueDelta(24556, "structure", -10);</pre> |
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.
}}

{{Scripting_api|SetDrift|
* int: ship_id
* double: time|
void|
<pre style="margin:0px;">ship.SetDrift(24556, 5000);</pre> |
Enables driftmode of ship - in this mode ship cannot be controlled and can gain torque (which is always 0 when driftmode is off). Useful in explosion effects.
}}

{{Scripting_api|SetEquipmentCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetEquipmentCacheValue(24556, "structure", 5000);</pre> |
Sets equipment cache value.
}}

{{Scripting_api|ClearEquipmentCache|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ClearEquipmentCache(24556);</pre> |
Clears equipment cache.
}}

{{Scripting_api|SetFinalCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetFinalCacheValue(24556, "structure", 5000);</pre> |
Sets final cache value. Final cache is the one used in all in-game caluclations.
}}

{{Scripting_api|SetShieldUp|
* int: ship_id
* bool: status - true or false|
void|
<pre style="margin:0px;">ship.SetShieldUp(24556, true);</pre> |
Sets shield up/down status. Affects collision and damage models. Does not applies visual effects (see more in [[VoidExpanse/scope-visual|VisualScope]]).
}}

{{Scripting_api|SetSkillsCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetSkillsCacheValue(24556, "structure", 5000);</pre> |
Sets skill cache value.
}}

{{Scripting_api|ClearSkillsCache|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ClearSkillsCache(24556);</pre> |
Clear skills cache.
}}

{{Scripting_api|SetShipAsArrivedFromJumpgate|
* int: ship_id
* int: jumpgate_id|
void|
<pre style="margin:0px;">ship.SetShipAsArrivedFromJumpgate(24556, 15);</pre> |
Set visual and physical effects, that looks like ship just arrived from specified jumpgate.
}}

{{Scripting_api|SetDamageByShip|
* int: ship_id
* double: damage
* int: caster_id|
void|
<pre style="margin:0px;">ship.SetDamageByShip(24556, 15, 44535);</pre> |
Sets damage from ship. Useful in AI - you can count damage from player ship and decide, whether to attack or not.
}}

{{Scripting_api|SetDamageByShip|
* int: ship_id
* int: caster_id|
void|
<pre style="margin:0px;">var dmg = ship.SetDamageByShip(24556, 44535);</pre> |
Gets damage by ship, which was set by ship.SetDamageByShip method.
}}

Damonwall: /* List of functions */

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

= Scope ship =
Used to get info and manipulate objects if type "ship".

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|AddItem|
* int: ship_id
* string: xml_item_type
* int: quantity|
object:
* int: quantity - amount added
* string: type - "item" or "resource"|
<pre style="margin:0px;">var obj = ship.Add(24556, "SomeItem2", 5);</pre> |
Adds item to ship's inventory.
}}

{{Scripting_api|AddItemToStorage|
* int: ship_id
* string: xml_item_type
* int: quantity|
object:
* int: quantity - amount added
* string: type - "item" or "resource"|
<pre style="margin:0px;">var obj = ship.AddItemToStorage(24556, "BFG", 0);</pre> |
Adds item to ship's storage, not inventory (only works on a base). Useful when you need to add new hull through scripts, but
it cannot be added to inventory, only to storage.
}}

{{Scripting_api|RemoveItem|
* int: ship_id
* int: item_id|
void|
<pre style="margin:0px;">ship.RemoveItem(24556, 5562);</pre> |
Removes item from ship's inventory.
}}

{{Scripting_api|RemoveItemByType|
* int: ship_id
* string: item_xml_type|
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.
}}

{{Scripting_api|RemoveCargoByType|
* int: ship_id
* string: cargo_type
* ''(optional) int: cargo_quantity''|
void|
<pre style="margin:0px;">ship.RemoveCargoByType(24556, "SomeCargo");</pre> |
Removes cargo from PLAYER's inventory by type. If there's no cargo of specified type in ship's
inventory, nothing will happen.
}}

{{Scripting_api|GetCargoAmount|
* int: ship_id
* string: cargo_type|
int: amount|
<pre style="margin:0px;">var left = ship.GetCargoAmount(24556, "SomeCargo");</pre> |
Returns amount of specified cargo in player's inventory.
}}

{{Scripting_api|HasCargoAmount|
* int: ship_id
* string: cargo_type
* int: amount|
bool|
<pre style="margin:0px;">var hasCargo = ship.HasCargoAmount(24556, "SomeCargo", 14);</pre> |
Checks if player has specified amount of cargo.
}}

{{Scripting_api|HasItemOfType|
* int: ship_id
* string: item_id|
bool: if player's ship has item of specified type|
<pre style="margin:0px;">var hasItem = ship.HasItemOfType(24556, "SomeItem1");</pre> |
Useful in quests.
}}

{{Scripting_api|GetBuffs|
* int: ship_id|
array of objects:
* int: caster - id of ship casted this active effect
* double: time_left - time left
* double: effect_base
* double: effect_cap
* double: effect_per_level
* string: effect_type|
<pre style="margin:0px;">var effects = ship.GetBuffs(24556);</pre> |
Returns all specified ship's active effects. Active effects are temporary effects, which are usually
effects of consumables or devices.
}}

{{Scripting_api|GetBuffsCache|
* int: ship_id |
array: key - value |
<pre style="margin:0px;">var cache = ship.GetBuffsCache(24556);</pre> |
Returns current buffs cache. Used in FinalCacheCalculations.
}}

{{Scripting_api|GetCurrentValue|
* int: ship_id
* string: name|
double: current value with specified key|
<pre style="margin:0px;">var val = ship.GetCurrentValue(24556, "structure");</pre> |
Returns current value of ship.
}}

{{Scripting_api|GetCurrentValuesList|
* int: ship_id|
array: key -> value|
<pre style="margin:0px;">var values = ship.GetCurrentValuesList(24556);</pre> |
Returns all current values of ship.
}}

{{Scripting_api|GetEquipment|
* int: ship_id|
array: unique IDs (int) of equipped items|
<pre style="margin:0px;">var equipment = ship.GetEquipment(24556);</pre> |
Returns current equipment of player's ship. Npc ship has no equipment, so it cannot be retreieved this way.
}}

{{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|
* int: ship_id |
string: current ship's hull's xml type|
<pre style="margin:0px;">var hull = ship.GetHullXmlID(24556);</pre> |
Returns currently equipped hull's xml_id.
}}

{{Scripting_api|GetEquipmentCache|
* int: ship_id|
array: key-value|
<pre style="margin:0px;">var cache = ship.GetEquipmentCache(24556);</pre> |
Returns current equipment cache of ship.
}}

{{Scripting_api|GetFinalCache|
* int: ship_id|
array: key-value|
<pre style="margin:0px;">var cache = ship.GetFinalCache(24556);</pre> |
Returns current final cache of ship.
}}

{{Scripting_api|GetFinalCacheValue|
* int: ship_id
* string: name|
double: specified cache value|
<pre style="margin:0px;">var val = ship.GetFinalCacheValue(24556, "structure");</pre> |
Returns final cache value.
}}

{{Scripting_api|GetSkills|
* int: ship_id|
array of objects:
* string: id
* int: level
* string: skill_id|
<pre style="margin:0px;">var skills = ship.GetSkills(24556);</pre> |
Returns all current skills of ship.
}}

{{Scripting_api|GetSkillsCache|
* int: ship_id|
array: key-value|
<pre style="margin:0px;">var cache = ship.GetSkillsCache(24556);</pre> |
Returns current skills cache.
}}

{{Scripting_api|GetLevel|
* int: ship_id|
int: current level of ship|
<pre style="margin:0px;">var level = ship.GetLevel(24556);</pre> |
}}

{{Scripting_api|GetTags|
* int: ship_id|
object: tags of a ship|
<pre style="margin:0px;">var tags = ship.GetTags(24556);</pre> |
}}

{{Scripting_api|GetSystemID|
* int: ship_id|
int: ID of ship's current system|
<pre style="margin:0px;">var sys_id = ship.GetSystemID(24556);</pre> |
}}

{{Scripting_api|IsDocked|
* int: ship_id|
bool: returns whether ship is currently docked|
<pre style="margin:0px;">var docked = ship.IsDocked(24556);</pre> |
}}

{{Scripting_api|EnteringJumpgate|
* int: ship_id|
int: returns ID of jumpgate ship is entering (or 0 if none)|
<pre style="margin:0px;">var current_jumpgate = ship.EnteringJumpgate(24556);</pre> |
}}

{{Scripting_api|GetCurrentBase|
* int: ship_id|
int: returns ID of base to which ship is docked (or -1 if none)|
<pre style="margin:0px;">var current_base = ship.GetCurrentBase(24556);</pre> |
}}

{{Scripting_api|GetTimeSinceLastHit|
* int: ship_id|
double: time since ship last time dealt damage to someone|
<pre style="margin:0px;">var time = ship.GetTimeSinceLastHit(24556);</pre> |
Used in AI
}}

{{Scripting_api|GetTimeSinceLastHitted|
* int: ship_id|
double: time since ship last time took damage from someone|
<pre style="margin:0px;">var time = ship.GetTimeSinceLastHitted(24556);</pre> |
Used in ship's shield reestablishment calculations.
}}

{{Scripting_api|IsShieldUp|
* int: ship_id|
bool: returns whether ship's shield is up|
<pre style="margin:0px;">var shield_up = ship.IsShieldUp(24556);</pre> |
}}

{{Scripting_api|IsNpc|
* int: ship_id|
bool: returns whether ship is npc-controlled|
<pre style="margin:0px;">var is_npc = ship.IsNpc(24556);</pre> |
}}

{{Scripting_api|IsEngineOn|
* int: ship_id|
bool: returns whether ship's engine is working|
<pre style="margin:0px;">var is_engine_on = ship.IsEngineOn(24556);</pre> |
}}

{{Scripting_api|RegenerateWeapons|
* int: ship_id
* double: energy
* double: mult|
double: amount of energy spent on weapons regeneration|
<pre style="margin:0px;">var energy_spent = ship.RegenerateWeapons(24556);</pre> |
Hardcoded part - trying to regenerate weapons with energy. Only usable on PLAYER's ships. Returns amount of energy spent on weapons regeneration.
}}

{{Scripting_api|ReleaseGrappler|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ReleaseGrappler(24556);</pre> |
Release all current grappled objects.
}}

{{Scripting_api|GetGrappledCount|
* int: ship_id|
int: number of grappled objects|
<pre style="margin:0px;">var grappled = ship.GetGrappledCount(24556);</pre> |
Get number of grappled objects. Useful in caluclation of grappler energy consumption.
}}

{{Scripting_api|SetBuffsCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetBuffsCacheValue(24556, "structure", 2);</pre> |
Sets buff cache value.
}}

{{Scripting_api|ClearBuffsCache|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ClearBuffsCache(24556);</pre> |
Clears all current buffs cache values.
}}

{{Scripting_api|SetCurrentValue|
* int: ship_id
* string: field_name
* double: val|
void|
<pre style="margin:0px;">ship.SetCurrentValue(24556, "structure", 59);</pre> |
Sets current value of ship
}}

{{Scripting_api|SetCurrentValueDelta|
* int: ship_id
* string: field_name
* double: val|
void|
<pre style="margin:0px;">ship.SetCurrentValueDelta(24556, "structure", -10);</pre> |
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|SetDrift|
* int: ship_id
* double: time|
void|
<pre style="margin:0px;">ship.SetDrift(24556, 5000);</pre> |
Enables driftmode of ship - in this mode ship cannot be controlled and can gain torque (which is always 0 when driftmode is off). Useful in explosion effects.
}}

{{Scripting_api|SetEquipmentCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetEquipmentCacheValue(24556, "structure", 5000);</pre> |
Sets equipment cache value.
}}

{{Scripting_api|ClearEquipmentCache|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ClearEquipmentCache(24556);</pre> |
Clears equipment cache.
}}

{{Scripting_api|SetFinalCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetFinalCacheValue(24556, "structure", 5000);</pre> |
Sets final cache value. Final cache is the one used in all in-game caluclations.
}}

{{Scripting_api|SetShieldUp|
* int: ship_id
* bool: status - true or false|
void|
<pre style="margin:0px;">ship.SetShieldUp(24556, true);</pre> |
Sets shield up/down status. Affects collision and damage models. Does not applies visual effects (see more in [[VoidExpanse/scope-visual|VisualScope]]).
}}

{{Scripting_api|SetSkillsCacheValue|
* int: ship_id
* string: field_name
* double: value|
void|
<pre style="margin:0px;">ship.SetSkillsCacheValue(24556, "structure", 5000);</pre> |
Sets skill cache value.
}}

{{Scripting_api|ClearSkillsCache|
* int: ship_id|
void|
<pre style="margin:0px;">ship.ClearSkillsCache(24556);</pre> |
Clear skills cache.
}}

{{Scripting_api|SetShipAsArrivedFromJumpgate|
* int: ship_id
* int: jumpgate_id|
void|
<pre style="margin:0px;">ship.SetShipAsArrivedFromJumpgate(24556, 15);</pre> |
Set visual and physical effects, that looks like ship just arrived from specified jumpgate.
}}

{{Scripting_api|SetDamageByShip|
* int: ship_id
* double: damage
* int: caster_id|
void|
<pre style="margin:0px;">ship.SetDamageByShip(24556, 15, 44535);</pre> |
Sets damage from ship. Useful in AI - you can count damage from player ship and decide, whether to attack or not.
}}

{{Scripting_api|SetDamageByShip|
* int: ship_id
* int: caster_id|
void|
<pre style="margin:0px;">var dmg = ship.SetDamageByShip(24556, 44535);</pre> |
Gets damage by ship, which was set by ship.SetDamageByShip method.
}}

2014-02-18T10:27:19Z

Damonwall:

VoidExpanse/scope-topic

2014-02-18T07:16:37Z

Damonwall: /* List of functions */

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

= Scope topic =
Topic scope is used only inside topic scripts. Controls dialogs and quests.

'''Visibility:''' In topics only.

== List of functions ==

{{Scripting_api|AddChoice|
* int: choice_id
* string: choice_localisation_id
* string: choice_text
* ''(optional) object: parameters''|
void|
<pre style="margin:0px;">topic.AddChoice(1, "c001", "I'd like to pass this one, please.");
topic.AddChoice(1, "c001", "I'd like to pass this %one%, please.", {one: "hamburger"});</pre> |
Adds a choice to dialog.
}}

{{Scripting_api|AddPhrase|
* string: phrase_localisation_id
* string: phrase_text
* object: arguments|
void|
<pre style="margin:0px;">topic.AddPhrase("p001", "Hello, i'm npc!");
topic.AddPhrase("p001", "Hello, i'm %npc_name%!",
{npc_name: "Scott"});</pre> |
Adds an npc phrase to dialog.
}}

{{Scripting_api|AddTopic|
* string: topic_id|
void|
<pre style="margin:0px;">topic.AddTopic("topic_id_01");</pre> |
Adds specified topic to player's available topics.
}}

{{Scripting_api|RefreshTopics|
void|
void|
<pre style="margin:0px;">topic.RefreshTopics();</pre> |
List of topics on client is loaded once per conversation. If new topic was added, or the old one removed, this list will be reloaded. But what if state of topic was changed, and current npc shouldn't have it now, but there's such topic in player's list because it was already loaded?
RefreshTopics reloads current list of topics, testing all of them with CheckRequiments and actualize topic list.
Can come in handly when single topic manages dialogs with multiple characters in sequence.
}}

{{Scripting_api|HasTopic|
* string: topic_id|
bool: returns whether player already has this topic or not|
<pre style="margin:0px;">var bHasTopic = topic.HasTopic("topic_id_01");</pre> |
}}

{{Scripting_api|HasQuest|
* string: quest_id|
bool: returns whether player already has this quest or not|
<pre style="margin:0px;">var bHasQuest = topic.HasQuest("quest_id_01");</pre> |
}}

{{Scripting_api|Bind|
* string: trigger_name
* string: function_name
* object: parametes |
void|
<pre style="margin:0px;">topic.Bind("someTrigger", "OnSomeTrigger", { npc_id: "errors" });</pre> |
Binds function to a trigger.
}}

{{Scripting_api|DialogueBreak|
void|
void|
<pre style="margin:0px;">topic.DialogueBreak();</pre> |
Immediately breaks current dialogue.
}}

{{Scripting_api|GetCurrentNpcId|
void|
string: current npc id (name)|
<pre style="margin:0px;">var npc_id = topic.GetCurrentNpcId();</pre> |
}}

{{Scripting_api|GetCurrentNpcShipId|
void|
int: current npc's ship id|
<pre style="margin:0px;">var npc_ship_id = topic.GetCurrentNpcShipId();</pre> |
}}

{{Scripting_api|GetCurrentShipId|
void|
int: current player ship's ID|
<pre style="margin:0px;">var player_ship_id = topic.GetCurrentShipId();</pre> |
Has a global alias - PLAYER_SHIP. It's better to use alias - faster.
}}

{{Scripting_api|GetInput|
void|
int: player's choice id|
<pre style="margin:0px;">var input = topic.GetInput();</pre> |
}}

{{Scripting_api|GetState|
void|
int: topic state|
<pre style="margin:0px;">var state = topic.GetState();</pre> |
Returns current topic state - integer value. Usually state means current progress in questline, but it can be used any way possible.
}}

{{Scripting_api|InputExists|
void|
bool: returns whether player choose something or not|
<pre style="margin:0px;">var bInputExists = topic.InputExists();</pre> |
}}

{{Scripting_api|QuestAddLog|
* string: quest_id
* string: entry_id
* string: quest_text
* ''(optional) object: args''|
void|
<pre style="margin:0px;">topic.QuestAddLog("some_quest", "e001", "I just got this quest into quest log.");
topic.QuestAddLog("some_quest", "e001", "I just got this %whaat% into quest log.",
{whaat: "hamburger"});</pre> |
}}

{{Scripting_api|QuestAddMark|
* string: quest_id
* int: system_id|
void|
<pre style="margin:0px;">topic.QuestAddMark("some_quest", 1);</pre> |
Adds questmark, that'll be visible on a galaxy map.
}}

{{Scripting_api|QuestClearLog|
* string: quest_id|
void|
<pre style="margin:0px;">topic.QuestClearLog("some_quest");</pre> |
Clears log of specified quest.
}}

{{Scripting_api|QuestSetState|
* string: quest_id
* int: state|
void|
<pre style="margin:0px;">topic.QuestSetState("some_quest", QuestStatus.Finished);</pre> |
Sets state of quest. State can be QuestStatus.Active (0), QuestStatus.Finished (1), QuestStatus.Failed (2). All this constants are defined in any topic. You can use either them, or just numbers - 0,1,2. Status affects in which tab quest displays.
}}

{{Scripting_api|QuestRemove|
* string: quest_id|
void|
<pre style="margin:0px;">topic.QuestRemove("some_quest");</pre> |
Removes quest completely - after that it won't appear in any tab.
}}

{{Scripting_api|QuestRemoveMarkers|
* string: quest_id|
void|
<pre style="margin:0px;">topic.QuestRemoveMarkers("some_quest");</pre> |
Removes all markers of quest.
}}

{{Scripting_api|QuestStart|
* string: quest_id
* string: quest_title |
void|
<pre style="margin:0px;">topic.QuestStart("some_quest", "Rats in the cellar");</pre> |
Stars quest. After that it will appear in journal, and log messages and markers can be added to it.
}}

{{Scripting_api|RemoveTopic|
* string: topic_id|
void|
<pre style="margin:0px;">topic.RemoveTopic("topic_id");</pre> |
Removes topic completely.
}}

{{Scripting_api|SetState|
* int: state_value|
void|
<pre style="margin:0px;">topic.SetState(200);</pre> |
Changes state of current topic.
}}

{{Scripting_api|Unbind|
* string: trigger_name
* string: function_name|
void|
<pre style="margin:0px;">topic.Unbind("someTrigger", "OnSomeTrigger");</pre> |
Unbinds function from a trigger.
}}

VoidExpanse/scope-config

2014-02-18T07:12:44Z

Damonwall: Undo revision 111 by Damonwall (talk)

<noinclude>
[[Category:VoidExpanse/api_scopes]]
</noinclude>
= Config scope =
Used to get access to server variables from config file.

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|GetFlag|
* string: name|
bool - whether the flag is set or not.|
<pre style="margin:0px">var a = config.GetFlag("some_var");</pre> |
Returns a boolean server flag value by name. Basically used to read server config options.
}}

{{Scripting_api|GetSetting|
* string: name|
object - a particular value of config.|
<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>|
Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.
}}

{{Scripting_api|Wait|
* int: time_ms|
void |
<pre style="margin:0px">config.Wait(1000); //wait for 1 second</pre>|
Makes main thread to wait for specified time in milliseconds.
}}

VoidExpanse/scope-timer

2014-02-18T07:12:04Z

Damonwall: Created page with "<noinclude> Category:VoidExpanse/api_scopes </noinclude> = Timer scope = Used to create and manage timers - delayed events. Timers only works inside it's script, but they'..."

VoidExpanse/scope-config

2014-02-18T07:11:24Z

Damonwall:

VoidExpanse/scripting api

2014-02-18T07:05:42Z

Damonwall: /* Scopes */

= Scripting overview =

== Basic concepts ==
Scripting is done via actions that custom scripts can subscribe to. There are number of actions that are called by server automatically, plus users can create their own actions and call them when needed. This also makes possible for users to create scripting frameworks for others to use.
Each action has one argument (ΓÇ£argsΓÇ¥) that is a JavaScript object containing several variables inside depending on a particular action. In some actions this ΓÇ£argsΓÇ¥ object can be empty. But either way it allows for unified format for all actions within the scripting system.

=== Scripting naming convention ===
* String IDΓÇÖs in mods can only contain alphanumeric characters and underscores. Any other characters are illegal.
* Using underscore for variables and properties.
* Using CamelCase for functions and methods.
* zxc_q - ΓÇ£qΓÇ¥ in the variable always represents ΓÇ£quantityΓÇ¥ or ΓÇ£number of ...ΓÇ¥.
* zxc_id - ΓÇ£idΓÇ¥ always means either string id from XML file if it is of the type of string, or if it is uint then it is entity (instance) id of some object.
* zxc_req - ΓÇ£reqΓÇ¥ always means ΓÇ£requirementsΓÇ¥.
* All mods should prefix their variables, functions, classes, storage keys and all the rest with a key for isolation from other mods, example of such prefix would be ΓÇ£prf_ΓÇ¥ -> ΓÇ£prf_some_variableΓÇ¥, ΓÇ£prf_SomeFunctionΓÇ¥.

=== Internal scripts (Overridable) ===
{{Main|VoidExpanse/Internal_scripts|Internal scripts}}
These scripts are called usually once and only in a particular situation. Each of these script files must exist in only one instance. If a new script is added the previous one will be overridden. Each of the script files must implement only one script action. Usually players should not modify these scripts unless they want to completely re-implement some game feature.

=== Global scripts (called in the world dynamically) ===
{{Main|VoidExpanse/Global_scripts|Global scripts}}
Global scripts are executed continuously during gameplay. For each event there could be many bound scripts. Also it is possible to create custom actions and subscribe to them.

=== Object scripts ===
{{Main|VoidExpanse/Object_scripts|Object scripts}}
Object scripts are scripts attached to a particular game object. When that object starts an action, if script has an appropriate handler for this action it will be executed.

== VoidExpanse Scripting API ==

=== Library inclusion and scopes usage ===
Preprocessor directive <code>include(libname.js);</code> includes a library scripts into a current JS instance. Library scripts also can include each other (no echo effect will appear).

Allows to use functions and objects of these libraries in this particular script instance.
* Inclusions of libraries directive must be the first lines in the script file (not necessarily, but preferably - to maintain order in scripts).
* All include directives must be before first function declaration.

Preprocessor directive <code>using(scopename);</code> allows to use specific scope in a specific script. Scope name must be an existing scope name (see scopes below). Except for some specific scopes (like topic or npc), which are available only in specific places, like topic scripts or AI behaviors.

=== Scopes ===
Each scope contains a number of functions available from it.

* [[VoidExpanse/scope-config]] (available: global)
* [[VoidExpanse/scope-script]] (available: global)
* [[VoidExpanse/scope-actions]] (available: global)
* [[VoidExpanse/scope-server]] (available: global)
* [[VoidExpanse/scope-generator]] (available: global)
* [[VoidExpanse/scope-spawn]] (available: global)
* [[VoidExpanse/scope-station]] (available: global)
* [[VoidExpanse/scope-chat]] (available: global)
* [[VoidExpanse/scope-console]] (available: global)
* [[VoidExpanse/scope-storage]] (available: global)
* [[VoidExpanse/scope-game]] (available: global)
* [[VoidExpanse/scope-ship]] (available: global)
* [[VoidExpanse/scope-visual]] (available: global)
* [[VoidExpanse/scope-player]] (available: global)
* [[VoidExpanse/scope-topic]] (available: only in topics)
* [[VoidExpanse/scope-topics]] (available: global)
* [[VoidExpanse/scope-relations]] (available: global)
* [[VoidExpanse/scope-npc]] (available: global)
* [[VoidExpanse/scope-timer]] (available: global)

== Device scripts ==
{{Main|VoidExpanse/Device_scripts|Device scripts}}
Devices uses effect scripts, which is similar to any object scripts, but uses itΓÇÖs own special system of arguments. These scripts are shared between instances of the same device type, therefore global variables in this scripts are denied.

There are four possible functions for device script.

VoidExpanse/events

2014-02-18T07:04:53Z

Damonwall: /* Events */

== Events ==

Events in scripts are governed by scope '''actions'''. You can create your own events, or you
can subscribe to events created by other modders, but all scripting system is based on built-in
events, which are the following:

'''"OnEnterFrame"'''

input:
* double: multiplier - time in seconds passed since last frame

Called every frame on server.
NOTE: Can be manipulated with [[VoidExpanse/scope-script|scope-script]] - to make it work not every frame,
but every timer interval or definite frames per second.

'''"OnChatReceive"'''

input:
* string: from
* string: text

Called when some player send chat message.

'''"OnCalculateInventoryCache"'''

input:
* string: player_name
* double: seconds_multiplier
* int: ship_id
* int: level

Called when it's time to recalculate equipment - for example, when player installs new hull or weapon.

'''"OnCalculateSkillsCache"'''

input:
* string: player_name
* double: seconds_multiplier
* int: ship_id
* int: level

Called when it's time to recalculate skills cache - usually when player takes new skill, or advances in an old one.

'''"OnCalculateBuffsCache"'''

input:
* string: player_name
* double: seconds_multiplier
* int: ship_id
* int: level

Called when active effects (buffs) are changed - for example, effect of consumable item is worn off.

'''"OnCalculateShipParameters"'''

input:
* string: player_name
* double: seconds_multiplier
* int: ship_id
* int: level

Called if any of other caches has been changed. Recalculation of final ship's cache.

'''"OnCollision"'''

input:
* double: collision_point_x
* double: collision_point_y
* double: impulse
* int: object_id_1
* int: object_id_2
* string: object_type_1
* string: object_type_2
* double: vector_x
* double: vector_y

Called when some objects collided.

'''"OnHit"'''

input:
* int: caster_id
* double: collision_point_x
* double: collision_point_y
* int: object_id
* string: object_type
* string: projectile_id
* string: projectile_type //bullet, ray
* double: vector_x
* double: vector_y
* string: weapon_id
* double: distance
* double: projectile_distance
* double: projectile_max_distance
* double: multiplier

Called every time one ship hits with weapon another one.

'''"OnRayHitProjectile"'''
not implemented yet

'''"OnUpdateShipParameters"'''

input:
* string: player_name
* double: seconds_multiplier
* int: ship_id
* int: level

Called 5 times per second. Used for regeneration, fuel and energy consumption calculations etc.

'''"OnMaximizeShipValues"'''

input:
* string: player_name
* double: seconds_multiplier
* int: ship_id
* int: level

Called every time ship values are maximized (on space station for example).

'''"OnBaseGenerateStock"'''

input:
* int: station_id

Called every time stock on station is needed to be refreshed.

'''"OnStarSystemUpdate"'''

input:
* int: system_id
* bool: populated

Called once per specified amount of time (which is set by special function in game scope). Called for populated systems and non-populated.

'''"OnCalculateNpcLeveledCache"'''

input:
* string: player_name
* double: seconds_multiplier
* int: ship_id
* int: level

Called when NPC is created. As soon as npc doesn't have any real equipment, their equipment cache is calculated based on it's level, and
it should be done in this function.

'''"OnShipTryToEnterJumpgate"'''

input:
* int: current_system_id
* int: destination_system_id
* int: jumpgate_id
* int: ship_id

Called when player's ship is trying to enter jumpgate.
NOTE! This event has a return value.
Handler may not return anything, but if it'll return object with field {allow: false},
ship will not pass through jumpgate. With field "message" : {message: "Use the force, Luke!"}
you can control notification, which client will see in his notification area.
As soon as any on handlers will return {allow:false}, chain of calls breaks, and other
subscribers won't get the event.

'''"OnShipKilled"'''

input:
* int: caster_id
* double: collision_point_x
* double: collision_point_y
* int: object_id
* string: object_type
* string: projectile_id
* string: projectile_type //bullet, ray
* double: vector_x
* double: vector_y
* string: weapon_id
* double: distance
* double: projectile_distance
* double: projectile_max_distance
* double: multiplier

Called every time ship is killed by other ship.

'''"OnShipDestroyed"'''

input:
* int: ship_id

Called every time ship is destroyed.

'''"OnShipWarps"'''

input:
* int: ship_id

Called every time ship warps.
NOTE! This event has a return value.
Handler may not return anything, but if it'll return object with field {allow: false},
ship will not pass through jumpgate. With field "message" : {message: "Use the force, Luke!"}
you can control notification, which client will see in his notification area.
As soon as any on handlers will return {allow:false}, chain of calls breaks, and other
subscribers won't get the event.

'''"OnPlayerEntersGame"'''

input:
* string: name

Called every time player enters the game

'''"OnPlayerEntersSystem"'''

input:
* string: name
* int: system_id

Called every time player enters system

VoidExpanse/modding

2014-02-17T03:43:03Z

Damonwall: Created page with "VoidExpanse was created to have an almost unlimited modding potential. Almost every aspect of game can be modified and extended. There are no hardcoded scripts and in-game log..."

Main Page

2014-02-17T03:36:51Z

Damonwall: /* VoidExpanse */

[[File:AtomicTorchStudioLogoTransparent.png]]<br>Welcome to '''AtomicTorch Studio''' wiki!

This wiki is work in progress and is in no way complete. We are only starting adding content here, for now mostly for our own reference. But if you would like to help - feel free to create an account.

= VoidExpanse =
{| class="wikitable" style="width:100%"
|-
! style="width:34%" | Get the game
! style="width:33%" | The game
! style="width:33%" | Modding
|-
| 
VoidExpanse is currently in development. You can find all information about the game on the website.
* [http://atomictorch.com AtomicTorch Studio portal]
* [http://forums.atomictorch.com Forums]
| 
* [[VoidExpanse/Version History|Version history]]
* [[VoidExpanse/Ships|Ships]]
* [[VoidExpanse/Weapons|Weapons]]
* [[VoidExpanse/Equipment|Equipment]]
| 
* [[VoidExpanse/modding|Modding]]
* [[VoidExpanse/scripting_api|Scripting]]
|}

== Editing wiki ==
* [[:Category:Templates|List of templates]]