Inheritance diagram for SoundComponent:

Classes
struct	SoundEventInfo

Public Member Functions
virtual ::std::unique_ptr<::UIComponent >	clone (::UIControl &cloneOwner) const
virtual void	reset ()
virtual::ComponentReceiveActionType	receive (::ScreenEvent const &screenEvent)
virtual::ComponentReceiveActionType	receive (::VisualTree &visualTree, ::ScreenInputContext &context, ::UIAnimationController &animationController, ::ScreenEvent const &screenEvent)
MCAPI void	addSoundEvent (::std::string const &soundName, float volume, float pitch, ::std::chrono::milliseconds minTimeBetweenPlays, ::ScreenEventType screenEventType, ::SoundEventConditions const &screenEventConditions)
MCAPI ::std::unique_ptr<::UIComponent >	$clone (::UIControl &cloneOwner) const
MCAPI void	$reset ()
MCAPI::ComponentReceiveActionType	$receive (::ScreenEvent const &screenEvent)
MCAPI::ComponentReceiveActionType	$receive (::VisualTree &visualTree, ::ScreenInputContext &context, ::UIAnimationController &animationController, ::ScreenEvent const &screenEvent)
virtual void	onNotifyChildAdded ()
virtual void	onNotifyChildRemoved ()
virtual void	onRemoved ()
virtual void	onAdded ()
virtual void	onVisibilityChanged (bool visible)
virtual void	onEnabledChanged (bool enabled)
virtual bool	isRenderableComponent () const
virtual bool	isCustomFrameUpdateComponent () const
virtual bool	onLayoutChange ()
virtual void	reload (::UIComponent const &rhs)
virtual::std::string const &	getTextToSpeechComponentValue () const
MCAPI void	$onNotifyChildAdded ()
MCAPI void	$onNotifyChildRemoved ()
MCAPI void	$onRemoved ()
MCAPI void	$onAdded ()
MCAPI void	$onVisibilityChanged (bool visible)
MCAPI void	$onEnabledChanged (bool enabled)
MCAPI bool	$isRenderableComponent () const
MCAPI bool	$isCustomFrameUpdateComponent () const
MCAPI bool	$onLayoutChange ()
MCAPI void	$reload (::UIComponent const &rhs)
MCAPI::std::string const &	$getTextToSpeechComponentValue () const

Public Attributes
::ll::TypedStorage< 8, 8, ::UISoundPlayer const * >	mSoundPlayer
::ll::TypedStorage< 4, 4, float >	mVolume
::ll::TypedStorage< 4, 4, float >	mPitch
::ll::TypedStorage< 8, 32, ::std::string >	mSoundName
::ll::TypedStorage< 8, 24, ::std::vector<::SoundComponent::SoundEventInfo > >	mSoundEvents
::ll::TypedStorage< 8, 8, ::UIControl & >	mOwner

Member Function Documentation

◆ clone()

virtual ::std::unique_ptr<::UIComponent > SoundComponent::clone ( ::UIControl & cloneOwner ) const

virtual

Implements UIComponent.

◆ reset()

virtual void SoundComponent::reset ( )

virtual

Implements UIComponent.

◆ addSoundEvent()

MCAPI void SoundComponent::addSoundEvent	(	::std::string const &	soundName,
		float	volume,
		float	pitch,
		::std::chrono::milliseconds	minTimeBetweenPlays,
		::ScreenEventType	screenEventType,
		::SoundEventConditions const &	screenEventConditions )

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.

◆ $clone()

MCAPI ::std::unique_ptr<::UIComponent > SoundComponent::$clone ( ::UIControl & cloneOwner ) 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.

◆ $reset()

MCAPI void SoundComponent::$reset ( )

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.

◆ $receive() [1/2]

MCAPI::ComponentReceiveActionType SoundComponent::$receive ( ::ScreenEvent const & screenEvent )

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.

◆ $receive() [2/2]

MCAPI::ComponentReceiveActionType SoundComponent::$receive	(	::VisualTree &	visualTree,
		::ScreenInputContext &	context,
		::UIAnimationController &	animationController,
		::ScreenEvent const &	screenEvent )

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.

◆ $onNotifyChildAdded()

MCAPI void UIComponent::$onNotifyChildAdded ( )

inherited

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.

◆ $onNotifyChildRemoved()

MCAPI void UIComponent::$onNotifyChildRemoved ( )

inherited

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.

◆ $onRemoved()

MCAPI void UIComponent::$onRemoved ( )

inherited

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.

◆ $onAdded()

MCAPI void UIComponent::$onAdded ( )

inherited

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.

◆ $onVisibilityChanged()

MCAPI void UIComponent::$onVisibilityChanged ( bool visible )

inherited

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.

◆ $onEnabledChanged()

MCAPI void UIComponent::$onEnabledChanged ( bool enabled )

inherited

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.

◆ $isRenderableComponent()

MCAPI bool UIComponent::$isRenderableComponent ( ) const

inherited

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.

◆ $isCustomFrameUpdateComponent()

MCAPI bool UIComponent::$isCustomFrameUpdateComponent ( ) const

inherited

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.

◆ $onLayoutChange()

MCAPI bool UIComponent::$onLayoutChange ( )

inherited

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.

◆ $reload()

MCAPI void UIComponent::$reload ( ::UIComponent const & rhs )

inherited

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.

◆ $getTextToSpeechComponentValue()

MCAPI::std::string const & UIComponent::$getTextToSpeechComponentValue ( ) const

inherited

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/controls/SoundComponent.h
src-client/mc/client/gui/controls/SoundComponent.h

Classes

Public Member Functions

Public Attributes

Member Function Documentation

◆ clone()

◆ reset()

◆ addSoundEvent()

◆ $clone()

◆ $reset()

◆ $receive() [1/2]

◆ $receive() [2/2]

◆ $onNotifyChildAdded()

◆ $onNotifyChildRemoved()

◆ $onRemoved()

◆ $onAdded()

◆ $onVisibilityChanged()

◆ $onEnabledChanged()

◆ $isRenderableComponent()

◆ $isCustomFrameUpdateComponent()

◆ $onLayoutChange()

◆ $reload()

◆ $getTextToSpeechComponentValue()