Arma Reforger Script API
|
Public Member Functions | |
EHint | GetType () |
Get hint type. | |
int | GetShowLimit () |
Get how many times can the hint be shown. | |
bool | IsTimerVisible () |
Get if the animated timer should be visible. | |
int | GetPriority () |
Get priority of the hint. | |
float | GetDuration () |
Get duration for which the hint should be displayed (in seconds) | |
WorldTimestamp | GetTimeStarted () |
Get the time of Hint start, needed for proper Map implementation. | |
void | SetTimeStamp () |
Set the time stamp of Hint start. Needed for hint timer timekeeping. | |
int | GetHighlightWidgetNames (out notnull array< string > outWidgetNames) |
Get names of widgets that should be highlighted. | |
EFieldManualEntryId | GetFieldManualLink () |
Get link to associated field manual entry. | |
void | InitSequence (int page, int count) |
Initialize hint sequence. | |
int | GetSequencePage () |
int | GetSequenceCount () |
bool | IsInSequence () |
bool | IsPersistent () |
void | SetPersistent (bool persistent) |
override bool | SetDescriptionTo (TextWidget textWidget) |
Set description to given text widget. | |
![]() | |
override bool | HasDescription () |
Check if the info has a description defined. | |
override LocalizedString | GetDescription () |
Get description. | |
LocalizedString | GetUnformattedDescriptionBlockName (int index) |
Get Name of selected description block without formatting (raw). | |
void | SetDescriptionBlockName (int index, LocalizedString text) |
Changes the Name (text) of selected Description Block. | |
![]() | |
ResourceName | GetIconPath () |
Get icon. | |
ResourceName | GetImageSetPath () |
Get Image Set. | |
string | GetIconSetName () |
Returns Icon Set name if imageset. | |
bool | HasIcon () |
Check if the info has an icon defined. | |
bool | SetIconTo (ImageWidget imageWidget) |
Set icon to given image widget. | |
override void | Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE) |
![]() | |
LocalizedString | GetUnformattedDescription () |
Get the unformatted description from SCR_HintUIInfo instance. | |
void | SetDescription (LocalizedString description) |
Change the description from SCR_HintUIInfo instance. | |
![]() | |
LocalizedString | GetUnformattedName () |
Get The unformatted Name from SCR_HintUIInfo instance. | |
void | SetName (LocalizedString name) |
Change the Name from SCR_HintUIInfo instance. | |
LocalizedString | GetName () |
Get name. | |
bool | HasName () |
Check if the info has a name defined. | |
bool | SetNameTo (TextWidget textWidget) |
Set name to given text widget. | |
Static Public Member Functions | |
static SCR_HintUIInfo | CreateInfo (string description, string name, float duration, EHint type, EFieldManualEntryId fieldManualEntry, bool isTimerVisible) |
![]() | |
static SCR_UIInfo | GetInfo (BaseContainer source, string varName) |
Get UIInfo from a source object. | |
static SCR_UIInfo | CreateInfo (UIInfo source) |
Create SCR_UIInfo from engine UIInfo. | |
static SCR_UIInfo | CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty) |
Create SCR_UIInfo from basic params. | |
static SCR_UIInfo | CreatePlaceholderInfo (TypeName type) |
Get placeholder info. | |
Protected Attributes | |
EHint | m_Type |
int | m_iShowLimit |
int | m_iPriority |
float | m_fDuration |
ref array< string > | m_aHighlightWidgetsNames |
bool | m_bIsTimerVisible |
EFieldManualEntryId | m_FieldManualLink |
bool | m_bPersistent |
int | m_iSequencePage |
int | m_iSequenceCount |
WorldTimestamp | m_iTimeHintStarted |
![]() | |
ref array< ref SCR_SubBlockUIName > | m_aDescriptionBlocks |
![]() | |
ResourceName | Icon |
string | IconSetName |
![]() | |
LocalizedString | Description |
![]() | |
LocalizedString | Name |
Additional Inherited Members | |
![]() | |
override void | CopyFrom (SCR_UIName source) |
|
static |
description | |
name | |
duration | |
type | |
fieldManualEntry | |
isTimerVisible |
float SCR_HintUIInfo.GetDuration | ( | ) |
Get duration for which the hint should be displayed (in seconds)
EFieldManualEntryId SCR_HintUIInfo.GetFieldManualLink | ( | ) |
Get link to associated field manual entry.
int SCR_HintUIInfo.GetHighlightWidgetNames | ( | out notnull array< string > | outWidgetNames | ) |
Get names of widgets that should be highlighted.
[out] | Array | to be filled with widget names |
int SCR_HintUIInfo.GetPriority | ( | ) |
Get priority of the hint.
When another hint is already shown, this one will replace it only if it has the same or higher priority.
int SCR_HintUIInfo.GetSequenceCount | ( | ) |
int SCR_HintUIInfo.GetSequencePage | ( | ) |
int SCR_HintUIInfo.GetShowLimit | ( | ) |
Get how many times can the hint be shown.
Valid only if Type is defined!
WorldTimestamp SCR_HintUIInfo.GetTimeStarted | ( | ) |
Get the time of Hint start, needed for proper Map implementation.
Returns Replication.Time() of hint creation;
EHint SCR_HintUIInfo.GetType | ( | ) |
Get hint type.
When defined, the hint will be persistently saved and not shown again.
void SCR_HintUIInfo.InitSequence | ( | int | page, |
int | count ) |
Initialize hint sequence.
page | Page number of this hint |
count | Total number of hints in the sequence |
bool SCR_HintUIInfo.IsInSequence | ( | ) |
bool SCR_HintUIInfo.IsPersistent | ( | ) |
bool SCR_HintUIInfo.IsTimerVisible | ( | ) |
Get if the animated timer should be visible.
override bool SCR_HintUIInfo.SetDescriptionTo | ( | TextWidget | textWidget | ) |
Set description to given text widget.
When possible, use this function instead of retrieving the description using GetDescription() and setting it manually. Custom UI info classes may be using parameters which would not be applied otherwise.
textWidget | Target text widget |
Implements SCR_UIDescription.
void SCR_HintUIInfo.SetPersistent | ( | bool | persistent | ) |
void SCR_HintUIInfo.SetTimeStamp | ( | ) |
Set the time stamp of Hint start. Needed for hint timer timekeeping.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |