Skip to main content
Version: 15.x (API 15) [Legacy]

Interface INamePlateGui

Class used to modify the data used when rendering nameplates.

Assembly: Dalamud.dll​
Declaration
public interface INamePlateGui : IDalamudService

Methods​

RequestRedraw()​

Requests that all nameplates should be redrawn on the following frame.

Declaration
void RequestRedraw()
Remarks​

This causes extra work for the game, and should not need to be called every frame. However, it is acceptable to call frequently when needed (e.g. in response to a manual settings change by the user) or when necessary (e.g. after a change of zone, party type, etc.).

Events​

NamePlateUpdate​

An event which fires when nameplate data is updated and at least one nameplate has important updates. The subscriber is provided with a list of handlers for nameplates with important updates.

Declaration
event INamePlateGui.PlateUpdateDelegate? NamePlateUpdate
Event Type​

Dalamud.Plugin.Services.INamePlateGui.PlateUpdateDelegate

Remarks​

Fires after Dalamud.Plugin.Services.INamePlateGui.DataUpdate.

PostNamePlateUpdate​

An event which fires after nameplate data is updated and at least one nameplate had important updates. The subscriber is provided with a list of handlers for nameplates with important updates.

Declaration
event INamePlateGui.PlateUpdateDelegate? PostNamePlateUpdate
Event Type​

Dalamud.Plugin.Services.INamePlateGui.PlateUpdateDelegate

Remarks​

Fires before Dalamud.Plugin.Services.INamePlateGui.PostDataUpdate.

DataUpdate​

An event which fires when nameplate data is updated. The subscriber is provided with a list of handlers for all nameplates.

Declaration
event INamePlateGui.PlateUpdateDelegate? DataUpdate
Event Type​

Dalamud.Plugin.Services.INamePlateGui.PlateUpdateDelegate

Remarks​

This event is likely to fire every frame even when no nameplates are actually updated, so in most cases Dalamud.Plugin.Services.INamePlateGui.NamePlateUpdate is preferred. Fires before Dalamud.Plugin.Services.INamePlateGui.NamePlateUpdate.

PostDataUpdate​

An event which fires after nameplate data is updated. The subscriber is provided with a list of handlers for all nameplates.

Declaration
event INamePlateGui.PlateUpdateDelegate? PostDataUpdate
Event Type​

Dalamud.Plugin.Services.INamePlateGui.PlateUpdateDelegate

Remarks​

This event is likely to fire every frame even when no nameplates are actually updated, so in most cases Dalamud.Plugin.Services.INamePlateGui.NamePlateUpdate is preferred. Fires after Dalamud.Plugin.Services.INamePlateGui.PostNamePlateUpdate.