Class Models.Realm
The Realm class is a model that maps realms also known as servers.
Just like any other model, it's used to standardize the way addons interact with realm information.
This model will grow over time as new features are implemented in the library.
Methods
| models.realm:getCurrentRealm () | Instantiates a new Realm object with the current realm's information. |
| models.realm:setName (value) | Sets the Realm name. |
Metamethods
| models.realm:__construct () | Realm constructor. |
Methods
- models.realm:getCurrentRealm ()
-
Instantiates a new Realm object with the current realm's information.
This method acts as a constructor for the Realm model and should not be called in a realm object instance. Consider this a static builder method.
Returns:
-
Models.Realm
a new Realm object with the current realm's information
Usage:
local realm = library:getClass('Realm').getCurrentRealm()
- models.realm:setName (value)
-
Sets the Realm name.
Parameters:
- value string the Realm's name
Returns:
-
Models.Realm
self