Inheritance diagram for SCR_MoonPhaseUIInfo:

[legend]

Public Member Functions
string	GetSimplifiedName ()
	Get Simplified Name rather then full Waxing or waning Crescent it will just return Crescent.

void	SetMoonphaseImageRotation (bool northernHemisphere)
	Set rotation of Moon image.

float	GetMoonphaseImageRotation ()
	Get rotation of Moon image.

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

string	GetIconSetName ()
	Returns Icon Set name if imageset.

bool	HasIcon ()
	Check if the info has an icon defined.

bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.

void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.

LocalizedString	GetDescription ()
	Get description.

bool	HasDescription ()
	Check if the info has a description defined.

bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.

void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.

LocalizedString	GetName ()
	Get name.

bool	HasName ()
	Check if the info has a name defined.

bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Protected Attributes
LocalizedString	m_sSimplifiedName

float	m_fMoonphaseImageRotation = 0

Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon

string	IconSetName

Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description

Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.

static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.

static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.

static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Member Function Documentation

◆ GetMoonphaseImageRotation()

float SCR_MoonPhaseUIInfo.GetMoonphaseImageRotation ( )

Get rotation of Moon image.

This will return 0 if UIInfo was set to northern Hemisphere and 180 if southern Hemisphere Use TimeAndWeatherManagerEntity.GetMoonPhaseInfoForDate() to make sure the value is set correctly

Returns: rotation of image

◆ GetSimplifiedName()

string SCR_MoonPhaseUIInfo.GetSimplifiedName ( )

Get Simplified Name rather then full Waxing or waning Crescent it will just return Crescent.

Returns: simplified moon phase

◆ SetMoonphaseImageRotation()

void SCR_MoonPhaseUIInfo.SetMoonphaseImageRotation ( bool northernHemisphere )

Set rotation of Moon image.

This is set to 0 if Northern Hemisphere and 180 if southern Hemisphere

Parameters

if	is northern or southern Hemisphere

Member Data Documentation

◆ m_fMoonphaseImageRotation

float SCR_MoonPhaseUIInfo.m_fMoonphaseImageRotation = 0

protected

◆ m_sSimplifiedName

LocalizedString SCR_MoonPhaseUIInfo.m_sSimplifiedName

protected

The documentation for this interface was generated from the following file:

Game/Editor/Containers/UIInfo/SCR_MoonPhaseUIInfo.c

Public Member Functions

Protected Attributes