BGS Doc - Revision history

Cholmondely: Retagged!

2023-09-20T13:42:16Z

Retagged!

Cholmondely: Added note about BGS2 Doc & link

2021-06-03T08:15:42Z

Added note about BGS2 Doc & link

Svengali: Added note about version

2016-11-02T14:55:37Z

Added note about version

Svengali: added findOnLRC()

2013-09-17T20:42:36Z

added findOnLRC()

Svengali: formatting

2013-09-15T23:53:23Z

formatting

Svengali: add bgs_tunnel_off

2013-09-14T13:53:34Z

add bgs_tunnel_off

Svengali at 12:56, 13 August 2013

2013-08-13T12:56:03Z

Svengali: shader performance tweaks

2013-08-05T18:12:13Z

shader performance tweaks

Svengali: added explanation for docking fx

2013-08-04T11:21:38Z

added explanation for docking fx

Svengali: added bgs_tunnel_shape, bgs_tunnel_texture and bgsDockingFX (all v1.9)

2013-07-31T17:20:48Z

added bgs_tunnel_shape, bgs_tunnel_texture and bgsDockingFX (all v1.9)

← Older revision		Revision as of 13:42, 20 September 2023
Line 245:		Line 245:


−	[[Category:~~OXPDoc~~]]	+	[[Category:OXP API's]]

← Older revision		Revision as of 08:15, 3 June 2021
Line 1:		Line 1:
−	{{OXPNote\|The documentation reflects the state up to v1.10}}	+	{{OXPNote\|The documentation reflects the state up to v1.10, pre 2016. For more modern documentation see [[BGS2 Doc]]}}

	== Overview ==		== Overview ==

← Older revision		Revision as of 14:55, 2 November 2016
Line 1:		Line 1:
		+	{{OXPNote\|The documentation reflects the state up to v1.10}}
		+
	== Overview ==		== Overview ==
	[[BGS\|BGS-M]] is the script for ambient sounds, music and image switches.		[[BGS\|BGS-M]] is the script for ambient sounds, music and image switches.

@@ Line 109: / Line 109: @@
 ::;type:Number. Required. Range 1...4.
 ::;gal:Number. Required. Galaxy number in range 0...7.
 ::;ov:String. Required. Filename for the overlay with extension.
@@ Line 136: / Line 137: @@
 '''Type 4 (Route):'''
 :;pos:Array. Pairs of coordinates in LY in x,y format, e.g. [[8,34.6],[...]]

@@ Line 15: / Line 15: @@
 ==== BGS-XMapping ====
-The script ships functionality to display more infos on the LongRangeChart via overlay if the player has bought the [[Advanced_Navigational_Array|Advanced Navigational Array]]. BGS-X will (when released) add the named regions and lanes from ClymAngus vector maps (see [[Oolite_planet_list]]).
+The script ships functionality to display more infos on the LongRangeChart via overlay if the player has bought the [[Advanced_Navigational_Array|Advanced Navigational Array]]. It adds the named regions and lanes from ClymAngus vector maps (see [[Oolite_planet_list]]).
 BGS uses [[Cabal_Common_Library_Doc_2DCollision|Cabal_Common_2DCollision()]] to check if the cursor is inside a specified polygon or on a specified line. Methods for inserting the datatsets are available (see [[#addToLRCSpecial()|addToLRCSpecial()]] and [[#addToLRC()|addToLRC()]]).
@@ Line 42: / Line 42: @@
 === bgsChatterPause ===
-:Number. Max pause for chatter in game seconds. Default 24.<sup>OXPC</sup> (New in v1.7)
+:Number. Max pause for chatter in game seconds. Default 24.<sup>OXPC</sup> {{AV|1.7}}
 === bgsCountOffset ===
@@ Line 60: / Line 60: @@
 === bgsDockingFX ===
-:Boolean. Shader effect on docking/launching. Default true.<sup>OXPC</sup> (New in v1.9)
+:Boolean. Shader effect on docking/launching. Default true.<sup>OXPC</sup> {{AV|1.9}}
 === bgsHyperFX ===
@@ Line 99: / Line 99: @@
 '''Returns:'''
 :;bool: Boolean. True on success.
 === addToLRC() ===
@@ Line 168: / Line 169: @@
 Playership (with preloaded sounds):
-{{CodeEx|codeex=script_info = {bgs_engine = "[vector_engine]"; bgs_engineUp = "[vector_engineUp]"; bgs_engineDown = "[vector_engineDown]";};}}
+  script_info = {bgs_engine = "[vector_engine]"; bgs_engineUp = "[vector_engineUp]"; bgs_engineDown = "[vector_engineDown]";};
 Playership (without preloaded sounds):
-{{CodeEx|codeex=script_info = {bgs_engine = "myEngine.ogg"; bgs_engineUp = "myEngineUp.ogg"; bgs_engineDown = "myEngineDown.ogg";};}}
+  script_info = {bgs_engine = "myEngine.ogg"; bgs_engineUp = "myEngineUp.ogg"; bgs_engineDown = "myEngineDown.ogg";};
 Station:
-{{CodeEx|codeex=script_info = {bgs_music = "buoyRepair_music.ogg"; bgs_nocrowd = true;};}}
+  script_info = {bgs_music = "buoyRepair_music.ogg"; bgs_nocrowd = true;};
@@ Line 192: / Line 193: @@
 Example:
-{{CodeEx|codeex="BGS-COUNT" = "5";<br>"BGS-COUNTDOWN" = "bgstest";<br>"BGS-COUNTLAYER" = "bgstest";<br>"BGS-COUNTONLY" = "No";<br>"BGS-DISABLEJUMP" = "No";<br>"BGS-STATIONMUSIC_1" = "myMusicA.ogg";<br>// Without preloading<br>"BGS-CHATTER_1" = "myChatterA.ogg";<br>// With preloading<br>"BGS-CHATTER_1" = "[myChatterA]";}}
+  "BGS-COUNT" = "5";

@@ Line 158: / Line 158: @@
 :;bgs_nocrowd:Boolean. Station - disables the crowd sounds and switches images on F5.
 :;bgs_nomusic:Boolean. Station - disables the music.
 :;bgs_tunnel_shape:Number. Station - range 0.38 - 5.0. If not specified the script takes the ratio of the first found dock bounding box x/y to get the shape. See also [[#Docking FX|Docking FX]]. (New in v1.9)
 ::0.5 - square 45 degrees rotated with aspect ratio

@@ Line 102: / Line 102: @@
 === addToLRC() ===
 {{CodeEx|codeex=addToLRC( obj )}}
-Inserts a overlay as route or region. 4 different types can be used (circle, rectangle, npoly and route). Make sure that the object is extensible and not sealed or frozen.
+Inserts a overlay as route or region. 4 different types can be used (circle, rectangle, npoly and route). BGS creates a bounding box based on the used type and positions to speed up the processing. Make sure that the object is extensible and not sealed or frozen.
 '''Parameters:'''
@@ Line 213: / Line 213: @@
 The effect is done via VisualEffect entity. The model is a plane and gets scaled to fullscreen (with z = -1).
-The input texture (figure 1.1) gets wrapped around via abs(atan(y,x)) (figure 1.2). You can imagine this as a cylinder with infinite length and you are looking into it. As the shape can be adjusted we can reach square, circle and squircle (figure 1.3).
+The input texture (figure 1.1) gets wrapped around via abs(atan(y,x)) (figure 1.2). You can imagine this as a cylinder with infinite length and you are looking into it, with a mirror axis along x. As the shape can be adjusted we can reach square, circle and squircle (figure 1.3).
 The shader applies then some glowing lines and adds a opening door. Artists don't have to care much about it - the shaders does it on it's own. The interesting bit though is the coloring of the door. It's taken from the input image and walks counter-clockwise (figure 1.4). The shader rotates it and zooms in, so we get a gradient (figure 1.5). Finally it gets mixed with the glowing lines to some extend to get a smoother transition between tunnel and door and a standard tint gets applied (rgb: 0.5626,0.3587,0.0858).

@@ Line 215: / Line 215: @@
 The input texture (figure 1.1) gets wrapped around via abs(atan(y,x)) (figure 1.2). You can imagine this as a cylinder with infinite length and you are looking into it. As the shape can be adjusted we can reach square, circle and squircle (figure 1.3).
-The shader applies then some glowing lines and adds a opening door. Artists don't have to care much about it - the shaders does it on it's own. The interesting bit though is the coloring of the door. It's taken from the input image and walks counter-clockwise (figure 1.4). The shader rotates it and zooms in (figure 1.5) so we get a gradient. Finally it gets mixed with the glowing lines to some extend to get a smoother transition between tunnel and door and a standard tint gets applied (rgb: 0.5626,0.3587,0.0858).
+The shader applies then some glowing lines and adds a opening door. Artists don't have to care much about it - the shaders does it on it's own. The interesting bit though is the coloring of the door. It's taken from the input image and walks counter-clockwise (figure 1.4). The shader rotates it and zooms in, so we get a gradient (figure 1.5). Finally it gets mixed with the glowing lines to some extend to get a smoother transition between tunnel and door and a standard tint gets applied (rgb: 0.5626,0.3587,0.0858).
-All in all it does some computation (atan, length, distance and sin/cos and 2 texture lookups), but still runs smooth even on my old GeForce Go 7950. The compiler in 6.14.11.7948 spits out 128 instructions, 5 R-reg and 1 H-reg, so it's not really cheap - later cards drivers may cut this down a lot, based on the optimizations they are able to do.
+All in all it does some computation (atan, length, pow and sin/cos and 2 texture lookups), but still runs smooth even on my old GeForce Go 7950. The compiler in 6.14.11.7948 spits out 118 instructions, 5 R-reg and 1 H-reg, so it's not really cheap - later cards drivers may cut this down, based on the optimizations they are able to do.
 [[Category:OXPDoc]]

@@ Line 12: / Line 12: @@
 ==== Effects ====
-On <code>startUp</code> BGS checks the shader support level. If it's switched off or no shader support is available all effects are disabled.
+On <code>startUp</code> BGS checks the shader support level. If it's switched off or no shader support is available all effects are disabled. See also [[#Docking FX|Docking FX]].
 ==== BGS-XMapping ====
@@ Line 158: / Line 158: @@
 :;bgs_nocrowd:Boolean. Station - disables the crowd sounds and switches images on F5.
 :;bgs_nomusic:Boolean. Station - disables the music.
-:;bgs_tunnel_shape:Number. Station - range 0.38 - 5.0. If not specified the script takes the ratio of the first found dock bounding box x/y to get the shape. (New in v1.9)
+:;bgs_tunnel_shape:Number. Station - range 0.38 - 5.0. If not specified the script takes the ratio of the first found dock bounding box x/y to get the shape. See also [[#Docking FX|Docking FX]]. (New in v1.9)
 ::0.5 - square 45 degrees rotated with aspect ratio
 ::1 - circle with aspect ratio
 ::>1 - squircle...rectangle (>1.1 with decreased aspect ratio to get a wider tunnel)
-:;bgs_tunnel_texture:String/Filename. Station. (New in v1.9)
+:;bgs_tunnel_texture:String/Filename. Station. See also [[#Docking FX|Docking FX]]. (New in v1.9)
 Examples:
 Playership (with preloaded sounds):
-{{CodeEx|codeex=script_info = {"bgs_engine" = "[vector_engine]"; "bgs_engineUp" = "[vector_engineUp]"; "bgs_engineDown" = "[vector_engineDown]";};}}
+{{CodeEx|codeex=script_info = {bgs_engine = "[vector_engine]"; bgs_engineUp = "[vector_engineUp]"; bgs_engineDown = "[vector_engineDown]";};}}
 Playership (without preloaded sounds):
-{{CodeEx|codeex=script_info = {"bgs_engine" = "myEngine.ogg"; "bgs_engineUp" = "myEngineUp.ogg"; "bgs_engineDown" = "myEngineDown.ogg";};}}
+{{CodeEx|codeex=script_info = {bgs_engine = "myEngine.ogg"; bgs_engineUp = "myEngineUp.ogg"; bgs_engineDown = "myEngineDown.ogg";};}}
 Station:
-{{CodeEx|codeex=script_info = {"bgs_music" = "buoyRepair_music.ogg"; "bgs_nocrowd" = true;};}}
+{{CodeEx|codeex=script_info = {bgs_music = "buoyRepair_music.ogg"; bgs_nocrowd = true;};}}
@@ Line 200: / Line 200: @@
 :;messages:If you want to disable some onscreen messages BGS ships now a “_descriptions.plist” that cleans them out.  Rename this file to activate it. This might be useful for eSpeak users.
 :;silence:If you want to disable a specific customsounds sound set the value to “bgs-m_silence.ogg” in customsounds.plist.
 [[Category:OXPDoc]]