WoW:Using OnUpdate correctly - Revision history

Move page script: Move page script moved page Using OnUpdate correctly to WoW:Using OnUpdate correctly without leaving a redirect

2023-08-15T04:49:15Z

Move page script moved page Using OnUpdate correctly to Using OnUpdate correctly without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

WoWWiki>Egingell: /* Proper Use Example */ Added 3.0 "magic" to your_xml_file.xml

2009-11-19T20:46:13Z

Proper Use Example: Added 3.0 "magic" to your_xml_file.xml

← Older revision		Revision as of 20:46, 19 November 2009
Line 19:		Line 19:
	<Scripts>		<Scripts>
	<OnLoad>self.TimeSinceLastUpdate = 0 </OnLoad>		<OnLoad>self.TimeSinceLastUpdate = 0 </OnLoad>
	<OnUpdate> MyAddon_OnUpdate~~(self, elapsed); <~~/~~OnUpdate~~>		<OnUpdate function="MyAddon_OnUpdate" />
	</Scripts>		</Scripts>
	</Frame>		</Frame>
Line 55:		Line 55:
	end		end
	end		end

	[[Category:HOWTOs\|Use OnUpdate Correctly]]		[[Category:HOWTOs\|Use OnUpdate Correctly]]

WoWWiki>Rolandius: Updated with new information

2008-08-23T14:07:38Z

Updated with new information

← Older revision		Revision as of 14:07, 23 August 2008
Line 1:		Line 1:
			This page is a guide on '''using OnUpdate correctly'''.

	== How Often Is It Called ==		== How Often Is It Called ==
	The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.		The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.

WoWWiki>Crxi: /* How Often Is It Called , added 1 line*/

2008-08-23T13:58:15Z

How Often Is It Called , added 1 line

← Older revision		Revision as of 13:58, 23 August 2008
Line 1:		Line 1:
	== How Often Is It Called ==		== How Often Is It Called ==
	The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.		The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.
			*'''Ctrl + R''' to see the FPS on screen.
			<!---
			added: *'''Ctrl + R''' to see the FPS on screen.
			- Crixi 2008-08-23
			--->

	== When Is It Called ==		== When Is It Called ==

WoWWiki>Polarina: Using locals instead of globals. See http://www.wowwiki.com/2.0_consolidated_changes (Frame Features)

2007-10-06T12:04:03Z

Using locals instead of globals. See http://www.wowwiki.com/2.0_consolidated_changes (Frame Features)

← Older revision		Revision as of 12:04, 6 October 2007
Line 11:		Line 11:
	...		...
	<Scripts>		<Scripts>
	<OnLoad>~~this~~.TimeSinceLastUpdate = 0 </OnLoad>		<OnLoad>self.TimeSinceLastUpdate = 0 </OnLoad>
	<OnUpdate> MyAddon_OnUpdate(~~arg1~~); </OnUpdate>		<OnUpdate> MyAddon_OnUpdate(self, elapsed); </OnUpdate>
	</Scripts>		</Scripts>
	</Frame>		</Frame>
	</Ui>		</Ui>
	The important part for us is the "arg1" parameter that we're passing to our function. This is a variable that's being inherited from the WoW system telling us how long it's been since the last update call cycle.		The important part for us is the local "elapsed" (Global is arg1) parameter that we're passing to our function. This is a variable that's being inherited from the WoW system telling us how long it's been since the last update call cycle.

	; your_lua_file.lua		; your_lua_file.lua
Line 23:		Line 23:

	-- Functions Section		-- Functions Section
	function MyAddon_OnUpdate(elapsed)		function MyAddon_OnUpdate(self, elapsed)
	~~this~~.TimeSinceLastUpdate = ~~this~~.TimeSinceLastUpdate + elapsed;		self.TimeSinceLastUpdate = self.TimeSinceLastUpdate + elapsed;

	if (~~this~~.TimeSinceLastUpdate > MyAddon_UpdateInterval) then		if (self.TimeSinceLastUpdate > MyAddon_UpdateInterval) then
	--		--
	-- Insert your OnUpdate code here		-- Insert your OnUpdate code here
	--		--

	~~this~~.TimeSinceLastUpdate = 0;		self.TimeSinceLastUpdate = 0;
	end		end
	end		end
Line 37:		Line 37:

	If you're doing things that require high accuracy in the frequency of the OnUpdate calls, the above code won't be accurate since every time it is called, you will lose milliseconds as the ''TimeSinceLastUpdate'' variable is reset to 0 (If it was 1.05 seconds since last update, it would take 0.05 more seconds until the next update than it should, assuming that one hits 1.0, otherwise it would be delayed by another 0.05, etc). The below code accounts for this, and has a ''while'' structure to make sure that if the players framerate is very low, it'll still do the updates as many times as is needed.		If you're doing things that require high accuracy in the frequency of the OnUpdate calls, the above code won't be accurate since every time it is called, you will lose milliseconds as the ''TimeSinceLastUpdate'' variable is reset to 0 (If it was 1.05 seconds since last update, it would take 0.05 more seconds until the next update than it should, assuming that one hits 1.0, otherwise it would be delayed by another 0.05, etc). The below code accounts for this, and has a ''while'' structure to make sure that if the players framerate is very low, it'll still do the updates as many times as is needed.
	function MyAddon_OnUpdate(elapsed)		function MyAddon_OnUpdate(self, elapsed)
	~~this~~.TimeSinceLastUpdate = ~~this~~.TimeSinceLastUpdate + elapsed;		self.TimeSinceLastUpdate = self.TimeSinceLastUpdate + elapsed;

	while (~~this~~.TimeSinceLastUpdate > MyAddon_UpdateInterval) do		while (self.TimeSinceLastUpdate > MyAddon_UpdateInterval) do
	--		--
	-- Insert your OnUpdate code here		-- Insert your OnUpdate code here
	--		--

	~~this~~.TimeSinceLastUpdate = ~~this~~.TimeSinceLastUpdate - MyAddon_UpdateInterval;		self.TimeSinceLastUpdate = self.TimeSinceLastUpdate - MyAddon_UpdateInterval;
	end		end
	end		end

	[[Category:HOWTOs\|Use OnUpdate Correctly]]		[[Category:HOWTOs\|Use OnUpdate Correctly]]

WoWWiki>Hobinbot: demoted headings

2007-01-08T20:54:44Z

demoted headings

← Older revision		Revision as of 20:54, 8 January 2007
Line 1:		Line 1:
	=How Often Is It Called=		== How Often Is It Called ==
	The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.		The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.

	=When Is It Called =		== When Is It Called ==
	OnUpdate is not called on any hidden frames, only while they are shown on-screen. OnUpdate will also never be called on a virtual frame, but will be called on any frames that inherit from one.		OnUpdate is not called on any hidden frames, only while they are shown on-screen. OnUpdate will also never be called on a virtual frame, but will be called on any frames that inherit from one.

	=Proper Use Example=		== Proper Use Example ==
	; your_xml_file.xml		; your_xml_file.xml
	<Ui ...>		<Ui ...>

WoWWiki>WoWWiki-Guillotine at 19:23, 30 August 2006

2006-08-30T19:23:09Z

← Older revision		Revision as of 19:23, 30 August 2006
Line 11:		Line 11:
	...		...
	<Scripts>		<Scripts>
			<OnLoad>this.TimeSinceLastUpdate = 0 </OnLoad>
	<OnUpdate> MyAddon_OnUpdate(arg1); </OnUpdate>		<OnUpdate> MyAddon_OnUpdate(arg1); </OnUpdate>
	</Scripts>		</Scripts>

WoWWiki>AndreasBlixt: Added a more accurate method

2006-03-20T06:07:16Z

Added a more accurate method

← Older revision		Revision as of 06:07, 20 March 2006
Line 1:		Line 1:
	= How ~~often is it called~~ =		=How Often Is It Called=
	The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.		The game engine will call your OnUpdate function once each frame. This is (in most cases) extremely excessive.

	= When ~~is it called~~ =		=When Is It Called =
	OnUpdate is not called on any hidden frames, only while they are shown on-screen. OnUpdate will also never be called on a virtual frame, but will be called on any frames that inherit from one.		OnUpdate is not called on any hidden frames, only while they are shown on-screen. OnUpdate will also never be called on a virtual frame, but will be called on any frames that inherit from one.

	= Proper Use Example =		=Proper Use Example=
	; your_xml_file.xml		; your_xml_file.xml
			<Ui ...>
	<Ui ...>		<Frame ...>
	<Frame ~~name="MyAddon_MainFrame" parent="UIParent" hidden="false" toplevel="true"~~>		...
	...		<Scripts>
	<Scripts>		<OnUpdate> MyAddon_OnUpdate(arg1); </OnUpdate>
	<OnUpdate> MyAddon_OnUpdate(arg1); </OnUpdate>		</Scripts>
	</Scripts>		</Frame>
	</Frame>		</Ui>
	</Ui>
	The important part for us is the "arg1" parameter that we're passing to our function. This is a variable that's being inherited from the WoW system telling us how long it's been since the last update call cycle.		The important part for us is the "arg1" parameter that we're passing to our function. This is a variable that's being inherited from the WoW system telling us how long it's been since the last update call cycle.

	; your_lua_file.lua		; your_lua_file.lua
			-- Globals Section
			MyAddon_UpdateInterval = 1.0; -- How often the OnUpdate code will run (in seconds)

			-- Functions Section
			function MyAddon_OnUpdate(elapsed)
			this.TimeSinceLastUpdate = this.TimeSinceLastUpdate + elapsed;

			if (this.TimeSinceLastUpdate > MyAddon_UpdateInterval) then
			--
			-- Insert your OnUpdate code here
			--

			this.TimeSinceLastUpdate = 0;
			end
			end
			Insert your code at the '-- Insert your OnUpdate code here', and substitute the ''MyAddon_'' with your addon's name. You might also want to tweak your ''MyAddon_UpdateInterval'' global variable to reflect how often your addon needs the code run; the less the better. This solution also happens to be thread-safe, which is another issue when your code is being run every 0.1 seconds, finished or not.

	~~-- Globals Section~~		If you're doing things that require high accuracy in the frequency of the OnUpdate calls, the above code won't be accurate since every time it is called, you will lose milliseconds as the ''TimeSinceLastUpdate'' variable is reset to 0 (If it was 1.05 seconds since last update, it would take 0.05 more seconds until the next update than it should, assuming that one hits 1.0, otherwise it would be delayed by another 0.05, etc). The below code accounts for this, and has a ''while'' structure to make sure that if the players framerate is very low, it'll still do the updates as many times as is needed.
	~~MyAddon_updateInterval = 1; -- how often my~~ OnUpdate code will ~~run~~		function MyAddon_OnUpdate(elapsed)
			this.TimeSinceLastUpdate = this.TimeSinceLastUpdate + elapsed;
	~~-- Functions Section~~
	function MyAddon_OnUpdate(elapsed)		while (this.TimeSinceLastUpdate > MyAddon_UpdateInterval) do
	this.TimeSinceLastUpdate = ~~This~~.~~timeSinceLastUpdate~~ + elapsed;		--
	if (this.TimeSinceLastUpdate > ~~MyAddon_updateInterval~~) ~~then~~		-- Insert your OnUpdate code here
	--		--
	-- Insert your OnUpdate code here
	--		this.TimeSinceLastUpdate = this.TimeSinceLastUpdate - MyAddon_UpdateInterval;
	this.TimeSinceLastUpdate = 0;		end
	end		end
	end

	Insert your code at the '-- Insert your OnUpdate code here', and substitute the 'MyAddon_' with your addon's name. You might also want to tweak your 'MyAddon_updateInterval' global variable to reflect how often your addon needs the code run, the less the better. This solution also happens to be thread-safe, which is another issue when your code is being run every 0.1 seconds, finished or not.

	[[Category:HOWTOs\|Use OnUpdate Correctly]]		[[Category:HOWTOs\|Use OnUpdate Correctly]]

WoWWiki>The Nerd Wonder at 22:00, 23 January 2006

2006-01-23T22:00:51Z

← Older revision		Revision as of 22:00, 23 January 2006
Line 36:		Line 36:
	Insert your code at the '-- Insert your OnUpdate code here', and substitute the 'MyAddon_' with your addon's name. You might also want to tweak your 'MyAddon_updateInterval' global variable to reflect how often your addon needs the code run, the less the better. This solution also happens to be thread-safe, which is another issue when your code is being run every 0.1 seconds, finished or not.		Insert your code at the '-- Insert your OnUpdate code here', and substitute the 'MyAddon_' with your addon's name. You might also want to tweak your 'MyAddon_updateInterval' global variable to reflect how often your addon needs the code run, the less the better. This solution also happens to be thread-safe, which is another issue when your code is being run every 0.1 seconds, finished or not.

	[[Category:HOWTOs]]		[[Category:HOWTOs\|Use OnUpdate Correctly]]

WoWWiki>Cranius: /* Proper Use Example */

2006-01-14T14:46:32Z

Proper Use Example

← Older revision		Revision as of 14:46, 14 January 2006
Line 25:		Line 25:
	-- Functions Section		-- Functions Section
	function MyAddon_OnUpdate(elapsed)		function MyAddon_OnUpdate(elapsed)
	this.~~timeSinceLastUpdate~~ = ~~this~~.timeSinceLastUpdate + elapsed;		this.TimeSinceLastUpdate = This.timeSinceLastUpdate + elapsed;
	if (this.~~timeSinceLastUpdate~~ > MyAddon_updateInterval) then		if (this.TimeSinceLastUpdate > MyAddon_updateInterval) then
	--		--
	-- Insert your OnUpdate code here		-- Insert your OnUpdate code here
	--		--
	this.~~timeSinceLastUpdate~~ = 0;		this.TimeSinceLastUpdate = 0;
	end		end
	end		end