FrameworkZ::Notifications Class Reference

Notifications module for FrameworkZ. Queues and sends notifications. More...

Public Member Functions
object	AddToQueue (message, notificationType, duration, ui)
	Adds a notification to the queue.
void	OnGameStart ()
void	PlayerTick (isoPlayer)
void	ProcessQueue (isProcessingContinued)

Data Fields
FrameworkZ Notifications	__index
FrameworkZ Notifications	Colors
	Danger
	Default
	Info
FrameworkZ Notifications	List
FrameworkZ	Notifications
FrameworkZ Notifications	Queue
	Success
FrameworkZ Notifications	Types
	Warning

Detailed Description

Notifications module for FrameworkZ. Queues and sends notifications.

Definition at line 5 of file Notifications.lua.

Member Function Documentation

AddToQueue()

object AddToQueue	(	message	,
		notificationType	,
		duration	,
		ui	)

Adds a notification to the queue.

Parameters

message	string The message to display.
notificationType	string The type of notification to display. See notification types.
duration	integer The duration the notification should be displayed for.
ui	object The UI object that would cover where notifications display. Useful if you want to display notifications over top of a specific UI object.

Returns

object The notification UI object.

OnGameStart()

void OnGameStart

(

)

PlayerTick()

void PlayerTick

(

isoPlayer

)

ProcessQueue()

void ProcessQueue

(

isProcessingContinued

)

Field Documentation

__index

FrameworkZ Notifications __index

Definition at line 7 of file Notifications.lua.

Colors

FrameworkZ Notifications Colors

Definition at line 25 of file Notifications.lua.

Danger

FrameworkZ::Notifications::Danger

Definition at line 23 of file Notifications.lua.

Default

FrameworkZ::Notifications::Default

Definition at line 15 of file Notifications.lua.

Info

FrameworkZ::Notifications::Info

Definition at line 17 of file Notifications.lua.

List

FrameworkZ Notifications List

Definition at line 11 of file Notifications.lua.

Notifications

FrameworkZ Notifications

Definition at line 37 of file Notifications.lua.

Queue

FrameworkZ Notifications Queue

Definition at line 9 of file Notifications.lua.

Success

FrameworkZ::Notifications::Success

Definition at line 19 of file Notifications.lua.

Types

FrameworkZ Notifications Types

Definition at line 13 of file Notifications.lua.

Warning

FrameworkZ::Notifications::Warning

Definition at line 21 of file Notifications.lua.

---

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

• Notifications.lua