LUA Entity:Update Function Help

[Scott Richmond]

Take a look at windmill.lua:

--Include the base script for all classes
dofile("Scripts/base.lua")


--Some global sounds we will use for all instances
squeak={}
squeak[0]=LoadSound("abstract::squeak_1.ogg")
squeak[1]=LoadSound("abstract::squeak_2.ogg")


--This function builds the interface for the properties editor
function InitDialog(grid)

<SNIP>

end


--Spawn function for creating new instances
function Spawn(model)
local entity=base_Spawn(model)

--Retrieve a few limbs we will use later
entity.blades=model:FindChild("windmill_blades")
entity.base=model:FindChild("windmill_housing")
entity.model:SetKey("spinspeed","1")

--An update function for one instance. Declaring the function as part of the entity table allows us to use "self" for the table
function entity:Update()

<SNIP>

end

end


--Update function, called during every UpdateWorld()
function Update(world)
if world==world_main then
	local model,entity
	for model,entity in pairs(entitytable) do
		if model.world==world then
			entity:Update()
		end
	end
end
end

 

Now I understand that the Update(world) function is run at every tick automatically by LE. What I don't understand is why this script redirects the Update() function to this custom entity:Update() function. Is there a specific reason for this?

[Rick]

There is a need to run code every cycle so this is just how Josh decided to do it.

[Scott Richmond]

But why create another Update function? Why not just put the code under the default Update function?

[Rick]

Because it makes the code "cleaner". I think he should have named it something else besides Update() because it can look confusing. In his other scripts he does stuff like UpdateTires() which makes more sense. In some scripts you might want to do 4 different things and putting all that inside Update() will mess that method up.

[Scott Richmond]

Ahh, I see. No problems then. Thanks Rick.