0 votes

Hi I am trying this

var level = 1 setget set_level

func ready():
    level = 2

func set_level(lvl):
    print(level) # it does not print anything

Actually I don't know how to use it and what is it used for
Thanks!

Godot version v3.2.3-stable_win64
in Engine by (885 points)

1 Answer

+2 votes
Best answer

Setget is used to validate a property when it is called from outside the class. It is not called locally because if you are editing the class it is assumed that you are the owner or have full access to it. But when the property is modified from outside (an instance of the class or another referenced script or an export) the set function is called if it is defined for that property. Some examples:

class TestSetGet:
        var prop = 0 setget set_prop
        func set_prop(p):
            prop = p + 1000

    func _ready() -> void:
        var test = TestSetGet.new()
        test.prop = 5
        print (test.prop) #print 1005

https://docs.godotengine.org/en/stable/getting_started/scripting/gdscript/gdscript_basics.html#setters-getters

extends Node2D #This is a class with no name

var number = 0 setget set_number

func set_number(num):
    if num > 5:
        num = 5 
    number = num    



func _ready() -> void:
    number = 15 #access local, not trigger the setter and getter 
    print(number) #print 15
    self.number = 15 #access outside whit self
    print(number) #print 5
    pass
by (2,100 points)
selected by

Thanks a lot!
But is there any benefit of it

Probably one can also call the function set_number(15) directly

I create a Stats class that defines the attributes of a character.
In that class I create the variable level. Then I instantiate the class in each character in my game and assign a value to it:
var st = Stats.new ()
st.level = 1
Later I want to add the strenght property to each character depending on the level. If I use a set function in the level variable I can assign the value of the strenght in this function for example:
strenght = 2 * level
Now every time my character levels up his strength will be multiplied by two automatically.
If later I want to use another formula to calculate the strenght attribute, I just have to modify the set function of the class. This benefits as the project grows in size. This is called encapsulation in object-oriented programming.

https://en.wikipedia.org/wiki/Object-oriented_programming

There are more benefits that you discover as you learn and you want to have everything better organized. But at the end of the day the one who decides the final implementation is yourself.

I wish that I can upvote your comment.
Now I believe using setget is far more better than calling 6 or more functions. My project is already very large and I need to use this smart way

Thanks a lot man!!

Welcome to Godot Engine Q&A, where you can ask questions and receive answers from other members of the community.

Please make sure to read How to use this Q&A? before posting your first questions.
Social login is currently unavailable. If you've previously logged in with a Facebook or GitHub account, use the I forgot my password link in the login box to set a password for your account. If you still can't access your account, send an email to webmaster@godotengine.org with your username.