When to use self? When to use local?

Questions
#1

Whats the main difference between using self and local to declare variables?

When is one more appropriate than the other?

My current working understanding is that local would be best used inside of function/if blocks

and self would be a kind of global variable within the scope of a script/gameobject.

I’d appreciate help to expand my understanding, thanks.

#2

If you would create a local variable in a script like this:

local speed = 1

function update(self, dt)
speed = speed + 1 * dt
end

it would be a problem as soon as you use several instances of the same gameobject as they would all refer to the same variable ‘speed’. If you had 5 cars with this script speed would be updated 5 times in the same frame and all cars would have the same speed.

If you on the other hand would do this:

function init(self)
self.speed = 0
end

function update(self, dt)
self.speed = self.speed + 1 * dt
end

Here all the cars will have an individual speed in self.speed.

Conclusion.
self is an instance variable meanwhile local will be shared with all using the same script.

7 Likes
#3

What about a local variable defined within a statement block?

i.e.

if foo == false then
   local speed = random(1,5)
   --do something with speed
end

so the variable is recreated and would be unique on a per instance basis. yes?

Also i understand that self is on a per instance basis.

However is there any difference between

self.speed = 5
--and
go.property("speed", 5)

besides being viewable in the inspector?

Thanks for answering

#4

Correct. A local variable is available only in the block where it is declared. It’s only local variables declared outside the scope of the init(), final(), update() etc that are available to all scripts of the same type. Consider them similar to private static variable declarations in a Java class or something similar.

A go.property() declared variable is accessible by other scripts using go.get().

2 Likes
#5

Very eye opening.

I can truely see where I need to change my code to make it more efficent and avoid slip ups.

Thanks for the info

#6

More info Best practice: Local variable or go.property?

1 Like
Variables - Self vs. Local (SOLVED)
#7

So is it considered good practice to use local variables declared outside a block - or better to use go.property() instead? Just trying to parse this further.

#8

This is what I usually do:

go.property(“foobar”, 123)
If would primarily use go.property() when I need a variable on a script to vary between script instances (eg changed from the Properties window or when passed as an argument to factory.create)

self.foobar = 123
I would use this for any other instance variable that I need on my scripts

local foobar = 123
I use local variables declared at the top level of a script for stuff I need to share between multiple instances of the same type of script. This can be some kind of shared counter or perhaps a shared list of instances so I can do things like broadcasting to all script instances of a certain type.

8 Likes