VoidExpanse/scope-generator - Revision history

Damonwall: /* List of functions */

2014-07-05T03:44:45Z

List of functions

@@ Line 423: / Line 423: @@
 Returns an array with IDs of all systems linked to the specified one.
 }}
 {{Scripting_api|GetMinDistanceToSystem|

Damonwall at 08:27, 27 May 2014

2014-05-27T08:27:20Z

@@ Line 496: / Line 496: @@
 <pre style="margin:0px;">var arr = generator.GetSystemsByDistanceTo(1);</pre> |
 Returns an array with IDs of systems, which are sorted by distance to specified system. Specified system is included into resulting array.
 }}
@@ Line 638: / Line 645: @@
 Sets npc avatar.
 }}
 {{Scripting_api|SetSystemDangerLevel|

Damonwall at 09:06, 10 April 2014

2014-04-10T09:06:10Z

← Older revision		Revision as of 09:06, 10 April 2014
Line 505:		Line 505:
	Returns an array of all resources of VoidExpanse.		Returns an array of all resources of VoidExpanse.
	}}		}}


			{{Scripting_api\|GetResourcesWithFlags\|
			* array of strings: flags\|
			array: xml_ids (strings) of resources\|
			<pre style="margin:0px;">var arr = generator.GetResourcesWithFlags(["mineable", "highlevel"]);</pre> \|
			Returns an array of resources of VoidExpanse, contains all specified flags in it's XML description.
			}}


	{{Scripting_api\|GetResourceByID\|		{{Scripting_api\|GetResourceByID\|

Damonwall at 09:04, 10 April 2014

2014-04-10T09:04:14Z

← Older revision		Revision as of 09:04, 10 April 2014
Line 291:		Line 291:
	<pre style="margin:0px;">var numOfPirates= generator.CountNpcInSystemByTags(20, {class: "pirate"});</pre> \|		<pre style="margin:0px;">var numOfPirates= generator.CountNpcInSystemByTags(20, {class: "pirate"});</pre> \|
	Counts npcs with specified tags in specified system.		Counts npcs with specified tags in specified system.
			}}

			{{Scripting_api\|ClearDropList\|
			* int: ship_id\|
			void\|
			<pre style="margin:0px;">generator.ClearDropList(20025);</pre> \|
			Clears droplist of a specified NPC.
	}}		}}

Damonwall at 09:02, 10 April 2014

2014-04-10T09:02:04Z

← Older revision		Revision as of 09:02, 10 April 2014
Line 183:		Line 183:
	}}		}}

	{{Scripting_api\|~~AddSpaceObject~~\|		{{Scripting_api\|AddLever\|
	* int: system_id		* int: system_id
	* double: coord_x		* double: coord_x
	* double: coord_y		* double: coord_y
	* string: xml_type_id		* string: xml_type_id
			* int: visible_to
	* object: tags \|		* object: tags \|
	int: ID of created object\|		int: ID of created object\|
	<pre style="margin:0px;">var id = generator.~~AddSpaceObject~~(1, 0, 0, "Debris01", {class: "mine"})</pre> \|		<pre style="margin:0px;">var id = generator.AddLever(1, 0, 0, "Debris01", 0, {class: "mine"})</pre> \|
	Adds a ~~space~~ object to ~~game~~ world. ~~Space objects are interactive~~ object. ~~They cannot be destroyed~~, ~~but they are interactive and collision-enabled~~. ~~For example~~, ~~spacemines are created with space objects~~.		Adds a lever object to world. Lever - is a special object, which can be activated. Parameter "visible_to" specifies, to whom lever is visible. If 0, it's visible to all, else - only to specified ship. Useful when you need to create a special object only to a man, who took the quest.
	~~NOTE: As xml_type_id~~ you ~~can use keyword "random" - then~~ a ~~random space~~ object ~~will spawn~~.
	}}		}}

Line 559:		Line 559:
	<pre style="margin:0px;">generator.RemovePlanet(123);</pre> \|		<pre style="margin:0px;">generator.RemovePlanet(123);</pre> \|
	Removes a planet from a game world.		Removes a planet from a game world.
			}}

			{{Scripting_api\|RemoveSpaceObject\|
			* int: space_object_id\|
			void\|
			<pre style="margin:0px;">generator.RemoveSpaceObject(123);</pre> \|
			Removes a space object from a game world.
			}}

			{{Scripting_api\|RemoveLever\|
			* int: lever_id\|
			void\|
			<pre style="margin:0px;">generator.RemoveLever(123);</pre> \|
			Removes specified lever from a game world.
	}}		}}

Damonwall at 08:20, 11 March 2014

2014-03-11T08:20:05Z

← Older revision		Revision as of 08:20, 11 March 2014
Line 283:		Line 283:
	<pre style="margin:0px;">var closed = generator.IsSystemClosed(20);</pre> \|		<pre style="margin:0px;">var closed = generator.IsSystemClosed(20);</pre> \|
	Check whether system is closed or not.		Check whether system is closed or not.
			}}

			{{Scripting_api\|CountNpcInSystemByTags\|
			* int: system_id
			* object: tags\|
			int\|
			<pre style="margin:0px;">var numOfPirates= generator.CountNpcInSystemByTags(20, {class: "pirate"});</pre> \|
			Counts npcs with specified tags in specified system.
	}}		}}

Damonwall at 06:20, 11 March 2014

2014-03-11T06:20:13Z

@@ Line 49: / Line 49: @@
 only to those, which have it, such as ships, space stations, containers.
 }}
 {{Scripting_api|AddContainer|

Atomic-admin at 10:09, 18 February 2014

2014-02-18T10:09:59Z

← Older revision		Revision as of 10:09, 18 February 2014
Line 584:		Line 584:
	<pre style="margin:0px;">generator.SetSystemTechLevel(1, 99);</pre> \|		<pre style="margin:0px;">generator.SetSystemTechLevel(1, 99);</pre> \|
	Set star system tech level. Tech level usually affects shops store items.		Set star system tech level. Tech level usually affects shops store items.
	}}


	~~{{Scripting_api\|ShipExists\|~~
	* int: ship_id\|
	~~bool: whether ship exists or not\|~~
	~~<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|~~
	}}		}}

Damonwall at 11:03, 14 February 2014

2014-02-14T11:03:46Z

← Older revision		Revision as of 11:03, 14 February 2014
Line 267:		Line 267:
	}}		}}

	~~{{Scripting_api\|SetSystemPlaylists\|~~
	* int: system_id
	* object: key->value object\|
	~~void\|~~
	~~<pre style="margin:0px;">generator.SetSystemPlaylists(args.sys_id,~~
	{
	~~"explore": "playlist_generic_explore",~~
	~~"combat": "playlist_generic_combat"~~
	}
	~~);</pre> \|~~
	~~Sets system music playlists. There are few possible keys, see more on playlists in [[VoidExpanse/MusicPlaylists]].~~
	}}

	{{Scripting_api\|AddSystemsLink\|		{{Scripting_api\|AddSystemsLink\|

Damonwall at 09:02, 13 February 2014

2014-02-13T09:02:58Z

← Older revision		Revision as of 09:02, 13 February 2014
Line 264:		Line 264:
	}		}
	);</pre> \|		);</pre> \|
	Sets system music playlists. There are few possible keys, see more in [[VoidExpanse/MusicPlaylists]].		Sets system music playlists. There are few possible keys, see more in [[VoidExpanse/MusicPlaylists\|MusicPlaylists]].
	}}		}}

Line 473:		Line 473:

	{{Scripting_api\|GetResourceByID\|		{{Scripting_api\|GetResourceByID\|
	string: xml_id\|		* string: xml_id\|
	object:		object:
	* double: price - standard price of this item		* double: price - standard price of this item
Line 485:		Line 485:

	{{Scripting_api\|GetItemByXmlID\|		{{Scripting_api\|GetItemByXmlID\|
	string: xml_id\|		* string: xml_id\|
	object:		object:
	* double: price - standard price of this item		* double: price - standard price of this item
Line 497:		Line 497:

	{{Scripting_api\|RemoveAsteroid\|		{{Scripting_api\|RemoveAsteroid\|
	int: asteroid_id\|		* int: asteroid_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveAsteroid(123);</pre> \|		<pre style="margin:0px;">generator.RemoveAsteroid(123);</pre> \|
Line 505:		Line 505:

	{{Scripting_api\|RemoveBase\|		{{Scripting_api\|RemoveBase\|
	int: base_id\|		* int: base_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveBase(123);</pre> \|		<pre style="margin:0px;">generator.RemoveBase(123);</pre> \|
Line 512:		Line 512:

	{{Scripting_api\|RemoveDecoration\|		{{Scripting_api\|RemoveDecoration\|
	int: decoration_id\|		* int: decoration_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveDecoration(123);</pre> \|		<pre style="margin:0px;">generator.RemoveDecoration(123);</pre> \|
Line 520:		Line 520:

	{{Scripting_api\|RemoveJumpgate\|		{{Scripting_api\|RemoveJumpgate\|
	int: jumpgate_id\|		* int: jumpgate_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveJumpgate(123);</pre> \|		<pre style="margin:0px;">generator.RemoveJumpgate(123);</pre> \|
Line 528:		Line 528:

	{{Scripting_api\|RemovePlanet\|		{{Scripting_api\|RemovePlanet\|
	int: planet_id\|		* int: planet_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemovePlanet(123);</pre> \|		<pre style="margin:0px;">generator.RemovePlanet(123);</pre> \|
Line 536:		Line 536:

	{{Scripting_api\|RemoveStar\|		{{Scripting_api\|RemoveStar\|
	int: star_id\|		* int: star_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveStar(123);</pre> \|		<pre style="margin:0px;">generator.RemoveStar(123);</pre> \|
Line 552:		Line 552:

	{{Scripting_api\|ReportLoadingPhase\|		{{Scripting_api\|ReportLoadingPhase\|
	string: phase\|		* string: phase\|
	void\|		void\|
	<pre style="margin:0px;">generator.ReportLoadingPhase("Loading galaxy");</pre> \|		<pre style="margin:0px;">generator.ReportLoadingPhase("Loading galaxy");</pre> \|
Line 560:		Line 560:

	{{Scripting_api\|ReportLoadingPhaseNoLoader\|		{{Scripting_api\|ReportLoadingPhaseNoLoader\|
	string: phase\|		* string: phase\|
	void\|		void\|
	<pre style="margin:0px;">generator.ReportLoadingPhaseNoLoader("Loading galaxy");</pre> \|		<pre style="margin:0px;">generator.ReportLoadingPhaseNoLoader("Loading galaxy");</pre> \|
Line 568:		Line 568:

	{{Scripting_api\|ReportLoadingProgress\|		{{Scripting_api\|ReportLoadingProgress\|
	double: percent - a value from 0 to 1\|		* double: percent - a value from 0 to 1\|
	void\|		void\|
	<pre style="margin:0px;">generator.ReportLoadingProgress(0.5);</pre> \|		<pre style="margin:0px;">generator.ReportLoadingProgress(0.5);</pre> \|
Line 600:		Line 600:

	{{Scripting_api\|ShipExists\|		{{Scripting_api\|ShipExists\|
	int: ship_id\|		* int: ship_id\|
	bool: whether ship exists or not\|		bool: whether ship exists or not\|
	<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|		<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|
Line 607:		Line 607:

	{{Scripting_api\|ShipExists\|		{{Scripting_api\|ShipExists\|
	int: ship_id\|		* int: ship_id\|
	bool: whether ship exists or not\|		bool: whether ship exists or not\|
	<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|		<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|
	}}		}}

← Older revision		Revision as of 09:02, 13 February 2014
Line 264:		Line 264:
	}		}
	);</pre> \|		);</pre> \|
	Sets system music playlists. There are few possible keys, see more in [[VoidExpanse/MusicPlaylists]].		Sets system music playlists. There are few possible keys, see more in [[VoidExpanse/MusicPlaylists\|MusicPlaylists]].
	}}		}}

Line 473:		Line 473:

	{{Scripting_api\|GetResourceByID\|		{{Scripting_api\|GetResourceByID\|
	string: xml_id\|		* string: xml_id\|
	object:		object:
	* double: price - standard price of this item		* double: price - standard price of this item
Line 485:		Line 485:

	{{Scripting_api\|GetItemByXmlID\|		{{Scripting_api\|GetItemByXmlID\|
	string: xml_id\|		* string: xml_id\|
	object:		object:
	* double: price - standard price of this item		* double: price - standard price of this item
Line 497:		Line 497:

	{{Scripting_api\|RemoveAsteroid\|		{{Scripting_api\|RemoveAsteroid\|
	int: asteroid_id\|		* int: asteroid_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveAsteroid(123);</pre> \|		<pre style="margin:0px;">generator.RemoveAsteroid(123);</pre> \|
Line 505:		Line 505:

	{{Scripting_api\|RemoveBase\|		{{Scripting_api\|RemoveBase\|
	int: base_id\|		* int: base_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveBase(123);</pre> \|		<pre style="margin:0px;">generator.RemoveBase(123);</pre> \|
Line 512:		Line 512:

	{{Scripting_api\|RemoveDecoration\|		{{Scripting_api\|RemoveDecoration\|
	int: decoration_id\|		* int: decoration_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveDecoration(123);</pre> \|		<pre style="margin:0px;">generator.RemoveDecoration(123);</pre> \|
Line 520:		Line 520:

	{{Scripting_api\|RemoveJumpgate\|		{{Scripting_api\|RemoveJumpgate\|
	int: jumpgate_id\|		* int: jumpgate_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveJumpgate(123);</pre> \|		<pre style="margin:0px;">generator.RemoveJumpgate(123);</pre> \|
Line 528:		Line 528:

	{{Scripting_api\|RemovePlanet\|		{{Scripting_api\|RemovePlanet\|
	int: planet_id\|		* int: planet_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemovePlanet(123);</pre> \|		<pre style="margin:0px;">generator.RemovePlanet(123);</pre> \|
Line 536:		Line 536:

	{{Scripting_api\|RemoveStar\|		{{Scripting_api\|RemoveStar\|
	int: star_id\|		* int: star_id\|
	void\|		void\|
	<pre style="margin:0px;">generator.RemoveStar(123);</pre> \|		<pre style="margin:0px;">generator.RemoveStar(123);</pre> \|
Line 552:		Line 552:

	{{Scripting_api\|ReportLoadingPhase\|		{{Scripting_api\|ReportLoadingPhase\|
	string: phase\|		* string: phase\|
	void\|		void\|
	<pre style="margin:0px;">generator.ReportLoadingPhase("Loading galaxy");</pre> \|		<pre style="margin:0px;">generator.ReportLoadingPhase("Loading galaxy");</pre> \|
Line 560:		Line 560:

	{{Scripting_api\|ReportLoadingPhaseNoLoader\|		{{Scripting_api\|ReportLoadingPhaseNoLoader\|
	string: phase\|		* string: phase\|
	void\|		void\|
	<pre style="margin:0px;">generator.ReportLoadingPhaseNoLoader("Loading galaxy");</pre> \|		<pre style="margin:0px;">generator.ReportLoadingPhaseNoLoader("Loading galaxy");</pre> \|
Line 568:		Line 568:

	{{Scripting_api\|ReportLoadingProgress\|		{{Scripting_api\|ReportLoadingProgress\|
	double: percent - a value from 0 to 1\|		* double: percent - a value from 0 to 1\|
	void\|		void\|
	<pre style="margin:0px;">generator.ReportLoadingProgress(0.5);</pre> \|		<pre style="margin:0px;">generator.ReportLoadingProgress(0.5);</pre> \|
Line 600:		Line 600:

	{{Scripting_api\|ShipExists\|		{{Scripting_api\|ShipExists\|
	int: ship_id\|		* int: ship_id\|
	bool: whether ship exists or not\|		bool: whether ship exists or not\|
	<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|		<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|
Line 607:		Line 607:

	{{Scripting_api\|ShipExists\|		{{Scripting_api\|ShipExists\|
	int: ship_id\|		* int: ship_id\|
	bool: whether ship exists or not\|		bool: whether ship exists or not\|
	<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|		<pre style="margin:0px;">generator.ShipExists(12552);</pre> \|
	}}		}}