ESOUI - CENTER_SCREEN_ANNOUNCE changes

ESOUI (https://www.esoui.com/forums/index.php)

- General Authoring Discussion (https://www.esoui.com/forums/forumdisplay.php?f=174)

- - CENTER_SCREEN_ANNOUNCE changes (https://www.esoui.com/forums/showthread.php?t=7038)

CENTER_SCREEN_ANNOUNCE changes

Does anyone have a full breakdown of changes for CENTER_SCREEN_ANNOUNCE? I use three related functions from it, and I'm not sure how they will be affected.

These two, which I nabbed (with permission) from No, Thank You! to disable certain AvA messages in Cyrodiil:

Lua Code:

local messageQueue = CENTER_SCREEN_ANNOUNCE.m_displayQueue

Lua Code:

local priority = CENTER_SCREEN_ANNOUNCE:GetPriority(avaEvents[eventIndex])

and this one, which I use in CyrodiilAlert to display all the messages:

Lua Code:

CENTER_SCREEN_ANNOUNCE:AddMessage(0, category, sound, message, message2, nil, nil, nil, nil, delay_ms, nil)

The last one will almost certainly be affected by CENTER_SCREEN_ANNOUNCE:CreateMessageParams(type, sounds). but I don't know what's needed instead for all the parameters I have, and then to display the message afterwards.

I also don't know whether the changes to priority will affect anything, and what's the difference between a TYPE and a CATEGORY?

Thanks!

Quote:

Originally Posted by Enodoc (Post 30974)

Does anyone have a full breakdown of changes for CENTER_SCREEN_ANNOUNCE? I use three related functions from it, and I'm not sure how they will be affected.
...
Thanks!

It seems most/all member variables no longer have the "m_" prefix so just use this:

Code:

CENTER_SCREEN_ANNOUNCE.displayQueue

Or a simple if check if you want code to work on live and on pts for now.

As for GetPriority() , it changed a bit since they changed from using an event code directly to a seperate set of constants. Before you would use

Code:

CENTER_SCREEN_ANNOUNCE:GetPriority(EVENT_KEEP_GATE_STATE_CHANGED)

Where as on pts you'd use

Code:

CENTER_SCREEN_ANNOUNCE:GetPriority(CENTER_SCREEN_ANNOUNCE_TYPE_KEEP_GATE_CHANGED)

There's a type for each of those previous events with a priority but they have a slightly different name.

You can still use AddMessage(...) as it became a wrapper function for the new code. It doesn't lose functionality. Now....depending on what exactly you want to do there might be more changes relevant to you.

I just tried a simple thing in the chat box and nothing happened, so I'm not sure what I did wrong.

Lua Code:

/script CENTER_SCREEN_ANNOUNCE:AddMessage(0, CSA_EVENT_COMBINED_TEXT, "Justice_NowKOS", "message", "message2", nil, nil, nil, nil, 10000, nil)

There was no error, so it seems to be syntactically correct, but simply nothing happened.

Edit: Ah, hold on, I think maybe they changed the names of the categories....

So far I think CSA_CATEGORY_LARGE_TEXT has replaced CSA_EVENT_COMBINED_TEXT, but I'm not sure about the others.

Edit 2: OK I think I've worked it out. CSA_EVENT_COMBINED_TEXT and CSA_EVENT_LARGE_TEXT have been merged into CSA_CATEGORY_LARGE_TEXT, CSA_EVENT_SMALL_TEXT has become CSA_CATEGORY_SMALL_TEXT, and as stated in the patch notes there's CSA_CATEGORY_MAJOR_TEXT and CSA_CATEGORY_COUNTDOWN_TEXT which are new. Anything I've missed?

Hey,
There is a new API to create center screen announcements. This is how I use it in my Thieves Troves Marker addon:

Lua Code:

local params = CENTER_SCREEN_ANNOUNCE:CreateMessageParams(CSA_CATEGORY_LARGE_TEXT, SOUNDS.ACHIEVEMENT_AWARDED)
            params:SetCSAType(CENTER_SCREEN_ANNOUNCE_TYPE_POI_DISCOVERED)
            params:SetText(GetString(HARVENS_THIEVES_TROVE_DISCOVERED))
            CENTER_SCREEN_ANNOUNCE:AddMessageWithParams(params)

List of categories:

Lua Code:

CSA_CATEGORY_SMALL_TEXT = 1
CSA_CATEGORY_LARGE_TEXT = 2
CSA_CATEGORY_NO_TEXT = 3
CSA_CATEGORY_RAID_COMPLETE_TEXT = 4
CSA_CATEGORY_MAJOR_TEXT = 5
CSA_CATEGORY_COUNTDOWN_TEXT = 6

List of SCATypes is in the doc attached in this post: https://forums.elderscrollsonline.co...change-log-pts

Here are useful CENTER_SCREEN_ANNOUNCE public functions:

Lua Code:

CreateBarParams(...)
CreateMessageParams(category, sound) --this returs an object of type ZO_CenterScreenMessageParams
ReleaseMessageParams(messageParams)
CanDisplayMessage(category)
AddMessage(eventId, category, ...) --this is the legacy function
AddMessageWithParams(messageParams)
QueueMessage(messageParams)
DisplayMessage(messageParams)

ZO_CenterScreenMessageParams functions:

Lua Code:

Reset()
SetSound(sound)
GetSound()
SetText(mainText, secondaryText)
GetMainText()
GetSecondaryText()
SetIconData(icon, iconBg)
GetIconData()
SetExpiringCallback(callback)
GetExpiringCallback()
SetBarParams(barParams)
GetBarParams()
SetLifespanMS(lifespanMS)
GetLifespanMS()
MarkSuppressIconFrame()
GetSuppressIconFrame()
MarkQueueImmediately(reinsertStompedMessage)
GetQueueImmediately()
MarkShowImmediately()
GetShowImmediately()
GetMostUniqueMessage()
SetCategory(category)
GetCategory()
SetObjectPoolKey(key)
SetCSAType(csaType)
GetCSAType()
SetPriority(priority)
GetPriority()
SetQueuedOrder(queuedOrder)
GetQueuedOrder()
SetEndOfRaidData(endOfRaidData)
GetEndOfRaidData()
CallExpiringCallback()
PlaySound()
ConvertOldParams(sound, message, combinedMessage, icon, iconBg, expiringCallback, barParams, lifespan, suppressFrame, queueImmediately, showImmediately, reinsertStompedMessage)

You can also add your types with priorities with this function:

Lua Code:

ZO_CenterScreenAnnounce_SetPriority(csaType, priority)

Hope this will be useful :)

That's great, thanks! I'll push a minimal-changes version of CA today, and then work on replacing the legacy function with the new ones later on.