FrameworkZ 4.4.2
Provides a framework for Project Zomboid with various systems.
Loading...
Searching...
No Matches
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 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
messagestring The message to display.
notificationTypestring The type of notification to display. See notification types.
durationinteger The duration the notification should be displayed for.
uiobject 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 ( )

◆ ProcessQueue()

void ProcessQueue ( isProcessingContinued )

Field Documentation

◆ __index

Definition at line 7 of file Notifications.lua.

◆ 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

Definition at line 11 of file Notifications.lua.

◆ Notifications

Definition at line 37 of file Notifications.lua.

◆ Queue

Definition at line 9 of file Notifications.lua.

◆ Success

FrameworkZ::Notifications::Success

Definition at line 19 of file Notifications.lua.

◆ 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: