Arma Reforger Script API
|
Nametag UI Attached to SCR_HUDManagerComponent which is a component of SCR_PlayerController. More...
Public Member Functions | |
SCR_NameTagData | GetEntityNameTag (IEntity ent) |
Retrieve nametag from entity map. | |
void | OnNewVehicleOccupant (IEntity vehicle, SCR_NameTagData occupant) |
void | OnLeaveVehicleOccupant (IEntity vehicle, SCR_NameTagData occupant) |
void | UpdateTagElements (SCR_NameTagData data) |
Update all elements of the requested tag. | |
void | CleanupTag (notnull SCR_NameTagData data, bool removeFromArray=true) |
Unregister events and move to unitialized tag pool. | |
void | CleanupAllTags () |
Unregister events of all tags and move to unitialized tag pool. | |
void | StopUpdate () |
Stop updating nametags. | |
override void | DisplayUpdate (IEntity owner, float timeSlice) |
override bool | DisplayStartDrawInit (IEntity owner) |
override void | DisplayStartDraw (IEntity owner) |
override void | DisplayControlledEntityChanged (IEntity from, IEntity to) |
Reinit curent player tag after new entity is controlled. | |
override void | DisplayStopDraw (IEntity owner) |
![]() | |
void | SetEnabled (bool isEnabled) |
override void | Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR) |
Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility. | |
![]() | |
SCR_InfoDisplayHandler | GetHandler (TypeName handlerType) |
SCR_InfoDisplayInvoker | GetOnStart () |
SCR_InfoDisplayInvoker | GetOnStop () |
IEntity | GetOwnerEntity () |
Widget | GetContentWidget () |
string | GetContentWidgetName () |
void | SetRootWidget (notnull Widget root) |
void | SetContentWidget (notnull Widget content) |
bool | IsShown () |
Widget | GetRootWidget () |
bool | GetDimensions (out float width, out float height, bool addSafezones=true) |
Get width and height of the InfoDisplay element, optionally with safezones adjustments. | |
bool | GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true) |
Get width and height of the InfoDisplay element, optionally with safezones adjustments. | |
void | RegisterToHudManager () |
![]() | |
proto external int | GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays) |
![]() | |
proto external GenericComponent | FindComponentInParentContainer (TypeName typeName) |
Static Public Member Functions | |
static array< ref SCR_NameTagZone > | GetNametagZones () |
Get zone array from assigned zone config. | |
Public Attributes | |
ref SCR_NameTagData | m_CurrentPlayerTag |
![]() | |
ResourceName | m_LayoutPath |
EHudLayers | m_eLayer |
int | m_iOverrideZOrder |
Static Public Attributes | |
const int | PREPARED_WIDGETS = 10 |
const int | PREPARED_VEH_WIDGETS = 3 |
Protected Member Functions | |
void | OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData) |
SCR_GameModeBase event. | |
void | OnControllableDeleted (IEntity entity) |
SCR_GameModeBase event. | |
void | OnGroupJoined (SCR_AIGroup group, int playerID) |
void | OnGroupLeft (SCR_AIGroup group, int playerID) |
void | Update (float timeSlice) |
Decide which entities should have their nametags drawn. | |
bool | IsFactionFriendly (IEntity entity) |
Check if entity is faction friendly to current players faction. | |
void | AdjustRange (bool adjust, float FOVZoomed) |
Adjust zone range based on zoom. | |
void | InitNameTags () |
Basic initialization of invokers. | |
void | ProcessFiltered () |
Process newly gathered entities. | |
void | InitializeTag (IEntity entity, bool friendlyOnly=true) |
Initialize name tag contex instance. | |
void | CreateTagWidget (ENameTagEntityType type=0) |
Create widget for nametag. | |
void | CleanupDisplay (bool destroyWidgets) |
Clear all tags and their widgets. | |
void | UpdateDebug () |
Debug. | |
![]() | |
void | DisplayInit (IEntity owner) |
void | DisplayConsciousnessChanged (bool conscious, bool init=false) |
void | DisplayOnSuspended () |
Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM. | |
void | DisplayOnResumed () |
void | InitializeInterfaceSettings () |
void | OnSettingsChanged () |
![]() | |
void | OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null) |
void | AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false) |
Static Protected Attributes | |
static ref SCR_NameTagConfig | s_NametagCfg |
Nametag UI Attached to SCR_HUDManagerComponent which is a component of SCR_PlayerController.
|
protected |
Adjust zone range based on zoom.
adjust | determines if we are adjusting the ranges or restorign them to default |
FOVZoomed | is the new FOV we are adjusting to |
void SCR_NameTagDisplay.CleanupAllTags | ( | ) |
Unregister events of all tags and move to unitialized tag pool.
|
protected |
Clear all tags and their widgets.
destroyWidgets | determines whether the widgets are kept or destroyed |
void SCR_NameTagDisplay.CleanupTag | ( | notnull SCR_NameTagData | data, |
bool | removeFromArray = true ) |
Unregister events and move to unitialized tag pool.
data | is the subject nametag |
removeFromArray | determines whether the tag is removed from main array, this is not desired when entrire array is being cleaned up |
|
protected |
Create widget for nametag.
override void SCR_NameTagDisplay.DisplayControlledEntityChanged | ( | IEntity | from, |
IEntity | to ) |
Reinit curent player tag after new entity is controlled.
Implements SCR_InfoDisplayExtended.
override void SCR_NameTagDisplay.DisplayStartDraw | ( | IEntity | owner | ) |
Implements SCR_InfoDisplayExtended.
override bool SCR_NameTagDisplay.DisplayStartDrawInit | ( | IEntity | owner | ) |
Implements SCR_InfoDisplayExtended.
override void SCR_NameTagDisplay.DisplayStopDraw | ( | IEntity | owner | ) |
Implements SCR_InfoDisplayExtended.
override void SCR_NameTagDisplay.DisplayUpdate | ( | IEntity | owner, |
float | timeSlice ) |
Implements SCR_InfoDisplayExtended.
SCR_NameTagData SCR_NameTagDisplay.GetEntityNameTag | ( | IEntity | ent | ) |
Retrieve nametag from entity map.
|
static |
Get zone array from assigned zone config.
|
protected |
Initialize name tag contex instance.
entity | is a character entity |
friendlyOnly | determines whether faction check is required for creation |
|
protected |
Basic initialization of invokers.
|
protected |
Check if entity is faction friendly to current players faction.
entity | is a player entity |
|
protected |
SCR_GameModeBase event.
|
protected |
SCR_GameModeBase event.
|
protected |
|
protected |
void SCR_NameTagDisplay.OnLeaveVehicleOccupant | ( | IEntity | vehicle, |
SCR_NameTagData | occupant ) |
void SCR_NameTagDisplay.OnNewVehicleOccupant | ( | IEntity | vehicle, |
SCR_NameTagData | occupant ) |
|
protected |
Process newly gathered entities.
void SCR_NameTagDisplay.StopUpdate | ( | ) |
Stop updating nametags.
|
protected |
Decide which entities should have their nametags drawn.
timeSlice | is the OnFrame timeslice |
|
protected |
Debug.
void SCR_NameTagDisplay.UpdateTagElements | ( | SCR_NameTagData | data | ) |
Update all elements of the requested tag.
data | is nametag data struct |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
ref SCR_NameTagData SCR_NameTagDisplay.m_CurrentPlayerTag |
|
protected |
|
protected |
|
static |
|
static |
|
staticprotected |