FrameworkZ API Documentation - FrameworkZ.Notifications

Home / FrameworkZ.Notifications Module

FrameworkZ.Notifications

module

Notifications module for FrameworkZ. Queues and sends notifications.

0
Functions
4
Methods
3
Fields

📋 On This Page

Fields

3
FrameworkZ.Notifications 📋 table
Notifications module for FrameworkZ. Queues and sends notifications.
Initial value: {}
FrameworkZ.Notifications.Colors 📋 table inferred
Initial value: { Default = {r = 1, g = 1, b = 1, a = 1}, Info = {r = 0.051, g = 0.792, b = 0.941, a = 1}, Success = {r = 0.098, g = 0.529, b = 0.329, a = 1}, Warning = {r = 1, g = 0.757, b = 0.027, a = 1}, Danger = {r = 0.863, g = 0.208, b = 0.271, a = 1} }
FrameworkZ.Notifications.Types 📋 table inferred
Initial value: { Default = "Default", Info = "Info", Success = "Success", Warning = "Warning", Danger = "Danger" }

Methods

4

FrameworkZ.Notifications:AddToQueue(message, notificationType, duration, ui)

method
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.

FrameworkZ.Notifications:OnGameStart()

method undocumented
No documentation available

FrameworkZ.Notifications:PlayerTick(isoPlayer)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature

FrameworkZ.Notifications:ProcessQueue(isProcessingContinued)

method undocumented
No documentation available

Parameters (inferred)

isProcessingContinued ❓ unknown
Parameter inferred from function signature