dkanus/Acedia
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Add events for a Singleton

Browse Source 
Add `OnCreated()` and `OnDestroyed` event functions to provide
a more simple and safe way to handle these events.
This commit is contained in:
Anton Tarasenko 2020-04-08 01:46:57 +07:00
parent 53caa5766f
commit dd0bdc8904
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
sources/Singleton.uc
View File

@ -20,10 +20,10 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with Acedia. If not, see <https://www.gnu.org/licenses/>. * along with Acedia. If not, see <https://www.gnu.org/licenses/>.
*/ */
class Singleton extends Actor class Singleton extends AcediaActor
abstract; abstract;
// Default value of this variable will store one and only existing version\ // Default value of this variable will store one and only existing version
// of actor of this class. // of actor of this class.
var private Singleton activeInstance; var private Singleton activeInstance;
@ -44,8 +44,14 @@ public final static function bool IsSingletonCreationBlocked()
return default.blockSpawning; return default.blockSpawning;
} }
protected function OnCreated(){}
protected function OnDestroyed(){}
// Make sure only one instance of 'Singleton' exists at any point in time. // Make sure only one instance of 'Singleton' exists at any point in time.
// If you overload this function in any child class - // Instead of overloading this function we suggest you overload a special
// event function `OnCreated()` that is called whenever a valid `Singleton`
// instance is spawned.
// If you absolutely must overload this function in any child class -
// first call this version of the method and then check if // first call this version of the method and then check if
// you are about to be deleted 'bDeleteMe == true': // you are about to be deleted 'bDeleteMe == true':
// ____________________________________________________________________________ // ____________________________________________________________________________
@ -57,6 +63,7 @@ public final static function bool IsSingletonCreationBlocked()
// |___________________________________________________________________________ // |___________________________________________________________________________
event PreBeginPlay() event PreBeginPlay()
{ {
super.PreBeginPlay();
if (default.blockSpawning || GetInstance() != none) if (default.blockSpawning || GetInstance() != none)
{ {
Destroy(); Destroy();
@ -64,6 +71,22 @@ event PreBeginPlay()
else else
{ {
default.activeInstance = self; default.activeInstance = self;
OnCreated();
}
}
// Make sure only one instance of 'Singleton' exists at any point in time.
// Instead of overloading this function we suggest you overload a special
// event function `OnDestroyed()` that is called whenever a valid `Singleton`
// instance is destroyed.
// If you absolutely must overload this function in any child class -
// first call this version of the method.
event Destroyed()
{
super.Destroyed();
if (self == GetInstance())
{
OnDestroyed();
} }
} }