Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_PlayerListMenu Interface Reference
Inheritance diagram for SCR_PlayerListMenu:
[legend]

Public Member Functions

void SortByMuted (bool reverseSort=false)
 
void SortByName (bool reverseSort=false)
 
void SortByFriends (bool reverseSort=false)
 
void SortByFrequency (bool reverseSort=false)
 
void SortByKills (bool reverseSort=false)
 
void SortByDeaths (bool reverseSort=false)
 
void SortByScore (bool reverseSort=false)
 
void OnBlock (SCR_InputButtonComponent comp, string actionName)
 
void OnUnblock (SCR_InputButtonComponent comp, string actionName)
 
void OnMute ()
 
void OnAddFriend ()
 
void OnTabChanged (SCR_TabViewComponent comp, Widget w, int selectedTab)
 
void OnBack ()
 
void OnFilter ()
 
void OnVoting ()
 
void OnInvite ()
 
void OnMuteClick (SCR_ButtonBaseComponent comp, bool selected)
 
void OnFriendClick (SCR_ButtonBaseComponent comp, bool selected)
 
void OnEntryFocused (Widget w)
 
void OnEntryFocusLost (Widget w)
 
void FocusFirstItem ()
 
void SetEntryBackgrounColor (Color color)
 
void CreateEntry (int id, SCR_PlayerDelegateEditorComponent editorDelegateManager)
 
void RemoveEntry (notnull SCR_PlayerListEntry entry)
 
override void OnMenuOpen ()
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
override void OnMenuClose ()
 
void OnPlayerConnected (int id)
 
void UpdatePlayerList (bool addPlayer, int id)
 
void UpdateFrequencies ()
 
void UpdateBlockElements ()
 
void UpdateScore ()
 
void CloseAllVoting ()
 
void DeleteDisconnectedEntries ()
 
void AddFactionPlayerCounter (Faction faction)
 
- Public Member Functions inherited from SCR_SuperMenuBase
override void OnMenuOpen ()
 
override void OnMenuShow ()
 
override void OnMenuHide ()
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuClose ()
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
SCR_SuperMenuComponent GetSuperMenu ()
 
- Public Member Functions inherited from MenuRootBase
ScriptInvoker GetOnMenuFocusGained ()
 
ScriptInvoker GetOnMenuFocusLost ()
 
ScriptInvoker GetOnMenuShow ()
 
ScriptInvoker GetOnMenuHide ()
 
ScriptInvoker GetOnMenuItem ()
 
ScriptInvoker GetOnMenuUpdate ()
 
ScriptInvoker GetOnMenuOpen ()
 
ScriptInvoker GetOnMenuInit ()
 
ScriptInvoker GetOnMenuClose ()
 
void OnMenuClosed ()
 
void InitChat ()
 
void ShowChat ()
 
MenuRootComponent GetRootComponent ()
 
SCR_DynamicFooterComponent GetFooterComponent ()
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
override void OnMenuShow ()
 
override void OnMenuHide ()
 
override void OnMenuItem (string menuItemName, bool changed, bool finished)
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuOpen ()
 
override void OnMenuInit ()
 
override void OnMenuClose ()
 
- Public Member Functions inherited from ChimeraMenuBase
override void OnMenuInit ()
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuOpen ()
 
override void OnMenuOpened ()
 
override void OnMenuClose ()
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
override void OnMenuShow ()
 
override void OnMenuHide ()
 

Static Public Member Functions

static ScriptInvoker GetOnPlayerListMenu ()
 Get event called when player list opens or closes.
 
- Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase CurrentChimeraMenu ()
 
static ChimeraMenuBase GetOwnerMenu (Widget w)
 Returns parent menu of a widget.
 

Public Attributes

SCR_SortHeaderComponent m_Header
 
- Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker m_OnTextEditContextChange = new ScriptInvoker
 
ref ScriptInvoker m_OnUpdate = new ScriptInvoker
 

Protected Member Functions

void InitSorting ()
 
void OnHeaderChanged (SCR_SortHeaderComponent sortHeader)
 
void Sort (string filterName, bool sortUp)
 
void OnViewProfile ()
 
void UpdateViewProfileButton (int playerId, bool forceHidden=false)
 
void SetupPlayerActionList (notnull SCR_ComboBoxComponent combo)
 
void UpdatePlayerActionList (SCR_ComboBoxComponent combo, bool isCallqueue)
 
void OnComboBoxConfirm (notnull SCR_ComboBoxComponent combo, int index)
 
int GetVotingPlayerID (SCR_ComboBoxComponent combo)
 
void OnEditorRightsChanged (int playerID, bool newLimited)
 
void UpdateGameMasterIndicator (SCR_PlayerListEntry entry, bool editorIslimited)
 
bool IsLocalPlayer (int id)
 
void OpenPauseMenu ()
 
void OnVotingChanged (EVotingType type, int value, int playerID)
 
void GetOnVotingStart (EVotingType type, int value)
 
void UpdateVoting ()
 
bool IsVotedAbout (SCR_PlayerListEntry entry)
 
bool CanOpenPlayerActionList (SCR_PlayerListEntry entry)
 

Protected Attributes

ResourceName m_sScoreboardRow = "{65369923121A38E7}UI/layouts/Menus/PlayerList/PlayerListEntry.layout"
 
ref array< ref SCR_PlayerListEntrym_aEntries = new array<ref SCR_PlayerListEntry>()
 
ref map< int, SCR_ScoreInfom_aAllPlayersInfo = new map<int, SCR_ScoreInfo>()
 
ref array< Factionm_aFactions = {null}
 
SCR_InputButtonComponent m_Mute
 
SCR_InputButtonComponent m_Block
 
SCR_InputButtonComponent m_Unblock
 
SCR_InputButtonComponent m_Friend
 
SCR_InputButtonComponent m_Vote
 
SCR_InputButtonComponent m_Invite
 
SCR_InputButtonComponent m_ViewProfile
 
SCR_VotingManagerComponent m_VotingManager
 
SCR_VoterComponent m_VoterComponent
 
SCR_BaseScoringSystemComponent m_ScoringSystem
 
SCR_PlayerListEntry m_SelectedEntry
 
SCR_PlayerControllerGroupComponent m_PlayerGroupController
 
PlayerController m_PlayerController
 
SocialComponent m_SocialComponent
 
Widget m_wTable
 
bool m_bFiltering
 
float m_fTimeSkip
 
string m_sGameMasterIndicatorName = "GameMasterIndicator"
 
ref Color m_PlayerNameSelfColor = new Color(0.898, 0.541, 0.184, 1)
 
ref map< EVotingType, int > m_mVotingTypesOnCooldown = new map<EVotingType, int>()
 
- Protected Attributes inherited from SCR_SuperMenuBase
SCR_SuperMenuComponent m_SuperMenuComponent
 
- Protected Attributes inherited from MenuRootBase
MenuRootComponent m_MenuRootComponent
 
ref ScriptInvoker m_EventOnMenuFocusGained
 
ref ScriptInvoker m_EventOnMenuFocusLost
 
ref ScriptInvoker m_EventOnMenuShow
 
ref ScriptInvoker m_EventOnMenuHide
 
ref ScriptInvoker m_EventOnMenuItem
 
ref ScriptInvoker m_EventOnMenuUpdate
 
ref ScriptInvoker m_EventOnMenuOpen
 
ref ScriptInvoker m_EventOnMenuInit
 
ref ScriptInvoker m_EventOnMenuClose
 
SCR_ChatPanel m_ChatPanel
 
SCR_DynamicFooterComponent m_DynamicFooter
 
- Protected Attributes inherited from ChimeraMenuBase
bool m_bTextEditActive = false
 

Static Protected Attributes

const float TIME_STEP = 1.0
 
const string ADD_FRIEND = "#AR-PlayerList_AddFriend"
 
const string REMOVE_FRIEND = "#AR-PlayerList_RemoveFriend"
 
const string MUTE = "#AR-PlayerList_Mute"
 
const string UNMUTE = "#AR-PlayerList_Unmute"
 
const string BLOCK = "#AR-PlayerList_Block"
 
const string UNBLOCK = "#AR-PlayerList_Unblock"
 
const string INVITE_PLAYER_VOTE = "#AR-PlayerList_Invite"
 
const string MUTE_TEXTURE = "sound-off"
 
const string OPTIONS_COMBO_ACCEPT = "#AR-Group_AcceptJoinPrivateGroup"
 
const string OPTIONS_COMBO_CANCEL = "#AR-Group_RefuseJoinPrivateGroup"
 
const string VOTING_PLAYER_COUNT_FORMAT = "#AR-Voting_PlayerCountFormatting"
 
const string FILTER_FAV = "Favourite"
 
const string FILTER_NAME = "Name"
 
const string FILTER_FREQ = "Freq"
 
const string FILTER_KILL = "Kills"
 
const string FILTER_DEATH = "Deaths"
 
const string FILTER_SCORE = "Score"
 
const string FILTER_MUTE = "Mute"
 
const string FILTER_BLOCK = "Block"
 
static const ResourceName FACTION_COUNTER_LAYOUT = "{5AD2CE85825EDA11}UI/layouts/Menus/PlayerList/FactionPlayerCounter.layout"
 
const int DEFAULT_SORT_INDEX = 1
 
static ref ScriptInvoker s_OnPlayerListMenu = new ScriptInvoker()
 
static ref PlayerlistBlockCallback m_BlockCallback
 
- Static Protected Attributes inherited from ChimeraMenuBase
const string INPUT_CONTEXT_EDIT = "MenuTextEditContext"
 
static ChimeraMenuBase m_ThisMenu
 

Member Function Documentation

◆ AddFactionPlayerCounter()

void SCR_PlayerListMenu.AddFactionPlayerCounter ( Faction  faction)

◆ CanOpenPlayerActionList()

bool SCR_PlayerListMenu.CanOpenPlayerActionList ( SCR_PlayerListEntry  entry)
protected

◆ CloseAllVoting()

void SCR_PlayerListMenu.CloseAllVoting ( )

◆ CreateEntry()

void SCR_PlayerListMenu.CreateEntry ( int  id,
SCR_PlayerDelegateEditorComponent  editorDelegateManager 
)

◆ DeleteDisconnectedEntries()

void SCR_PlayerListMenu.DeleteDisconnectedEntries ( )

◆ FocusFirstItem()

void SCR_PlayerListMenu.FocusFirstItem ( )

◆ GetOnPlayerListMenu()

static ScriptInvoker SCR_PlayerListMenu.GetOnPlayerListMenu ( )
static

Get event called when player list opens or closes.

Returns
Script invoker

◆ GetOnVotingStart()

void SCR_PlayerListMenu.GetOnVotingStart ( EVotingType  type,
int  value 
)
protected

◆ GetVotingPlayerID()

int SCR_PlayerListMenu.GetVotingPlayerID ( SCR_ComboBoxComponent  combo)
protected

◆ InitSorting()

void SCR_PlayerListMenu.InitSorting ( )
protected

◆ IsLocalPlayer()

bool SCR_PlayerListMenu.IsLocalPlayer ( int  id)
protected

◆ IsVotedAbout()

bool SCR_PlayerListMenu.IsVotedAbout ( SCR_PlayerListEntry  entry)
protected

◆ OnAddFriend()

void SCR_PlayerListMenu.OnAddFriend ( )

◆ OnBack()

void SCR_PlayerListMenu.OnBack ( )

◆ OnBlock()

void SCR_PlayerListMenu.OnBlock ( SCR_InputButtonComponent  comp,
string  actionName 
)

◆ OnComboBoxConfirm()

void SCR_PlayerListMenu.OnComboBoxConfirm ( notnull SCR_ComboBoxComponent  combo,
int  index 
)
protected

◆ OnEditorRightsChanged()

void SCR_PlayerListMenu.OnEditorRightsChanged ( int  playerID,
bool  newLimited 
)
protected

◆ OnEntryFocused()

void SCR_PlayerListMenu.OnEntryFocused ( Widget  w)

◆ OnEntryFocusLost()

void SCR_PlayerListMenu.OnEntryFocusLost ( Widget  w)

◆ OnFilter()

void SCR_PlayerListMenu.OnFilter ( )

◆ OnFriendClick()

void SCR_PlayerListMenu.OnFriendClick ( SCR_ButtonBaseComponent  comp,
bool  selected 
)

◆ OnHeaderChanged()

void SCR_PlayerListMenu.OnHeaderChanged ( SCR_SortHeaderComponent  sortHeader)
protected

◆ OnInvite()

void SCR_PlayerListMenu.OnInvite ( )

◆ OnMenuClose()

override void SCR_PlayerListMenu.OnMenuClose ( )

Implements SCR_SuperMenuBase.

◆ OnMenuFocusGained()

override void SCR_PlayerListMenu.OnMenuFocusGained ( )

Implements SCR_SuperMenuBase.

◆ OnMenuFocusLost()

override void SCR_PlayerListMenu.OnMenuFocusLost ( )

Implements SCR_SuperMenuBase.

◆ OnMenuOpen()

override void SCR_PlayerListMenu.OnMenuOpen ( )

Implements SCR_SuperMenuBase.

◆ OnMenuUpdate()

override void SCR_PlayerListMenu.OnMenuUpdate ( float  tDelta)

Implements SCR_SuperMenuBase.

◆ OnMute()

void SCR_PlayerListMenu.OnMute ( )

◆ OnMuteClick()

void SCR_PlayerListMenu.OnMuteClick ( SCR_ButtonBaseComponent  comp,
bool  selected 
)

◆ OnPlayerConnected()

void SCR_PlayerListMenu.OnPlayerConnected ( int  id)

◆ OnTabChanged()

void SCR_PlayerListMenu.OnTabChanged ( SCR_TabViewComponent  comp,
Widget  w,
int  selectedTab 
)

◆ OnUnblock()

void SCR_PlayerListMenu.OnUnblock ( SCR_InputButtonComponent  comp,
string  actionName 
)

◆ OnViewProfile()

void SCR_PlayerListMenu.OnViewProfile ( )
protected

◆ OnVoting()

void SCR_PlayerListMenu.OnVoting ( )

◆ OnVotingChanged()

void SCR_PlayerListMenu.OnVotingChanged ( EVotingType  type,
int  value,
int  playerID 
)
protected

◆ OpenPauseMenu()

void SCR_PlayerListMenu.OpenPauseMenu ( )
protected

◆ RemoveEntry()

void SCR_PlayerListMenu.RemoveEntry ( notnull SCR_PlayerListEntry  entry)

◆ SetEntryBackgrounColor()

void SCR_PlayerListMenu.SetEntryBackgrounColor ( Color  color)

◆ SetupPlayerActionList()

void SCR_PlayerListMenu.SetupPlayerActionList ( notnull SCR_ComboBoxComponent  combo)
protected

◆ Sort()

void SCR_PlayerListMenu.Sort ( string  filterName,
bool  sortUp 
)
protected

◆ SortByDeaths()

void SCR_PlayerListMenu.SortByDeaths ( bool  reverseSort = false)

◆ SortByFrequency()

void SCR_PlayerListMenu.SortByFrequency ( bool  reverseSort = false)

◆ SortByFriends()

void SCR_PlayerListMenu.SortByFriends ( bool  reverseSort = false)

◆ SortByKills()

void SCR_PlayerListMenu.SortByKills ( bool  reverseSort = false)

◆ SortByMuted()

void SCR_PlayerListMenu.SortByMuted ( bool  reverseSort = false)

◆ SortByName()

void SCR_PlayerListMenu.SortByName ( bool  reverseSort = false)

◆ SortByScore()

void SCR_PlayerListMenu.SortByScore ( bool  reverseSort = false)

◆ UpdateBlockElements()

void SCR_PlayerListMenu.UpdateBlockElements ( )

◆ UpdateFrequencies()

void SCR_PlayerListMenu.UpdateFrequencies ( )

◆ UpdateGameMasterIndicator()

void SCR_PlayerListMenu.UpdateGameMasterIndicator ( SCR_PlayerListEntry  entry,
bool  editorIslimited 
)
protected

◆ UpdatePlayerActionList()

void SCR_PlayerListMenu.UpdatePlayerActionList ( SCR_ComboBoxComponent  combo,
bool  isCallqueue 
)
protected

◆ UpdatePlayerList()

void SCR_PlayerListMenu.UpdatePlayerList ( bool  addPlayer,
int  id 
)

◆ UpdateScore()

void SCR_PlayerListMenu.UpdateScore ( )

◆ UpdateViewProfileButton()

void SCR_PlayerListMenu.UpdateViewProfileButton ( int  playerId,
bool  forceHidden = false 
)
protected

◆ UpdateVoting()

void SCR_PlayerListMenu.UpdateVoting ( )
protected

Member Data Documentation

◆ ADD_FRIEND

const string SCR_PlayerListMenu.ADD_FRIEND = "#AR-PlayerList_AddFriend"
staticprotected

◆ BLOCK

const string SCR_PlayerListMenu.BLOCK = "#AR-PlayerList_Block"
staticprotected

◆ DEFAULT_SORT_INDEX

const int SCR_PlayerListMenu.DEFAULT_SORT_INDEX = 1
staticprotected

◆ FACTION_COUNTER_LAYOUT

const ResourceName SCR_PlayerListMenu.FACTION_COUNTER_LAYOUT = "{5AD2CE85825EDA11}UI/layouts/Menus/PlayerList/FactionPlayerCounter.layout"
staticprotected

◆ FILTER_BLOCK

const string SCR_PlayerListMenu.FILTER_BLOCK = "Block"
staticprotected

◆ FILTER_DEATH

const string SCR_PlayerListMenu.FILTER_DEATH = "Deaths"
staticprotected

◆ FILTER_FAV

const string SCR_PlayerListMenu.FILTER_FAV = "Favourite"
staticprotected

◆ FILTER_FREQ

const string SCR_PlayerListMenu.FILTER_FREQ = "Freq"
staticprotected

◆ FILTER_KILL

const string SCR_PlayerListMenu.FILTER_KILL = "Kills"
staticprotected

◆ FILTER_MUTE

const string SCR_PlayerListMenu.FILTER_MUTE = "Mute"
staticprotected

◆ FILTER_NAME

const string SCR_PlayerListMenu.FILTER_NAME = "Name"
staticprotected

◆ FILTER_SCORE

const string SCR_PlayerListMenu.FILTER_SCORE = "Score"
staticprotected

◆ INVITE_PLAYER_VOTE

const string SCR_PlayerListMenu.INVITE_PLAYER_VOTE = "#AR-PlayerList_Invite"
staticprotected

◆ m_aAllPlayersInfo

ref map<int, SCR_ScoreInfo> SCR_PlayerListMenu.m_aAllPlayersInfo = new map<int, SCR_ScoreInfo>()
protected

◆ m_aEntries

ref array<ref SCR_PlayerListEntry> SCR_PlayerListMenu.m_aEntries = new array<ref SCR_PlayerListEntry>()
protected

◆ m_aFactions

ref array<Faction> SCR_PlayerListMenu.m_aFactions = {null}
protected

◆ m_bFiltering

bool SCR_PlayerListMenu.m_bFiltering
protected

◆ m_Block

SCR_InputButtonComponent SCR_PlayerListMenu.m_Block
protected

◆ m_BlockCallback

ref PlayerlistBlockCallback SCR_PlayerListMenu.m_BlockCallback
staticprotected

◆ m_Friend

SCR_InputButtonComponent SCR_PlayerListMenu.m_Friend
protected

◆ m_fTimeSkip

float SCR_PlayerListMenu.m_fTimeSkip
protected

◆ m_Header

SCR_SortHeaderComponent SCR_PlayerListMenu.m_Header

◆ m_Invite

SCR_InputButtonComponent SCR_PlayerListMenu.m_Invite
protected

◆ m_Mute

SCR_InputButtonComponent SCR_PlayerListMenu.m_Mute
protected

◆ m_mVotingTypesOnCooldown

ref map<EVotingType, int> SCR_PlayerListMenu.m_mVotingTypesOnCooldown = new map<EVotingType, int>()
protected

◆ m_PlayerController

PlayerController SCR_PlayerListMenu.m_PlayerController
protected

◆ m_PlayerGroupController

SCR_PlayerControllerGroupComponent SCR_PlayerListMenu.m_PlayerGroupController
protected

◆ m_PlayerNameSelfColor

ref Color SCR_PlayerListMenu.m_PlayerNameSelfColor = new Color(0.898, 0.541, 0.184, 1)
protected

◆ m_ScoringSystem

SCR_BaseScoringSystemComponent SCR_PlayerListMenu.m_ScoringSystem
protected

◆ m_SelectedEntry

SCR_PlayerListEntry SCR_PlayerListMenu.m_SelectedEntry
protected

◆ m_sGameMasterIndicatorName

string SCR_PlayerListMenu.m_sGameMasterIndicatorName = "GameMasterIndicator"
protected

◆ m_SocialComponent

SocialComponent SCR_PlayerListMenu.m_SocialComponent
protected

◆ m_sScoreboardRow

ResourceName SCR_PlayerListMenu.m_sScoreboardRow = "{65369923121A38E7}UI/layouts/Menus/PlayerList/PlayerListEntry.layout"
protected

◆ m_Unblock

SCR_InputButtonComponent SCR_PlayerListMenu.m_Unblock
protected

◆ m_ViewProfile

SCR_InputButtonComponent SCR_PlayerListMenu.m_ViewProfile
protected

◆ m_Vote

SCR_InputButtonComponent SCR_PlayerListMenu.m_Vote
protected

◆ m_VoterComponent

SCR_VoterComponent SCR_PlayerListMenu.m_VoterComponent
protected

◆ m_VotingManager

SCR_VotingManagerComponent SCR_PlayerListMenu.m_VotingManager
protected

◆ m_wTable

Widget SCR_PlayerListMenu.m_wTable
protected

◆ MUTE

const string SCR_PlayerListMenu.MUTE = "#AR-PlayerList_Mute"
staticprotected

◆ MUTE_TEXTURE

const string SCR_PlayerListMenu.MUTE_TEXTURE = "sound-off"
staticprotected

◆ OPTIONS_COMBO_ACCEPT

const string SCR_PlayerListMenu.OPTIONS_COMBO_ACCEPT = "#AR-Group_AcceptJoinPrivateGroup"
staticprotected

◆ OPTIONS_COMBO_CANCEL

const string SCR_PlayerListMenu.OPTIONS_COMBO_CANCEL = "#AR-Group_RefuseJoinPrivateGroup"
staticprotected

◆ REMOVE_FRIEND

const string SCR_PlayerListMenu.REMOVE_FRIEND = "#AR-PlayerList_RemoveFriend"
staticprotected

◆ s_OnPlayerListMenu

ref ScriptInvoker SCR_PlayerListMenu.s_OnPlayerListMenu = new ScriptInvoker()
staticprotected

◆ TIME_STEP

const float SCR_PlayerListMenu.TIME_STEP = 1.0
staticprotected

◆ UNBLOCK

const string SCR_PlayerListMenu.UNBLOCK = "#AR-PlayerList_Unblock"
staticprotected

◆ UNMUTE

const string SCR_PlayerListMenu.UNMUTE = "#AR-PlayerList_Unmute"
staticprotected

◆ VOTING_PLAYER_COUNT_FORMAT

const string SCR_PlayerListMenu.VOTING_PLAYER_COUNT_FORMAT = "#AR-Voting_PlayerCountFormatting"
staticprotected

The documentation for this interface was generated from the following file: