OreUI::Router Class Reference

Classes
struct	DeferredChangeNotification

Public Types
enum class	RouterPushMode : int { Normal = 0 , Flux = 1 }
enum class	RouterPushMode : int { Normal = 0 , Flux = 1 }
using	OnRouteChangedCallback

Public Member Functions
MCAPI	Router (::std::unique_ptr<::OreUI::IRouteMatcher const > routeMatcher, ::std::unique_ptr<::OreUI::IRoutePrerequisiteHandler > prerequisiteHandler, ::std::unique_ptr<::OreUI::RouterEventing > routerEventing, ::Bedrock::NotNullNonOwnerPtr<::ISceneStack > const &sceneStack)
MCAPI void	_onChange (::std::optional<::OreUI::RouterLocation > const &oldLocation, ::std::optional<::OreUI::RouterLocation > const &currentLocation)
MCAPI bool	_pushRoute (::std::string const &route, ::OreUI::Router::RouterPushMode mode)
MCAPI void	_replaceCurrentRouteInHistory (::std::string const &newRoute, ::OreUI::RouteHistoryAction action, ::std::shared_ptr<::AbstractScene > const &scene)
MCAPI ::std::optional<::OreUI::RouterLocation >	getCurrentLocation () const
MCAPI void	goBack ()
MCAPI bool	isCurrentRoute (::std::string_view route) const
MCAPI bool	replaceRoute (::std::string const &route)
MCAPI void	replaceRouteMatcher (::std::unique_ptr<::OreUI::IRouteMatcher > newRouteMatcher)
MCAPI void *	$ctor (::std::unique_ptr<::OreUI::IRouteMatcher const > routeMatcher, ::std::unique_ptr<::OreUI::IRoutePrerequisiteHandler > prerequisiteHandler, ::std::unique_ptr<::OreUI::RouterEventing > routerEventing, ::Bedrock::NotNullNonOwnerPtr<::ISceneStack > const &sceneStack)
MCAPI void	$dtor ()

Static Public Member Functions
static MCAPI ::std::add_lvalue_reference_t< char const[]>	BEDROCK_PREFIX ()

Public Attributes
::ll::TypedStorage< 8, 128, ::OreUI::RouterHistory >	mHistory
::ll::TypedStorage< 8, 8, ::std::unique_ptr<::OreUI::IRouteMatcher const > >	mRouteMatcher
::ll::TypedStorage< 8, 24, ::Bedrock::NotNullNonOwnerPtr<::ISceneStack > >	mSceneStack
::ll::TypedStorage< 8, 128, ::Bedrock::PubSub::Publisher< void(::std::optional<::OreUI::RouterLocation > const &, ::std::optional<::OreUI::RouterLocation > const &, ::OreUI::RouterAction), ::Bedrock::PubSub::ThreadModel::MultiThreaded, 0 > >	mOnRouteChangedPublisher
::ll::TypedStorage< 8, 8, ::std::unique_ptr<::OreUI::IRoutePrerequisiteHandler > >	mPrerequisiteHandler
::ll::TypedStorage< 8, 8, ::std::unique_ptr<::OreUI::RouterEventing > >	mEventing
::ll::TypedStorage< 1, 1, bool >	mIsNotifyingListeners
::ll::TypedStorage< 8, 24, ::std::vector<::OreUI::Router::DeferredChangeNotification > >	mDeferredChangeNotifications

Member Typedef Documentation

OnRouteChangedCallback

using OreUI::Router::OnRouteChangedCallback

Initial value:

void(
       ::std::optional<::OreUI::RouterLocation> const&,
       ::std::optional<::OreUI::RouterLocation> const&,
       ::OreUI::RouterAction
   )

Constructor & Destructor Documentation

Router()

MCAPI OreUI::Router::Router	(	::std::unique_ptr<::OreUI::IRouteMatcher const >	routeMatcher,
		::std::unique_ptr<::OreUI::IRoutePrerequisiteHandler >	prerequisiteHandler,
		::std::unique_ptr<::OreUI::RouterEventing >	routerEventing,
		::Bedrock::NotNullNonOwnerPtr<::ISceneStack > const &	sceneStack )

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

Member Function Documentation

_replaceCurrentRouteInHistory()

MCAPI void OreUI::Router::_replaceCurrentRouteInHistory	(	::std::string const &	newRoute,
		::OreUI::RouteHistoryAction	action,
		::std::shared_ptr<::AbstractScene > const &	scene )

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

isCurrentRoute()

MCAPI bool OreUI::Router::isCurrentRoute

(

::std::string_view

route

)

const

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

replaceRouteMatcher()

MCAPI void OreUI::Router::replaceRouteMatcher

(

::std::unique_ptr<::OreUI::IRouteMatcher >

newRouteMatcher

)

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

BEDROCK_PREFIX()

MCAPI ::std::add_lvalue_reference_t< char const []> OreUI::Router::BEDROCK_PREFIX ( )

static

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

$ctor()

MCAPI void * OreUI::Router::$ctor	(	::std::unique_ptr<::OreUI::IRouteMatcher const >	routeMatcher,
		::std::unique_ptr<::OreUI::IRoutePrerequisiteHandler >	prerequisiteHandler,
		::std::unique_ptr<::OreUI::RouterEventing >	routerEventing,
		::Bedrock::NotNullNonOwnerPtr<::ISceneStack > const &	sceneStack )

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

---

The documentation for this class was generated from the following files:

• src-server/mc/client/gui/oreui/routing/Router.h
• src-client/mc/client/gui/oreui/routing/Router.h