Oolite JavaScript Reference: Timer - Revision history

Debresser: Page moved. No need for _ in links.

2016-01-16T20:35:26Z

Page moved. No need for _ in links.

Timer at 10:13, 31 July 2014

2014-07-31T10:13:28Z

Cim: /* Constructor */ Note use of entityDestroyed

2012-04-09T14:49:54Z

‎Constructor: Note use of entityDestroyed

Eric Walch: /* stop */

2011-10-12T12:19:07Z

‎stop

Eric Walch: Added warnig about deleting running timers.

2011-10-12T12:15:46Z

Added warnig about deleting running timers.

Ahruman at 20:40, 20 February 2011

2011-02-20T20:40:29Z

Ahruman: Fixed dangling small

2010-06-28T08:38:53Z

Fixed dangling small

Ahruman: Updated for 1.74.

2010-06-28T08:38:33Z

Updated for 1.74.

Ahruman: Moving Oolite JS reference into a correctly-named subcategory of Oolite scripting.

2010-06-19T14:07:17Z

Moving Oolite JS reference into a *correctly-named* subcategory of Oolite scripting.

Ahruman: Moving Oolite JS reference into a subcategory of Oolite scripting.

2010-06-19T13:59:25Z

Moving Oolite JS reference into a subcategory of Oolite scripting.

@@ Line 12: / Line 12: @@
 If <code>delay</code> is negative and <code>interval</code> is positive, the timer will initially be stopped. After it is start, it will fire at multiples of <code>interval</code> after its creation time. For instance, if a timer is created stopped with a five-second interval, and started after seven seconds, it will fire after ten seconds.
-If the <code>this</code> parameter becomes invalid (usually because it’s attached to a ship that’s destroyed, or left behind when the player executes a hyperspace jump), the timer will be stopped and removed automatically. You should use [[Oolite_JavaScript_Reference:_ship_script_event_handlers#entityDestroyed|entityDestroyed]] in ship scripts to clean up timers.
+If the <code>this</code> parameter becomes invalid (usually because it’s attached to a ship that’s destroyed, or left behind when the player executes a hyperspace jump), the timer will be stopped and removed automatically. You should use [[Oolite JavaScript Reference: Ship script event handlers#entityDestroyed|entityDestroyed]] in ship scripts to clean up timers.
 == Properties ==

@@ Line 4: / Line 4: @@
 '''Timer''' objects are used to perform tasks after a delay or on a repeating schedule. When a timer is created, it is given a function to call, and a ''delay'' and an optional ''interval'' in seconds in [[Time scales in Oolite#Game real time|game real time]]. The ''next fire time'' of the timer is set to the current time + the delay. When the game clock reaches (or passes) the next fire time, the function is called. If the timer has a positive interval, the interval is added to the next fire time. Otherwise, the timer stops.
-'''Note:''' in order for a timer to work consistently, you must keep a reference to it as long as it is in use. The easiest way is to make it a property of your script: <code>this.timer = new Timer(this, this.doSomething, 5, 5)</code>. If this is not done, the JavaScript runtime may delete the timer at any time to free up memory.
+'''Note:''' in order for a timer to work consistently, you must keep a reference to it as long as it is in use. The easiest way is to make it a property of your script: <code>this._timer = new Timer(this, this.doSomething, 5, 5)</code>. If this is not done, the JavaScript runtime may delete the timer at any time to free up memory.
 == Constructor ==

@@ Line 12: / Line 12: @@
 If <code>delay</code> is negative and <code>interval</code> is positive, the timer will initially be stopped. After it is start, it will fire at multiples of <code>interval</code> after its creation time. For instance, if a timer is created stopped with a five-second interval, and started after seven seconds, it will fire after ten seconds.
-If the <code>this</code> parameter becomes invalid (usually because it’s attached to a ship that’s destroyed, or left behind when the player executes a hyperspace jump), the timer will be stopped and removed automatically.
+If the <code>this</code> parameter becomes invalid (usually because it’s attached to a ship that’s destroyed, or left behind when the player executes a hyperspace jump), the timer will be stopped and removed automatically. You should use [[Oolite_JavaScript_Reference:_ship_script_event_handlers#entityDestroyed|entityDestroyed]] in ship scripts to clean up timers.
 == Properties ==

@@ Line 36: / Line 36: @@
 Stops the timer, if it is currently running.
-Important: Always stop a timer before deleting its JS reference, or the object will stay around in a timer queue and will keep firing. The timer than will only stop with an error when the script it belongs to no longer exists.
+Important: Always stop a timer before deleting its JS reference, or a copy of the object will stay around in a timer queue and will keep firing. Without explicit stopping, the timer will only stop with an error when the script it belongs to no longer exists.
 [[Category:Oolite JavaScript Reference]]

@@ Line 35: / Line 35: @@
  function '''stop'''()
 Stops the timer, if it is currently running.
 [[Category:Oolite JavaScript Reference]]

@@ Line 9: / Line 9: @@
  '''new Timer'''(this : Object, function : Function, delay : Number [, interval : Number]) : Timer
 Creates a new timer which will call <code>function</code> after <code>delay</code> seconds, and optionally repeatedly every <code>interval</code> seconds. If <code>delay</code> is zero or more, the timer will be started automatically. If <code>interval</code> is 0 or less, the timer will not repeat. If <code>interval</code> is greater than 0 but less than 0.25, it will be rounded up to 0.25.
 If the <code>this</code> parameter becomes invalid (usually because it’s attached to a ship that’s destroyed, or left behind when the player executes a hyperspace jump), the timer will be stopped and removed automatically.

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
-<small>'''Subtypes:''' none
+<small>'''Subtypes:''' none</small>
 '''Timer''' objects are used to perform tasks after a delay or on a repeating schedule. When a timer is created, it is given a function to call, and a ''delay'' and an optional ''interval'' in seconds in [[Time scales in Oolite#Game real time|game real time]]. The ''next fire time'' of the timer is set to the current time + the delay. When the game clock reaches (or passes) the next fire time, the function is called. If the timer has a positive interval, the interval is added to the next fire time. Otherwise, the timer stops.

← Older revision		Revision as of 14:07, 19 June 2010
Line 97:		Line 97:
	'''N.B.:''' as of Oolite 1.74, timers will be removed automatically by Oolite when the 'this' object goes out of scope, without the need to use any of these examples.		'''N.B.:''' as of Oolite 1.74, timers will be removed automatically by Oolite when the 'this' object goes out of scope, without the need to use any of these examples.

−	[[Category:Oolite JavaScript ~~reference~~]]	+	[[Category:Oolite JavaScript Reference]]

← Older revision		Revision as of 13:59, 19 June 2010
Line 97:		Line 97:
	'''N.B.:''' as of Oolite 1.74, timers will be removed automatically by Oolite when the 'this' object goes out of scope, without the need to use any of these examples.		'''N.B.:''' as of Oolite 1.74, timers will be removed automatically by Oolite when the 'this' object goes out of scope, without the need to use any of these examples.

−	[[Category:Oolite ~~scripting~~]]	+	[[Category:Oolite JavaScript reference]]