Oolite JavaScript Reference: VisualEffect - Revision history

Phkb: /* beaconCode */

2023-09-19T09:38:27Z

‎beaconCode

Massively Locked: /* scannerDisplayColor1 */ uniform null format

2022-10-29T21:17:25Z

‎scannerDisplayColor1: uniform null format

Massively Locked: replaced "function" (x2)

2022-10-28T18:23:34Z

replaced "function" (x2)

Massively Locked: /* isBreakPattern */ uniform boolean format

2022-10-27T01:51:26Z

‎isBreakPattern: uniform boolean format

Cim: /* Properties */

2013-10-12T13:56:54Z

‎Properties

Cim: /* isBreakPattern */ Typo

2013-01-23T07:25:44Z

‎isBreakPattern: Typo

Cim: 1.77

2013-01-08T17:38:03Z

1.77

Cim: /* scaleX, scaleY, scaleZ */ clarify flashers with r5505

2012-11-16T23:13:11Z

‎scaleX, scaleY, scaleZ: clarify flashers with r5505

Cim: subEntities / restoreSubEntities

2012-11-12T15:58:41Z

subEntities / restoreSubEntities

Cim: /* Properties */ Fix formatting

2012-11-08T18:34:36Z

‎Properties: Fix formatting

@@ Line 7: / Line 7: @@
 === <code>beaconCode</code> ===
-  '''beaconCode''' : String (read-write)
+  '''beaconCode''' : String (read/write)
 If the effect is a beacon, an identifying string. The first character is used for identification on the [[Advanced Space Compass]]. For non-beacons, this property is <code>null</code>.

@@ Line 43: / Line 43: @@
 The first of two colours used by the ship’s scanner “lollipop”. When read, this will always be an array of four numbers in the range 0..1 (representing red, green, blue and alpha components). Any colour specifier format may be assigned to it. Assigning <code>null</code> will restore the value from [[effectdata.plist]].
-If both this and <code>scannerDisplayColor2</code> are set to null, and no value is set for either in [[effectdata.plist]] then the effect will not appear on scanners.
+If both this and <code>scannerDisplayColor2</code> are set to <code>null</code>, and no value is set for either in [[effectdata.plist]] then the effect will not appear on scanners.
 '''See also:''' <code>[[#scannerDisplayColor2|scannerDisplayColor2]]</code>

@@ Line 102: / Line 102: @@
 Multiplies the size of the visual effect by <code>factor</code>. Subentities will be rescaled as well, and moved further from the centre of the effect as appropriate. An error will occur if <code>factor</code> is less than or equal to zero.
-Note that this function resizes relative to the objects ''original'' size, not its current size. <code>scale(1)</code> will therefore always return to the original size.
+Note that this method resizes relative to the objects ''original'' size, not its current size. <code>scale(1)</code> will therefore always return to the original size.
 === <code>setMaterials</code> ===
@@ Line 127: / Line 127: @@
 === <code>effectRemoved</code> ===
-The <code>effectRemoved</code> handler is called when the effect is removed from the universe, either by the [[#remove|remove]] function, or automatically when the player leaves the system. This is a good place to clean up any frame callbacks or timers associated with this effect.
+The <code>effectRemoved</code> handler is called when the effect is removed from the universe, either by the [[#remove|remove]] method or automatically when the player leaves the system. This is a good place to clean up any frame callbacks or timers associated with this effect.
   this.effectRemoved = function()

@@ Line 25: / Line 25: @@
 === <code>isBreakPattern</code> ===
   '''isBreakPattern''' : Boolean (read/write)
-If this is true, the VisualEffect object will remain visible while break patterns on docking, launching or witchspace are being displayed (or not displayed). Normally all objects other than the break pattern itself are hidden.
+If this is <code>true</code>, the VisualEffect object will remain visible while break patterns on docking, launching or witchspace are being displayed (or not displayed). Normally all objects other than the break pattern itself are hidden.
 === <code>scaleX</code>, <code>scaleY</code>, <code>scaleZ</code> ===

@@ Line 4: / Line 4: @@
 == Properties ==
-{{oolite-prop-added|1.77}}
+Unless otherwise stated {{oolite-prop-added|1.77}}
 === <code>beaconCode</code> ===
   '''beaconCode''' : String (read-write)
 If the effect is a beacon, an identifying string. The first character is used for identification on the [[Advanced Space Compass]]. For non-beacons, this property is <code>null</code>.
 === <code>dataKey</code> ===
@@ Line 54: / Line 59: @@
 === <code>scriptInfo</code> ===
   '''scriptInfo''' : Object (read-only)
-The contents of the <code>script_info</code> key in the effect’s ''[[effectdata.plist]]'' entry, if any. This may be any [[property list]] object, but the reccomended approach is to use a dictionary whose keys have a unique prefix (such as you should be using for file names, ship names etc.). A property list dictionary is converted to a JavaScript object with properties corresponding to the dictionary’s keys. All other property list types used with Oolite have directly corresponding JavaScript types.<br>
+The contents of the <code>script_info</code> key in the effect’s ''[[effectdata.plist]]'' entry, if any. This may be any [[property list]] object, but the recommended approach is to use a dictionary whose keys have a unique prefix (such as you should be using for file names, ship names etc.). A property list dictionary is converted to a JavaScript object with properties corresponding to the dictionary’s keys. All other property list types used with Oolite have directly corresponding JavaScript types.<br>
 When using numeric values in the scriptInfo, the JS engine is not able to detect the type reliably on all systems, so you always must explicitly convert its content to a number by using parseInt(scriptInfo.myKey) or parseFloat(scriptInfo.myKey).

← Older revision		Revision as of 17:38, 8 January 2013
Line 1:		Line 1:
−	~~'''This is a new class planned for 1.77 and may be subject to significant change before 1.77 is released.'''~~
−
	<small>'''Prototype:''' <code>[[Oolite JavaScript Reference: Entity\|Entity]]</code></small><br />		<small>'''Prototype:''' <code>[[Oolite JavaScript Reference: Entity\|Entity]]</code></small><br />

@@ Line 29: / Line 29: @@
   '''scaleZ''' : positive Float (read/write)
-Adjust the apparent size of the visual effect along each of its main axes. Subentity visual effects will be repositioned and rescaled accordingly. Subentity flashers will be repositioned, but not rescaled (as flashers are always spherical).
+Adjust the apparent size of the visual effect along each of its main axes. Subentity visual effects will be repositioned and rescaled accordingly. Subentity flashers will be repositioned and resized to keep a roughly proportionate volume, but not rescaled (as flashers are always spherical).
   effect.scaleX = effect.scaleY = effect.scaleZ = newsize;

@@ Line 67: / Line 67: @@
   '''shaderVector2''' : Vector (read/write)
 Since visual effects have very few intrinsic properties, some arbitrary parameters which may be bound as shader uniforms are provided.
 == Methods ==
@@ Line 86: / Line 90: @@
   function '''remove'''()
 Immediately removes the effect from the universe.
 === <code>scale</code> ===
@@ Line 114: / Line 122: @@
 Effects scripts have one property, <code>this.visualEffect</code>, which is a reference to the visual effect this is a script for. They have the following event handlers.
-=== effectRemoved ===
+=== <code>effectRemoved</code> ===
 The <code>effectRemoved</code> handler is called when the effect is removed from the universe, either by the [[#remove|remove]] function, or automatically when the player leaves the system. This is a good place to clean up any frame callbacks or timers associated with this effect.
@@ Line 123: / Line 131: @@
+  }
-=== effectSpawned ===
+=== <code>effectSpawned</code> ===
 The <code>effectSpawned</code> handler is called on the first update after the effect is added to the universe.

@@ Line 8: / Line 8: @@
 {{oolite-prop-added|1.77}}
-=== beaconCode ===
+=== <code>beaconCode</code> ===
   '''beaconCode''' : String (read-write)
 If the effect is a beacon, an identifying string. The first character is used for identification on the [[Advanced Space Compass]]. For non-beacons, this property is <code>null</code>.
-=== dataKey ===
+=== <code>dataKey</code> ===
   '''dataKey''' : String (read-only)
 The data key from [[effectdata.plist]] used to generate this visual effect.
-=== hullHeatLevel ===
+=== <code>hullHeatLevel</code> ===
   '''hullHeatLevel''' : Float (read/write)
 While visual effects do not have a temperature as such, this property is provided to allow easy compatibility with the default Oolite shader for ships.
-=== isBreakPattern ===
+=== <code>isBreakPattern</code> ===
   '''allowsDocking''' : Boolean (read/write)
 If this is true, the VisualEffect object will remain visible while break patterns on docking, launching or witchspace are being displayed (or not displayed). Normally all objects other than the break pattern itself are hidden.