|
Arma Reforger Script API
|
Public Member Functions | |
| void | OpenPlayMenu () |
| PLAY MENU ///. | |
| void | ClosePlayMenu () |
| User closes play menu user interface. | |
| void | OpenFieldManual () |
| FIELD MANUAL ///. | |
| void | CloseFieldManual () |
| User closes settings user interface. | |
| void | OpenSettings () |
| SETTINGS ///. | |
| void | CloseSettings () |
| User closes settings user interface. | |
| void | SetQualityPresetSetting (int index) |
| Used when user manually changes quality preset. | |
| void | SetHudVisibilitySetting (int index) |
| Used when user manually changes hud visibility setting. | |
| void | ChangeSetting (string category, string action) |
| User changes some setting in some category. | |
| void | ChangeKeybind (string action, string preset) |
| User tweaks keybind for a specific action. | |
| void | ResetAllKeybinds () |
| User presses "Reset All" button. | |
| void | OpenMultiplayerMenu () |
| MULTIPLAYER MENU ///. | |
| void | CloseMultiplayerMenu () |
| User closes server browser user interface. | |
| void | MultiplayerMenuSetTab (SCR_EServerBrowserTabs tab) |
| User chooses to go to a different tab in server browser. | |
| void | MultiplayerMenuSetSorting (string sorting) |
| User sets a different sorting of servers in server browser. | |
| void | MultiplayerMenuSetFilter (string filterCategory, string filterName) |
| User sets a different filter of servers in server browser. | |
| void | MultiplayerMenuUseSearch () |
| User uses search box in server browser. | |
| void | MultiplayerMenuUseFavorite () |
| User uses favorite button in server browser. | |
| void | MultiplayerMenuUseFilterOn () |
| User uses filter toggle button in server browser. | |
| void | OpenWorkshop () |
| WORKSHOP ///. | |
| void | CloseWorkshop () |
| User closes workshop user interface. | |
| void | WorkshopSetTab (SCR_EAnalyticsWorkshopTab tab) |
| User goes to a different tab in workshop. | |
| void | WorkshopSetSorting (string sorting) |
| User goes to a different tab in workshop. | |
| void | WorkshopSetFilter (string filterCategory, string filterName) |
| User goes to a sets a different filter in workshop. | |
| void | WorkshopUseSearch () |
| User uses search box in the workshop. | |
| void | WorkshopUseFilterOn () |
| User goes to a uses filter toggle in workshop. | |
| void | OpenModDetails () |
| MOD DETAILS ///. | |
| void | CloseModDetails () |
| User closes workshop user interface. | |
| void | ModDetailsSetTab (SCR_EModDetailsMenuTabs tab) |
| User goes to a particular tab in mod details panel in workshop. | |
| void | OpenScenarios () |
| SCENARIOS ///. | |
| void | CloseScenarios () |
| User closes scenarios user interface. | |
| void | ScenariosSetTab (EScenarioSubMenuMode tab) |
| User changes tab in scenarios. | |
| void | ScenariosSetSorting (string sorting) |
| User sets a different sorting in scenarios. | |
| void | ScenariosUseSearch () |
| User uses search box in scenarios. | |
| void | OpenInventory (float currentWeight) |
| INVENTORY ///. | |
| void | CloseInventory (float currentWeight) |
| User closes inventory in game with a specific weight. | |
| void | InteractWithItem (SCR_InventorySlotUI focusedItem, SCR_InventorySlotUI selectedItem, EMenuAction action, bool isUsingGamepad) |
| User interacts with some item in inventory. | |
| void | UseHealingFromInventory () |
| User uses healing item from inventory. | |
| void | UseExaminationFromInventory () |
| User uses "Examine" button in inventory. | |
| void | VoteToKickSucessful () |
| VOTING ///. | |
| void | VoteToKickFailed () |
| Voting about kicking a player ends unsucessfully, inform analytics. | |
| void | TutorialCourseStarts (SCR_ETutorialCourses course) |
| COURSE END ///. | |
| void | TutorialCourseEnds (SCR_ETutorialCourses course, SCR_EAnalyticsCourseEndReason reason) |
| Player completed a course, inform analytics. | |
| void | SetLogging (SCR_EAnalyticsApplicationLoggingFlags logging) |
| LOGGING ///. | |
| SCR_EAnalyticsApplicationLoggingFlags | GetLogging () |
| Retrieves current logging functionality. | |
| override void | OnUpdatePoint (WorldUpdatePointArgs args) |
| Update our interactions based on current time slice. | |
Static Public Member Functions | |
| static SCR_AnalyticsApplication | GetInstance () |
| PUBLIC ////. | |
| static override void | InitInfo (WorldSystemInfo outInfo) |
| Create new analytics module, gets automatically called if class is added to ChimeraSystemsConfig.conf. | |
Protected Member Functions | |
| void | UpdateData (SCR_AnalyticsInteractions interactions, SCR_MenuInteractedData data, string analytical_event, float deltaSeconds) |
| PROTECTED ///. | |
| void | UpdateInventory (float deltaSeconds) |
| Updates inventory interactions and send them it to analytics when time is right. | |
| void | UpdatePlayMenu (float deltaSeconds) |
| Updates play menu interactions and send themto analytics when time is right. | |
| void | UpdateFieldManual (float deltaSeconds) |
| Updates field manual interactions and send them to analytics when time is right. | |
| void | SendAnalyticalEvent (SCR_AnalyticsData object, string eventName, SCR_EAnalyticsDataTable dataTable) |
| Sends analytical event to the console or writes it to the file or sends it through the API Use SetLogging() and GetLogging() to alter the way how are the data currently stored. | |
Static Protected Attributes | |
| static const string | ANALYTICAL_EVENT_SETTINGS_CLOSED = "settingsClosed" |
| Settings. | |
| static const string | ANALYTICAL_EVENT_SCENARIOS_MENU_CLOSE = "scenariosMenuClosed" |
| Scenarios. | |
| static const string | ANALYTICAL_EVENT_WORKSHOP_CLOSED = "workshopMenuClosed" |
| Workshop. | |
| static const string | ANALYTICAL_EVENT_MOD_CLOSED = "modMenuClosed" |
| static const string | ANALYTICAL_EVENT_PLAY_MENU_CLOSED = "playMenuClosed" |
| Play Menu. | |
| static const string | ANALYTICAL_EVENT_MULTIPLAYER_MENU_CLOSED = "multiplayerMenuClosed" |
| Multiplayer Menu. | |
| static const string | MANUAL_LOCATION_GAME = "Game" |
| Field Manual. | |
| static const string | MANUAL_LOCATION_MAIN_MENU = "Main Menu" |
| static const string | ANALYTICAL_EVENT_FIELD_MANUAL_CLOSED = "manualClosed" |
| static const string | ANALYTICAL_EVENT_INVENTORY_CLOSED = "inventoryClosed" |
| Inventory. | |
| static const ref array< EMenuAction > | MOVING_MENU_ACTIONS = { EMenuAction.ACTION_MOVEBETWEEN, EMenuAction.ACTION_DRAGGED, EMenuAction.ACTION_DROPPED, EMenuAction.ACTION_MOVEINSIDE } |
| static const string | ANALYTICAL_EVENT_VOTE_ENDS = "voteEnd" |
| Voting. | |
| static const string | ANALYTICAL_EVENT_COURSE_ENDS = "courseEnd" |
| Tutorial. | |
| static const int | LOCAL_PLAYER_ID = 8888 |
| Sending player events on dedicated severs, hardcoded constant used by Enfusion team. | |
| void SCR_AnalyticsApplication.ChangeKeybind | ( | string | action, |
| string | preset ) |
User tweaks keybind for a specific action.
If used after OpenSettings() and before CloseSettings() informs the analytics about the change.
| [in] | action | (e.g., "Forward", "Aim") |
| void SCR_AnalyticsApplication.ChangeSetting | ( | string | category, |
| string | action ) |
User changes some setting in some category.
If used after OpenSettings() and before CloseSettings() informs the analytics about the change.
| [in] | category | to tweak setting in (e.g., "Audio", "Interface") |
| [in] | action | concrete setting which will be changed (e.g., "Effect Volume") |
| void SCR_AnalyticsApplication.CloseFieldManual | ( | ) |
User closes settings user interface.
Informs analytics we are stopping to track actions and time spent and sends analytical event. Use OpenWorkshop() when user opens the interface again.
| void SCR_AnalyticsApplication.CloseInventory | ( | float | currentWeight | ) |
User closes inventory in game with a specific weight.
Call after OpenInventory(). Sends analytical event if inventory is not open within ANALYTICS_INVENTORY_DELAY_SECONDS seconds.
| [in] | currentWeight | current weight upon closing the inventory |
| void SCR_AnalyticsApplication.CloseModDetails | ( | ) |
User closes workshop user interface.
Informs analytics we are stopping to track actions and time spent and sends analytical event. Use OpenWorkshop() when user opens the interface again.
| void SCR_AnalyticsApplication.CloseMultiplayerMenu | ( | ) |
User closes server browser user interface.
Informs analytics we are stopping to track actions and time spent and sends analytical event. Use OpenMultiplayerMenu() when user opens the interface again.
| void SCR_AnalyticsApplication.ClosePlayMenu | ( | ) |
User closes play menu user interface.
Informs analytics we are stopping to track actions and time spent and sends analytical event. Use OpenPlayMenu() when user opens the interface again.
| void SCR_AnalyticsApplication.CloseScenarios | ( | ) |
User closes scenarios user interface.
Informs analytics we are stopping to track actions and time spent and sends analytical event. Use OpenScenarios() when user opens the interface again.
| void SCR_AnalyticsApplication.CloseSettings | ( | ) |
User closes settings user interface.
Informs analytics we are stopping to track actions and time spent and sends analytical event. Use OpenWorkshop() when user opens the interface again.
| void SCR_AnalyticsApplication.CloseWorkshop | ( | ) |
User closes workshop user interface.
Informs analytics we are stopping to track actions and time spent and sends analytical event. Use OpenWorkshop() when user opens the interface again.
|
static |
PUBLIC ////.
Returns a pointer to analytical events, mostly from evt_app and some minor events from evt_player If you want to disable analytics programatically, use SetLogging(SCR_EAnalyticsApplicationLoggingFlags.NONE) If you want to enable analytics programatically, use for example SetLogging(SCR_EAnalyticsApplicationLoggingFlags.CONSOLE | SCR_EAnalyticsApplicationLoggingFlags.API);
| SCR_EAnalyticsApplicationLoggingFlags SCR_AnalyticsApplication.GetLogging | ( | ) |
Retrieves current logging functionality.
SCR_EAnalyticsApplicationLoggingFlags is a flagged enum.
|
static |
Create new analytics module, gets automatically called if class is added to ChimeraSystemsConfig.conf.
| void SCR_AnalyticsApplication.InteractWithItem | ( | SCR_InventorySlotUI | focusedItem, |
| SCR_InventorySlotUI | selectedItem, | ||
| EMenuAction | action, | ||
| bool | isUsingGamepad ) |
User interacts with some item in inventory.
Interaction = Pressing that item. If used after OpenInventory() and before CloseInventory() informs the analytics about the change.
| void SCR_AnalyticsApplication.ModDetailsSetTab | ( | SCR_EModDetailsMenuTabs | tab | ) |
User goes to a particular tab in mod details panel in workshop.
If used after OpenWorkshop() and before CloseWorkshop() informs the analytics about the change.
| [in] | tab |
| void SCR_AnalyticsApplication.MultiplayerMenuSetFilter | ( | string | filterCategory, |
| string | filterName ) |
User sets a different filter of servers in server browser.
If used after OpenMultiplayerMenu() and before CloseSettings() informs the analytics about the change.
| [in] | filterCategory | (e.g., "Population", "Ping") |
| [in] | filterName | (e.g., "Low", "Medium", "Public", "Private") |
| void SCR_AnalyticsApplication.MultiplayerMenuSetSorting | ( | string | sorting | ) |
User sets a different sorting of servers in server browser.
If used after OpenMultiplayerMenu() and before CloseSettings() informs the analytics about the change.
| [in] | sorting | (e.g., "Name", "Ping") |
| void SCR_AnalyticsApplication.MultiplayerMenuSetTab | ( | SCR_EServerBrowserTabs | tab | ) |
User chooses to go to a different tab in server browser.
If used after OpenMultiplayerMenu() and before CloseSettings() informs the analytics about the change.
| [in] | tab |
| void SCR_AnalyticsApplication.MultiplayerMenuUseFavorite | ( | ) |
User uses favorite button in server browser.
If used after OpenMultiplayerMenu() and before CloseSettings() informs the analytics about the change.
| void SCR_AnalyticsApplication.MultiplayerMenuUseFilterOn | ( | ) |
User uses filter toggle button in server browser.
If used after OpenMultiplayerMenu() and before CloseSettings() informs the analytics about the change.
| void SCR_AnalyticsApplication.MultiplayerMenuUseSearch | ( | ) |
User uses search box in server browser.
If used after OpenMultiplayerMenu() and before CloseSettings() informs the analytics about the change.
| override void SCR_AnalyticsApplication.OnUpdatePoint | ( | WorldUpdatePointArgs | args | ) |
Update our interactions based on current time slice.
| void SCR_AnalyticsApplication.OpenFieldManual | ( | ) |
FIELD MANUAL ///.
User opens field manual user interface. Informs analytics we are starting to track actions and time spent. Use CloseFieldManual() when user closes the interface to stop and send analytical event. This clears all previously saved data!
| void SCR_AnalyticsApplication.OpenInventory | ( | float | currentWeight | ) |
INVENTORY ///.
User opens inventory in game with a specific weight. Call CloseInventory() after user closes inventory to send analytical event (after its delay runs out).
| [in] | currentWeight | current weight upon openning the inventory |
| void SCR_AnalyticsApplication.OpenModDetails | ( | ) |
MOD DETAILS ///.
User opens mod details user interface. Informs analytics we are starting to track actions and time spent. Use CloseModDetails() when user closes the interface to stop and send analytical event. This clears all previously saved data!
| void SCR_AnalyticsApplication.OpenMultiplayerMenu | ( | ) |
MULTIPLAYER MENU ///.
User opens multiplayer menu user interface. Informs analytics we are starting to track actions and time spent. Use CloseMultiplayerMenu() when user closes the interface to stop and send analytical event. This clears all previously saved data!
| void SCR_AnalyticsApplication.OpenPlayMenu | ( | ) |
PLAY MENU ///.
User opens play menu user interface. Informs analytics we are starting to track actions and time spent. Use ClosePlayMenu() when user closes the interface to stop and send analytical event. This clears all previously saved data!
| void SCR_AnalyticsApplication.OpenScenarios | ( | ) |
SCENARIOS ///.
User opens scenarios user interface. Informs analytics we are starting to track actions and time spent. Use CloseScenarios() when user closes the interface to stop and send analytical event. This clears all previously saved data!
| void SCR_AnalyticsApplication.OpenSettings | ( | ) |
SETTINGS ///.
User opens settings user interface. Informs analytics we are starting to track actions and time spent. Use CloseSettings() when user closes the interface to stop and send analytical event. This clears all previously saved data!
| void SCR_AnalyticsApplication.OpenWorkshop | ( | ) |
WORKSHOP ///.
User opens workshop user interface. Informs analytics we are starting to track actions and time spent. Use CloseWorkshop() when user closes the interface to stop and send analytical event. This clears all previously saved data!
| void SCR_AnalyticsApplication.ResetAllKeybinds | ( | ) |
User presses "Reset All" button.
If used after OpenSettings() and before CloseSettings() informs the analytics about the change.
| void SCR_AnalyticsApplication.ScenariosSetSorting | ( | string | sorting | ) |
User sets a different sorting in scenarios.
If used after OpenScenarios() and before CloseScenarios() informs the analytics about the change.
| [in] | sorting |
| void SCR_AnalyticsApplication.ScenariosSetTab | ( | EScenarioSubMenuMode | tab | ) |
User changes tab in scenarios.
If used after OpenScenarios() and before CloseScenarios() informs the analytics about the change.
| [in] | tab |
| void SCR_AnalyticsApplication.ScenariosUseSearch | ( | ) |
User uses search box in scenarios.
If used after OpenScenarios() and before CloseScenarios() informs the analytics about the change.
|
protected |
Sends analytical event to the console or writes it to the file or sends it through the API Use SetLogging() and GetLogging() to alter the way how are the data currently stored.
| void SCR_AnalyticsApplication.SetHudVisibilitySetting | ( | int | index | ) |
Used when user manually changes hud visibility setting.
If used after OpenSettings() and before CloseSettings() informs the analytics about the change.
| [in] | index | from spin box |
| void SCR_AnalyticsApplication.SetLogging | ( | SCR_EAnalyticsApplicationLoggingFlags | logging | ) |
LOGGING ///.
Set a different logging functionality. SCR_EAnalyticsApplicationLoggingFlags is a flagged enum.
| [in] | logging |
| void SCR_AnalyticsApplication.SetQualityPresetSetting | ( | int | index | ) |
Used when user manually changes quality preset.
If used after OpenSettings() and before CloseSettings() informs the analytics about the change.
| [in] | index | from combobox |
| void SCR_AnalyticsApplication.TutorialCourseEnds | ( | SCR_ETutorialCourses | course, |
| SCR_EAnalyticsCourseEndReason | reason ) |
Player completed a course, inform analytics.
| [in] | course | name to double check we ended the same course as we started |
| [in] | reason | was it ended successfully or was there some problem |
| void SCR_AnalyticsApplication.TutorialCourseStarts | ( | SCR_ETutorialCourses | course | ) |
COURSE END ///.
Player started a course in tutorial, start tracking time.
|
protected |
PROTECTED ///.
Updates generic interactions and send them it to analytics when time is right.
|
protected |
Updates field manual interactions and send them to analytics when time is right.
|
protected |
Updates inventory interactions and send them it to analytics when time is right.
|
protected |
Updates play menu interactions and send themto analytics when time is right.
| void SCR_AnalyticsApplication.UseExaminationFromInventory | ( | ) |
User uses "Examine" button in inventory.
If used after OpenInventory() and before CloseInventory() informs the analytics about the change.
| void SCR_AnalyticsApplication.UseHealingFromInventory | ( | ) |
User uses healing item from inventory.
Currently only bandages count as healing. If used after OpenInventory() and before CloseInventory() informs the analytics about the change.
| void SCR_AnalyticsApplication.VoteToKickFailed | ( | ) |
Voting about kicking a player ends unsucessfully, inform analytics.
| void SCR_AnalyticsApplication.VoteToKickSucessful | ( | ) |
VOTING ///.
Voting about kicking a player ends with a success, inform analytics.
| void SCR_AnalyticsApplication.WorkshopSetFilter | ( | string | filterCategory, |
| string | filterName ) |
User goes to a sets a different filter in workshop.
If used after OpenWorkshop() and before CloseWorkshop() informs the analytics about the change.
| [in] | filterCategory | |
| [in] | filterName |
| void SCR_AnalyticsApplication.WorkshopSetSorting | ( | string | sorting | ) |
User goes to a different tab in workshop.
If used after OpenWorkshop() and before CloseWorkshop() informs the analytics about the change.
| [in] | sorting |
| void SCR_AnalyticsApplication.WorkshopSetTab | ( | SCR_EAnalyticsWorkshopTab | tab | ) |
User goes to a different tab in workshop.
If used after OpenWorkshop() and before CloseWorkshop() informs the analytics about the change.
| [in] | tab |
| void SCR_AnalyticsApplication.WorkshopUseFilterOn | ( | ) |
User goes to a uses filter toggle in workshop.
If used after OpenWorkshop() and before CloseWorkshop() informs the analytics about the change.
| void SCR_AnalyticsApplication.WorkshopUseSearch | ( | ) |
User uses search box in the workshop.
If used after OpenWorkshop() and before CloseWorkshop() informs the analytics about the change.
|
staticprotected |
Tutorial.
|
staticprotected |
|
staticprotected |
Inventory.
|
staticprotected |
|
staticprotected |
Multiplayer Menu.
|
staticprotected |
Play Menu.
|
staticprotected |
Scenarios.
|
staticprotected |
Settings.
|
staticprotected |
Voting.
|
staticprotected |
Workshop.
|
staticprotected |
Sending player events on dedicated severs, hardcoded constant used by Enfusion team.
See https://bohemiainteractive.slack.com/archives/CUDBS472A/p1753345662387439
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Logging.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |
Field Manual.
|
staticprotected |
|
staticprotected |