SCR_NightModeGameModeComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_NightModeGameModeComponentClass

Functions
SCR_NightModeGameModeComponentClass SCR_BaseGameModeComponentClass	Attribute ("0", desc:"Set true if you want the GM to be able to set global nightmode. Do not change in runtime", category:"Settings")
bool	IsLocalEditorNightModeEnabled ()
void	ToggleLocalNightModeShortcut ()
void	EnableLocalEditorNightMode (bool enable, bool playSound=true)
bool	IsGlobalNightModeAllowed ()
bool	IsGlobalNightModeEnabled ()
void	EnableGlobalNightMode (bool enable, int nightModeChangerPlayerID=-1)
void	RPC_EnableGlobalNightMode (bool enable, int nightModeChangerPlayerID)
bool	IsNightModeEnabled ()
bool	CanEnableNightMode ()
void	EnableNightMode (bool enable)
void	OnEditorOpened ()
void	OnEditorClosed ()
void	OnEditorLimitedChanged (bool isLimited)
void	UpdatePreviewingTimeOrWeather ()
void	OnWeatherStatePreview (bool preview, string stateName)
void	OnWindPreview (bool preview, float windSpeed=-1, float windAngleDegrees=-1)
void	OnDateTimePreview (bool preview, int year=-1, int month=-1, int day=-1, float timeOfTheDay=-1)
ScriptInvokerBool	GetOnLocalEditorNightModeEnabledChanged ()
ScriptInvokerBool	GetOnGlobalNightModeEnabledChanged ()
ScriptInvokerBool	GetOnNightModeEnabledChanged ()
void	OnEditorManagerCreated (SCR_EditorManagerEntity editorManager)
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
	Editable Mine.
override void	OnDelete (IEntity owner)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)

Function Documentation

Attribute()

SCR_NightModeGameModeComponentClass SCR_BaseGameModeComponentClass Attribute	(	"0"	,
		desc:"Set true if you want the GM to be able to set global nightmode. Do not change in runtime"	,
		category:"Settings"	)

Definition at line 1 of file SCR_NightModeGameModeComponent.c.

CanEnableNightMode()

bool CanEnableNightMode ( )

protected

Returns

true if general night mode can be enabled

Definition at line 192 of file SCR_NightModeGameModeComponent.c.

EnableGlobalNightMode()

void EnableGlobalNightMode ( bool enable, int nightModeChangerPlayerID = -1 )

protected

Enable global night mode Note that enable might fail if the conditions are not met

Parameters

[in]	enable	To enable or not
[in]	nightModeChangerPlayerID	If a player ID is given then a notification is sent to all players if global night mode is enabled/disabled

Definition at line 142 of file SCR_NightModeGameModeComponent.c.

EnableLocalEditorNightMode()

void EnableLocalEditorNightMode ( bool enable, bool playSound = true )

protected

Enable local editor night mode Note that enable might fail if the conditions are not met

Parameters

[in]	enable	To enable or not
[in]	playSound	To play a sound or not

Definition at line 102 of file SCR_NightModeGameModeComponent.c.

EnableNightMode()

void EnableNightMode ( bool enable )

protected

Definition at line 199 of file SCR_NightModeGameModeComponent.c.

GetOnGlobalNightModeEnabledChanged()

ScriptInvokerBool GetOnGlobalNightModeEnabledChanged ( )

protected

Returns

ScriptInvoker On Global night mode enabled changed

Definition at line 348 of file SCR_NightModeGameModeComponent.c.

GetOnLocalEditorNightModeEnabledChanged()

ScriptInvokerBool GetOnLocalEditorNightModeEnabledChanged ( )

protected

Returns

ScriptInvoker On Local editor night mode enabled changed

Definition at line 338 of file SCR_NightModeGameModeComponent.c.

GetOnNightModeEnabledChanged()

ScriptInvokerBool GetOnNightModeEnabledChanged ( )

protected

Returns

ScriptInvoker On Local Editor or Global night mode enabled changed

Definition at line 358 of file SCR_NightModeGameModeComponent.c.

IsGlobalNightModeAllowed()

bool IsGlobalNightModeAllowed ( )

protected

Returns

true if scenario allows for global night mode to be enabled

Definition at line 125 of file SCR_NightModeGameModeComponent.c.

IsGlobalNightModeEnabled()

bool IsGlobalNightModeEnabled ( )

protected

Returns

true if global night mode is enabled for all players

Definition at line 132 of file SCR_NightModeGameModeComponent.c.

IsLocalEditorNightModeEnabled()

bool IsLocalEditorNightModeEnabled

(

)

Returns

true if local editor night mode is enabled

Definition at line 86 of file SCR_NightModeGameModeComponent.c.

IsNightModeEnabled()

bool IsNightModeEnabled ( )

protected

Returns

true if local editor night mode and/or global night mode is enabled

Definition at line 185 of file SCR_NightModeGameModeComponent.c.

OnDateTimePreview()

void OnDateTimePreview ( bool preview, int year = -1, int month = -1, int day = -1, float timeOfTheDay = -1 )

protected

Definition at line 331 of file SCR_NightModeGameModeComponent.c.

OnDelete()

override void OnDelete ( IEntity owner )

protected

Definition at line 451 of file SCR_NightModeGameModeComponent.c.

OnEditorClosed()

void OnEditorClosed ( )

protected

Definition at line 253 of file SCR_NightModeGameModeComponent.c.

OnEditorLimitedChanged()

void OnEditorLimitedChanged ( bool isLimited )

protected

Definition at line 266 of file SCR_NightModeGameModeComponent.c.

OnEditorManagerCreated()

void OnEditorManagerCreated ( SCR_EditorManagerEntity editorManager )

protected

Definition at line 367 of file SCR_NightModeGameModeComponent.c.

OnEditorOpened()

void OnEditorOpened ( )

protected

Definition at line 244 of file SCR_NightModeGameModeComponent.c.

OnWeatherStatePreview()

void OnWeatherStatePreview ( bool preview, string stateName )

protected

Definition at line 319 of file SCR_NightModeGameModeComponent.c.

OnWindPreview()

void OnWindPreview ( bool preview, float windSpeed = -1, float windAngleDegrees = -1 )

protected

Definition at line 325 of file SCR_NightModeGameModeComponent.c.

RPC_EnableGlobalNightMode()

void RPC_EnableGlobalNightMode ( bool enable, int nightModeChangerPlayerID )

protected

Definition at line 158 of file SCR_NightModeGameModeComponent.c.

RplLoad()

override bool RplLoad ( ScriptBitReader reader )

protected

Definition at line 485 of file SCR_NightModeGameModeComponent.c.

RplSave()

override bool RplSave ( ScriptBitWriter writer )

protected

Definition at line 476 of file SCR_NightModeGameModeComponent.c.

ToggleLocalNightModeShortcut()

void ToggleLocalNightModeShortcut ( )

protected

Definition at line 92 of file SCR_NightModeGameModeComponent.c.

UpdatePreviewingTimeOrWeather()

void UpdatePreviewingTimeOrWeather ( )

protected

Definition at line 274 of file SCR_NightModeGameModeComponent.c.