Damonwall at 08:12, 27 May 2014

2014-05-27T08:12:05Z

← Older revision		Revision as of 08:12, 27 May 2014
Line 18:		Line 18:
	}}		}}

			{{Scripting_api\|IsCapital\|
			* int: system_id\|
			bool\|
			<pre style="margin:0px;">relations.IsCapital(323);</pre> \|
			Returns whether specified system is a capital of a faction.
			}}

	{{Scripting_api\|GetFactionDispositionToShip\|		{{Scripting_api\|GetFactionDispositionToShip\|

Damonwall: Created page with " Category:VoidExpanse/api_scopes = Scope relations = Used to manage reputation, relations, factions and all other social stuff. '''Visibility:'''..."

2014-02-14T04:59:25Z

Created page with "<noinclude> Category:VoidExpanse/api_scopes </noinclude> = Scope relations = Used to manage reputation, relations, factions and all other social stuff. '''Visibility:'''..."

New page

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

= Scope relations =
Used to manage reputation, relations, factions and all other social stuff.

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|CreateFaction|
* string: faction_id
* string: faction_name|
void|
<pre style="margin:0px;">relations.CreateFaction("order", "Order of Paladins");</pre> |
Creates a faction.
}}

{{Scripting_api|GetFactionDispositionToShip|
* string: faction_id
* int: ship_id|
int: disposition|
<pre style="margin:0px;">var disp = relations.GetFactionDispositionToShip("order", 25333);</pre> |
Returns faction disposition to specified ship.
}}

{{Scripting_api|GetFactionsRelation|
* string: faction_1_id
* string: faction_2_id|
int: relation|
<pre style="margin:0px;">var relation = relations.GetFactionsRelation("order", "freedom");</pre> |
Returns relation between factions.
}}

{{Scripting_api|GetPersonalDisposition|
* int: ship_id_1
* int: ship_id_2|
int: disposition|
<pre style="margin:0px;">var disp = relations.GetPersonalDisposition(25332, 25333);</pre> |
Returns disposition of ship to another ship.
}}

{{Scripting_api|GetShipFaction|
* int: ship_id|
string: faction|
<pre style="margin:0px;">var fact = relations.GetShipFaction(25332);</pre> |
Returns ship's current faction.
}}

{{Scripting_api|GetTotalDisposition|
* int: ship_id_1
* int: ship_id_2|
int: desposition|
<pre style="margin:0px;">var disp = relations.GetTotalDisposition(25332, 25333);</pre> |
Returns ship's total disposition. Calculated in internal scrips, so it can be altered.
}}

{{Scripting_api|SetBaseFaction|
* int: base_id
* string: faction_id|
void|
<pre style="margin:0px;">relations.SetBaseFaction(25332, "order");</pre> |
Sets faction of a space station.
}}

{{Scripting_api|SetFactionDispositionToShip|
* string: faction
* int: ship_id
* int: value|
void|
<pre style="margin:0px;">relations.SetFactionDispositionToShip("order", 25553, -1000);</pre> |
Sets a faction disposition towards a ship.
}}

{{Scripting_api|SetFactionDispositionToShipDelta|
* string: faction
* int: ship_id
* int: value_delta|
void|
<pre style="margin:0px;">relations.SetFactionDispositionToShipDelta("order", 25553, 1000);</pre> |
Changes a faction disposition towards a ship by specified delta.
}}

{{Scripting_api|SetFactionsRelation|
* string: faction_id_1
* string: faction_id_2
* int: value|
void|
<pre style="margin:0px;">relations.SetFactionsRelation("order", "freedom", -1000);</pre> |
Sets a relation between factions.
}}

{{Scripting_api|SetPersonalDisposition|
* int: ship_id_1
* int: ship_id_2
* int: disposition|
void|
<pre style="margin:0px;">relations.SetPersonalDisposition(25333, 25332, -1000);</pre> |
Sets personal disposition between two ships.
}}

{{Scripting_api|SetPersonalDispositionDelta|
* int: ship_id_1
* int: ship_id_2
* int: disposition_delta|
void|
<pre style="margin:0px;">relations.SetPersonalDispositionDelta(25333, 25332, -1000);</pre> |
Changes personal disposition between two ships by specified value.
}}

{{Scripting_api|SetShipFaction|
* int: ship_id_1
* string: faction|
void|
<pre style="margin:0px;">relations.SetShipFaction(25333, "order");</pre> |
Set ship's faction.
}}

{{Scripting_api|SetSystemFaction|
* int: ship_id_1
* string: faction|
void|
<pre style="margin:0px;">relations.SetSystemFaction(1, "order");</pre> |
Sets system's faction.
}}

{{Scripting_api|GetSystemFaction|
* int: ship_id_1|
string: faction of a system|
<pre style="margin:0px;">var faction = relations.GetSystemFaction(1);</pre> |
}}

{{Scripting_api|GetFactions|
void|
array: IDs of factions (strings)|
<pre style="margin:0px;">var factions = relations.GetFactions();</pre> |
Returns IDs of all factions created with relations.CreateFaction.
}}

{{Scripting_api|GetFactionInfoByID|
* string: faction_id|
object:
* double capital_area_of_influence;
* int capital_danger_level
* int capital_tech_level
* double distance_from_origin_max
* double distance_from_origin_min
* int stars_count_percent
* int stars_count_value
|
<pre style="margin:0px;">var info = relations.GetFactionInfoByID("order");</pre> |
Returns information about specified faction.
}}

{{Scripting_api|ClearAllInfoOnSystems|
void|
void|
<pre style="margin:0px;">relations.ClearAllInfoOnSystems();</pre> |
Clears all faction relation info on systems. Useful after failed attempts to generate factions.
}}

{{Scripting_api|GetFactionCapital|
* string: faction|
int: ID of system, which is considered as a capital of faction|
<pre style="margin:0px;">var sys_id = relations.GetFactionCapital("order");</pre> |
}}

{{Scripting_api|SetFactionCapital|
* string: faction
* int: system_id|
void|
<pre style="margin:0px;">relations.SetFactionCapital("order", 15);</pre> |
}}

VoidExpanse/scope-relations - Revision history

Damonwall at 08:12, 27 May 2014

Damonwall: Created page with " Category:VoidExpanse/api_scopes = Scope relations = Used to manage reputation, relations, factions and all other social stuff. '''Visibility:'''..."