Class ActorRef

• Defined in File Actor.hpp

Class Documentation

class ActorRef

An handle for Actors to control world tree ownership.

Public Functions

inline ActorRef()

Create a new “null” ActorRef that is invalid.

Actor *operator->()

Access the underlying Actor.

Throws:

NonexistentValueException – If this handle is invalid

Returns:

A non-owning pointer to the Actor object

const Actor *operator->() const

Access the underlying Actor constly.

Throws:

NonexistentValueException – If this handle is invalid

Returns:

A non-owning pointer to the Actor object

World *GetWorld()

Access the World containing the underlying Actor.

Throws:

NonexistentValueException – If this handle is invalid

Returns:

A non-owning pointer to the World object

const World *GetWorld() const

Constly access the World containing the underlying Actor.

Throws:

NonexistentValueException – If this handle is invalid

Returns:

A non-owning pointer to the World object

operator bool() const noexcept

Check if this handle is valid.

Returns:

Whether this handle is managing a living Actor or not (null handle or destroyed actor)

bool operator==(const ActorRef &rhs) const noexcept

Check if two handles are equal (that is, they reference the same Actor or are both null)

Returns:

If the handles are equal