< Summary

Class:InputProcessor
Assembly:InputController
File(s):/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/Controllers/InputController/InputController.cs
Covered lines:45
Uncovered lines:24
Coverable lines:69
Total lines:800
Line coverage:65.2% (45 of 69)
Covered branches:0
Total branches:0

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity NPath complexity Sequence coverage
InputProcessor()0%110100%
PassModifierKeys(...)0%5.025090.91%
PassModifiers(...)0%8.518080%
IsStartMenuVisible()0%110100%
FromKey(...)0%4.054085.71%
FromMouseButton(...)0%12300%
FromMouseButtonUp(...)0%3.073080%
FromKey(...)0%4.374071.43%
FromKey(...)0%2.062075%
FromMouse(...)0%20400%
FromAxis(...)0%220100%
IsModifierSet(...)0%2100%
FocusIsInInputField()0%5.25080%

File(s)

/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/Controllers/InputController/InputController.cs

#LineLine coverage
 1using DCL;
 2using System;
 3using System.Linq;
 4using TMPro;
 5using UnityEngine;
 6using UnityEngine.EventSystems;
 7using DCL.Configuration;
 8
 9/// <summary>
 10/// Mapping for Trigger actions
 11/// </summary>
 12public enum DCLAction_Trigger
 13{
 14    //Remember to explicitly assign the value to each entry so we minimize issues with serialization + conflicts
 15    CameraChange = 100,
 16    CursorUnlock = 101,
 17
 18    ToggleNavMap = 110,
 19    ToggleFriends = 120,
 20    CloseWindow = 121,
 21    ToggleWorldChat = 122,
 22    ToggleUIVisibility = 123,
 23    ToggleControlsHud = 124,
 24    ToggleSettings = 125,
 25    ToggleStartMenu = 126,
 26    ToggleVoiceChatRecording = 127,
 27    ToggleAvatarEditorHud = 128,
 28    ToggleQuestsPanelHud = 129,
 29    ToggleAvatarNamesHud = 130,
 30    TogglePlacesAndEventsHud = 131,
 31    ToggleShortcut0 = 132,
 32    ToggleShortcut1 = 133,
 33    ToggleShortcut2 = 134,
 34    ToggleShortcut3 = 135,
 35    ToggleShortcut4 = 136,
 36    ToggleShortcut5 = 137,
 37    ToggleShortcut6 = 138,
 38    ToggleShortcut7 = 139,
 39    ToggleShortcut8 = 140,
 40    ToggleShortcut9 = 141,
 41    ToggleEmoteShortcut0 = 142,
 42    ToggleEmoteShortcut1 = 143,
 43    ToggleEmoteShortcut2 = 144,
 44    ToggleEmoteShortcut3 = 145,
 45    ToggleEmoteShortcut4 = 146,
 46    ToggleEmoteShortcut5 = 147,
 47    ToggleEmoteShortcut6 = 148,
 48    ToggleEmoteShortcut7 = 149,
 49    ToggleEmoteShortcut8 = 150,
 50    ToggleEmoteShortcut9 = 151,
 51    ChatPreviousInHistory = 152,
 52    ChatNextInHistory = 153,
 53
 54    Expression_Wave = 201,
 55    Expression_FistPump = 202,
 56    Expression_Robot = 203,
 57    Expression_RaiseHand = 204,
 58    Expression_Clap = 205,
 59    Expression_ThrowMoney = 206,
 60    Expression_SendKiss = 207,
 61    Expression_Dance = 208,
 62    Expression_Hohoho = 209,
 63    Expression_Snowfall = 210,
 64
 65    //Builder In World 4xx
 66    BuildEditModeChange = 408,
 67    BuildEditModeToggleUI = 409,
 68    BuildEditModeToggleEntityList = 410,
 69    BuildEditModeToggleCatalog = 411,
 70    BuildEditModeToggleSceneInfo = 412,
 71    BuildEditModeToggleChangeCamera = 413,
 72    BuildEditModeToggleControls = 414,
 73    BuildEditModeToggleSnapMode = 415,
 74    BuildEditModeUndoAction = 417,
 75    BuildEditModeRedoAction = 418,
 76    BuildEditModeQuickBar1 = 419,
 77    BuildEditModeQuickBar2 = 420,
 78    BuildEditModeQuickBar3 = 421,
 79    BuildEditModeQuickBar4 = 422,
 80    BuildEditModeQuickBar5 = 423,
 81    BuildEditModeQuickBar6 = 424,
 82    BuildEditModeQuickBar7 = 425,
 83    BuildEditModeQuickBar8 = 426,
 84    BuildEditModeQuickBar9 = 427,
 85    BuildEditModeDuplicate = 428,
 86    BuildEditModeTranslate = 429,
 87    BuildEditModeRotate = 430,
 88    BuildEditModeScale = 431,
 89    BuildEditModeDelete = 434,
 90    BuildEditModeFocusSelectedEntities = 435,
 91    BuildEditModeReset = 443,
 92    BuildEditHideSelectedEntities = 444,
 93    BuildEditShowAllEntities = 445,
 94    BuildEditModeResetCamera = 446,
 95    BuildEditModeZoomIn = 447,
 96    BuildEditModeZoomOut = 448
 97}
 98
 99/// <summary>
 100/// Mapping for hold actions
 101/// </summary>
 102public enum DCLAction_Hold
 103{
 104    //Remember to explicitly assign the value to each entry so we minimize issues with serialization + conflicts
 105    Sprint = 1,
 106    Jump = 2,
 107    ZoomIn = 3,
 108    ZoomOut = 4,
 109    FreeCameraMode = 101,
 110    VoiceChatRecording = 102,
 111    DefaultConfirmAction = 300,
 112    DefaultCancelAction = 301,
 113    BuildEditModeMultiSelection = 432,
 114    BuildEditModeSquareMultiSelection = 433,
 115    BuildEditModeFirstPersonRotation = 436,
 116    BuildEditModeCameraAdvanceFoward = 437,
 117    BuildEditModeCameraAdvanceBack = 438,
 118    BuildEditModeCameraAdvanceLeft = 439,
 119    BuildEditModeCameraAdvanceRight = 440,
 120    BuildEditModeCameraAdvanceUp = 441,
 121    BuildEditModeCameraAdvanceDown = 442,
 122    BuildEditModeCameraPan = 446,
 123    OpenExpressions = 447
 124}
 125
 126/// <summary>
 127/// Mapping for measurable actions
 128/// </summary>
 129public enum DCLAction_Measurable
 130{
 131    //Remember to explicitly assign the value to each entry so we minimize issues with serialization + conflicts
 132    CharacterXAxis = 1,
 133    CharacterYAxis = 2,
 134    CameraXAxis = 3,
 135    CameraYAxis = 4,
 136    MouseWheel = 5
 137}
 138
 139/// <summary>
 140/// Group of actions currently actived
 141/// </summary>
 142public enum InputTypeMode
 143{
 144    OFF,
 145    GENERAL,
 146    BUILD_MODE_LOADING,
 147    BUILD_MODE
 148}
 149
 150/// <summary>
 151/// Input Controller will map inputs(keys/mouse/axis) to DCL actions, check if they can be triggered (modifiers) and rai
 152/// </summary>
 153public class InputController : MonoBehaviour
 154{
 155    public static bool ENABLE_THIRD_PERSON_CAMERA = true;
 156
 157    [Header("General Input")]
 158    public InputAction_Trigger[] triggerTimeActions;
 159
 160    public InputAction_Hold[] holdActions;
 161    public InputAction_Measurable[] measurableActions;
 162
 163    [Header("BuildMode Input")]
 164    public InputAction_Trigger[] builderTriggerTimeActions;
 165
 166    public InputAction_Hold[] builderHoldActions;
 167    public InputAction_Trigger[] loadingBuilderTriggerTimeActions;
 168
 169    bool renderingEnabled => CommonScriptableObjects.rendererState.Get();
 170    bool allUIHidden => CommonScriptableObjects.allUIHidden.Get();
 171    public InputTypeMode inputTypeMode { get; set; } = InputTypeMode.GENERAL;
 172
 173    private void Update()
 174    {
 175        if (!renderingEnabled)
 176        {
 177            Stop_Measurable(measurableActions);
 178            return;
 179        }
 180
 181        switch (inputTypeMode)
 182        {
 183            case InputTypeMode.OFF:
 184                Stop_Measurable(measurableActions);
 185                return;
 186            case InputTypeMode.GENERAL:
 187                Update_Trigger(triggerTimeActions);
 188                Update_Hold(holdActions);
 189                Update_Measurable(measurableActions);
 190                break;
 191            case InputTypeMode.BUILD_MODE_LOADING:
 192                Update_Trigger(loadingBuilderTriggerTimeActions);
 193                Stop_Measurable(measurableActions);
 194                break;
 195            case InputTypeMode.BUILD_MODE:
 196                Update_Trigger(builderTriggerTimeActions);
 197                Update_Hold(builderHoldActions);
 198                Update_Measurable(measurableActions);
 199                break;
 200        }
 201    }
 202
 203    /// <summary>
 204    /// Map the trigger actions to inputs + modifiers and check if their events must be triggered
 205    /// </summary>
 206    public void Update_Trigger(InputAction_Trigger[] triggerTimeActions)
 207    {
 208        for (var i = 0; i < triggerTimeActions.Length; i++)
 209        {
 210            var action = triggerTimeActions[i];
 211
 212            if (action.isTriggerBlocked != null && action.isTriggerBlocked.Get())
 213                continue;
 214
 215            switch (action.GetDCLAction())
 216            {
 217                case DCLAction_Trigger.CameraChange:
 218                    if (CommonScriptableObjects.cameraModeInputLocked.Get())
 219                        break;
 220
 221                    //Disable until the fine-tuning is ready
 222                    if (ENABLE_THIRD_PERSON_CAMERA)
 223                        InputProcessor.FromKey(action, KeyCode.V,
 224                            modifiers: InputProcessor.Modifier.FocusNotInInput);
 225                    break;
 226                case DCLAction_Trigger.CursorUnlock:
 227                    InputProcessor.FromMouseButtonUp(action, 1, InputProcessor.Modifier.NeedsPointerLocked);
 228#if !WEB_PLATFORM
 229                    InputProcessor.FromKey(action, KeyCode.Escape, modifiers: InputProcessor.Modifier.NeedsPointerLocked
 230#endif
 231                    break;
 232                case DCLAction_Trigger.ToggleNavMap:
 233                    InputProcessor.FromKey(action, KeyCode.M, modifiers: InputProcessor.Modifier.FocusNotInInput);
 234                    break;
 235                case DCLAction_Trigger.ToggleFriends:
 236                    if (allUIHidden)
 237                        break;
 238                    InputProcessor.FromKey(action, KeyCode.L, modifiers: InputProcessor.Modifier.None);
 239                    break;
 240                case DCLAction_Trigger.ToggleWorldChat:
 241                    if (allUIHidden)
 242                        break;
 243                    InputProcessor.FromKey(action, KeyCode.Return, modifiers: InputProcessor.Modifier.None);
 244                    break;
 245                case DCLAction_Trigger.ToggleUIVisibility:
 246                    InputProcessor.FromKey(action, KeyCode.U, modifiers: InputProcessor.Modifier.None);
 247                    break;
 248                case DCLAction_Trigger.CloseWindow:
 249                    if (allUIHidden || DataStore.i.common.isSignUpFlow.Get())
 250                        break;
 251                    InputProcessor.FromKey(action, KeyCode.Escape, modifiers: InputProcessor.Modifier.None);
 252                    break;
 253                case DCLAction_Trigger.ToggleControlsHud:
 254                    InputProcessor.FromKey(action, KeyCode.C, modifiers: InputProcessor.Modifier.FocusNotInInput);
 255                    break;
 256                case DCLAction_Trigger.ToggleSettings:
 257                    InputProcessor.FromKey(action, KeyCode.P, modifiers: InputProcessor.Modifier.FocusNotInInput);
 258                    break;
 259                case DCLAction_Trigger.ToggleStartMenu:
 260                    InputProcessor.FromKey(action, KeyCode.Tab, modifiers: InputProcessor.Modifier.None);
 261                    break;
 262                case DCLAction_Trigger.TogglePlacesAndEventsHud:
 263                    InputProcessor.FromKey(action, KeyCode.X, modifiers: InputProcessor.Modifier.FocusNotInInput);
 264                    break;
 265                case DCLAction_Trigger.ToggleShortcut0:
 266                    InputProcessor.FromKey(action, KeyCode.Alpha0, modifiers: InputProcessor.Modifier.FocusNotInInput);
 267                    break;
 268                case DCLAction_Trigger.ToggleShortcut1:
 269                    InputProcessor.FromKey(action, KeyCode.Alpha1, modifiers: InputProcessor.Modifier.FocusNotInInput);
 270                    break;
 271                case DCLAction_Trigger.ToggleShortcut2:
 272                    InputProcessor.FromKey(action, KeyCode.Alpha2, modifiers: InputProcessor.Modifier.FocusNotInInput);
 273                    break;
 274                case DCLAction_Trigger.ToggleShortcut3:
 275                    InputProcessor.FromKey(action, KeyCode.Alpha3, modifiers: InputProcessor.Modifier.FocusNotInInput);
 276                    break;
 277                case DCLAction_Trigger.ToggleShortcut4:
 278                    InputProcessor.FromKey(action, KeyCode.Alpha4, modifiers: InputProcessor.Modifier.FocusNotInInput);
 279                    break;
 280                case DCLAction_Trigger.ToggleShortcut5:
 281                    InputProcessor.FromKey(action, KeyCode.Alpha5, modifiers: InputProcessor.Modifier.FocusNotInInput);
 282                    break;
 283                case DCLAction_Trigger.ToggleShortcut6:
 284                    InputProcessor.FromKey(action, KeyCode.Alpha6, modifiers: InputProcessor.Modifier.FocusNotInInput);
 285                    break;
 286                case DCLAction_Trigger.ToggleShortcut7:
 287                    InputProcessor.FromKey(action, KeyCode.Alpha7, modifiers: InputProcessor.Modifier.FocusNotInInput);
 288                    break;
 289                case DCLAction_Trigger.ToggleShortcut8:
 290                    InputProcessor.FromKey(action, KeyCode.Alpha8, modifiers: InputProcessor.Modifier.FocusNotInInput);
 291                    break;
 292                case DCLAction_Trigger.ToggleShortcut9:
 293                    InputProcessor.FromKey(action, KeyCode.Alpha9, modifiers: InputProcessor.Modifier.FocusNotInInput);
 294                    break;
 295                case DCLAction_Trigger.ToggleEmoteShortcut0:
 296                    InputProcessor.FromKey(action, KeyCode.Alpha0, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 297                    break;
 298                case DCLAction_Trigger.ToggleEmoteShortcut1:
 299                    InputProcessor.FromKey(action, KeyCode.Alpha1, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 300                    break;
 301                case DCLAction_Trigger.ToggleEmoteShortcut2:
 302                    InputProcessor.FromKey(action, KeyCode.Alpha2, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 303                    break;
 304                case DCLAction_Trigger.ToggleEmoteShortcut3:
 305                    InputProcessor.FromKey(action, KeyCode.Alpha3, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 306                    break;
 307                case DCLAction_Trigger.ToggleEmoteShortcut4:
 308                    InputProcessor.FromKey(action, KeyCode.Alpha4, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 309                    break;
 310                case DCLAction_Trigger.ToggleEmoteShortcut5:
 311                    InputProcessor.FromKey(action, KeyCode.Alpha5, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 312                    break;
 313                case DCLAction_Trigger.ToggleEmoteShortcut6:
 314                    InputProcessor.FromKey(action, KeyCode.Alpha6, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 315                    break;
 316                case DCLAction_Trigger.ToggleEmoteShortcut7:
 317                    InputProcessor.FromKey(action, KeyCode.Alpha7, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 318                    break;
 319                case DCLAction_Trigger.ToggleEmoteShortcut8:
 320                    InputProcessor.FromKey(action, KeyCode.Alpha8, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 321                    break;
 322                case DCLAction_Trigger.ToggleEmoteShortcut9:
 323                    InputProcessor.FromKey(action, KeyCode.Alpha9, modifiers: InputProcessor.Modifier.FocusNotInInput, m
 324                    break;
 325                case DCLAction_Trigger.ChatNextInHistory:
 326                    InputProcessor.FromKey(action, KeyCode.UpArrow, modifiers: InputProcessor.Modifier.OnlyWithInputFocu
 327                    break;
 328                case DCLAction_Trigger.ChatPreviousInHistory:
 329                    InputProcessor.FromKey(action, KeyCode.DownArrow, modifiers: InputProcessor.Modifier.OnlyWithInputFo
 330                    break;
 331                case DCLAction_Trigger.Expression_Wave:
 332                    InputProcessor.FromKey(action, KeyCode.Alpha1,
 333                        modifiers: InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 334                    break;
 335                case DCLAction_Trigger.Expression_FistPump:
 336                    InputProcessor.FromKey(action, KeyCode.Alpha2,
 337                        modifiers: InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 338                    break;
 339                case DCLAction_Trigger.Expression_Robot:
 340                    InputProcessor.FromKey(action, KeyCode.Alpha3,
 341                        modifiers: InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 342                    break;
 343                case DCLAction_Trigger.Expression_RaiseHand:
 344                    InputProcessor.FromKey(action, KeyCode.Alpha4,
 345                        modifiers: InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 346                    break;
 347                case DCLAction_Trigger.Expression_Clap:
 348                    InputProcessor.FromKey(action, KeyCode.Alpha5,
 349                        modifiers: InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 350                    break;
 351                case DCLAction_Trigger.Expression_ThrowMoney:
 352                    InputProcessor.FromKey(action, KeyCode.Alpha6,
 353                        modifiers: InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 354                    break;
 355                case DCLAction_Trigger.Expression_SendKiss:
 356                    InputProcessor.FromKey(action, KeyCode.Alpha7,
 357                        modifiers: InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 358                    break;
 359                case DCLAction_Trigger.BuildEditModeChange:
 360                    InputProcessor.FromKey(action, KeyCode.K, modifiers: InputProcessor.Modifier.FocusNotInInput);
 361                    break;
 362                case DCLAction_Trigger.ToggleVoiceChatRecording:
 363                    InputProcessor.FromKey(action, KeyCode.T, modifiers: InputProcessor.Modifier.FocusNotInInput, modifi
 364                    break;
 365                case DCLAction_Trigger.ToggleAvatarEditorHud:
 366                    InputProcessor.FromKey(action, KeyCode.I, modifiers: InputProcessor.Modifier.FocusNotInInput);
 367                    break;
 368                case DCLAction_Trigger.BuildEditModeToggleUI:
 369                    InputProcessor.FromKey(action, KeyCode.U, modifiers: InputProcessor.Modifier.FocusNotInInput);
 370                    break;
 371                case DCLAction_Trigger.BuildEditModeToggleChangeCamera:
 372                    InputProcessor.FromKey(action, KeyCode.V, modifiers: InputProcessor.Modifier.FocusNotInInput);
 373                    break;
 374                case DCLAction_Trigger.BuildEditModeToggleControls:
 375                    InputProcessor.FromKey(action, KeyCode.C, modifiers: InputProcessor.Modifier.FocusNotInInput);
 376                    break;
 377                case DCLAction_Trigger.BuildEditModeToggleSnapMode:
 378                    InputProcessor.FromKey(action, KeyCode.O, modifiers: InputProcessor.Modifier.FocusNotInInput);
 379                    break;
 380                case DCLAction_Trigger.BuildEditModeRedoAction:
 381                    InputProcessor.FromKey(action, KeyCode.Y, modifiers: InputProcessor.Modifier.FocusNotInInput, modifi
 382                    break;
 383                case DCLAction_Trigger.BuildEditModeUndoAction:
 384                    InputProcessor.FromKey(action, KeyCode.Z, modifiers: InputProcessor.Modifier.FocusNotInInput, modifi
 385                    break;
 386                case DCLAction_Trigger.BuildEditModeQuickBar1:
 387                    InputProcessor.FromKey(action, KeyCode.Alpha1, modifiers: InputProcessor.Modifier.FocusNotInInput);
 388                    break;
 389                case DCLAction_Trigger.BuildEditModeQuickBar2:
 390                    InputProcessor.FromKey(action, KeyCode.Alpha2, modifiers: InputProcessor.Modifier.FocusNotInInput);
 391                    break;
 392                case DCLAction_Trigger.BuildEditModeQuickBar3:
 393                    InputProcessor.FromKey(action, KeyCode.Alpha3, modifiers: InputProcessor.Modifier.FocusNotInInput);
 394                    break;
 395                case DCLAction_Trigger.BuildEditModeQuickBar4:
 396                    InputProcessor.FromKey(action, KeyCode.Alpha4, modifiers: InputProcessor.Modifier.FocusNotInInput);
 397                    break;
 398                case DCLAction_Trigger.BuildEditModeQuickBar5:
 399                    InputProcessor.FromKey(action, KeyCode.Alpha5, modifiers: InputProcessor.Modifier.FocusNotInInput);
 400                    break;
 401                case DCLAction_Trigger.BuildEditModeQuickBar6:
 402                    InputProcessor.FromKey(action, KeyCode.Alpha6, modifiers: InputProcessor.Modifier.FocusNotInInput);
 403                    break;
 404                case DCLAction_Trigger.BuildEditModeQuickBar7:
 405                    InputProcessor.FromKey(action, KeyCode.Alpha7, modifiers: InputProcessor.Modifier.FocusNotInInput);
 406                    break;
 407                case DCLAction_Trigger.BuildEditModeQuickBar8:
 408                    InputProcessor.FromKey(action, KeyCode.Alpha8, modifiers: InputProcessor.Modifier.FocusNotInInput);
 409                    break;
 410                case DCLAction_Trigger.BuildEditModeQuickBar9:
 411                    InputProcessor.FromKey(action, KeyCode.Alpha9, modifiers: InputProcessor.Modifier.FocusNotInInput);
 412                    break;
 413                case DCLAction_Trigger.BuildEditModeDelete:
 414                    InputProcessor.FromKey(action, KeyCode.Delete, modifiers: InputProcessor.Modifier.FocusNotInInput);
 415                    InputProcessor.FromKey(action, KeyCode.Backspace, modifiers: InputProcessor.Modifier.FocusNotInInput
 416                    break;
 417                case DCLAction_Trigger.BuildEditModeDuplicate:
 418                    InputProcessor.FromKey(action, KeyCode.D, modifiers: InputProcessor.Modifier.FocusNotInInput, modifi
 419                    break;
 420                case DCLAction_Trigger.BuildEditModeTranslate:
 421                    InputProcessor.FromKey(action, KeyCode.G, modifiers: InputProcessor.Modifier.FocusNotInInput);
 422                    InputProcessor.FromKey(action, KeyCode.M, modifiers: InputProcessor.Modifier.FocusNotInInput);
 423                    break;
 424                case DCLAction_Trigger.BuildEditModeRotate:
 425                    InputProcessor.FromKey(action, KeyCode.R, modifiers: InputProcessor.Modifier.FocusNotInInput);
 426                    break;
 427                case DCLAction_Trigger.BuildEditModeScale:
 428                    InputProcessor.FromKey(action, KeyCode.S, modifiers: InputProcessor.Modifier.FocusNotInInput);
 429                    break;
 430                case DCLAction_Trigger.BuildEditModeFocusSelectedEntities:
 431                    InputProcessor.FromKey(action, KeyCode.F, modifiers: InputProcessor.Modifier.FocusNotInInput);
 432                    break;
 433                case DCLAction_Trigger.BuildEditModeReset:
 434                    InputProcessor.FromKey(action, KeyCode.R, modifiers: InputProcessor.Modifier.FocusNotInInput, modifi
 435                    break;
 436                case DCLAction_Trigger.BuildEditHideSelectedEntities:
 437                    InputProcessor.FromKey(action, KeyCode.H, modifiers: InputProcessor.Modifier.FocusNotInInput);
 438                    break;
 439                case DCLAction_Trigger.BuildEditShowAllEntities:
 440                    InputProcessor.FromKey(action, KeyCode.H, modifiers: InputProcessor.Modifier.FocusNotInInput, modifi
 441                    break;
 442                case DCLAction_Trigger.BuildEditModeResetCamera:
 443                    InputProcessor.FromKey(action, KeyCode.C, modifiers: InputProcessor.Modifier.FocusNotInInput, modifi
 444                    break;
 445                case DCLAction_Trigger.BuildEditModeZoomIn:
 446                    InputProcessor.FromKey(action, KeyCode.KeypadPlus, modifiers: InputProcessor.Modifier.FocusNotInInpu
 447                    break;
 448                case DCLAction_Trigger.BuildEditModeZoomOut:
 449                    InputProcessor.FromKey(action, KeyCode.KeypadMinus, modifiers: InputProcessor.Modifier.FocusNotInInp
 450                    break;
 451                case DCLAction_Trigger.ToggleQuestsPanelHud:
 452                    InputProcessor.FromKey(action, KeyCode.J, modifiers: InputProcessor.Modifier.FocusNotInInput);
 453                    break;
 454                case DCLAction_Trigger.ToggleAvatarNamesHud:
 455                    InputProcessor.FromKey(action, KeyCode.N, modifiers: InputProcessor.Modifier.FocusNotInInput);
 456                    break;
 457                default:
 458                    throw new ArgumentOutOfRangeException();
 459            }
 460        }
 461    }
 462
 463    /// <summary>
 464    /// Map the hold actions to inputs + modifiers and check if their events must be triggered
 465    /// </summary>
 466    private void Update_Hold(InputAction_Hold[] holdActions)
 467    {
 468        for (var i = 0; i < holdActions.Length; i++)
 469        {
 470            var action = holdActions[i];
 471            switch (action.GetDCLAction())
 472            {
 473                case DCLAction_Hold.Sprint:
 474                    InputProcessor.FromKey(action, InputSettings.WalkButtonKeyCode,
 475                        InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 476                    break;
 477                case DCLAction_Hold.Jump:
 478                    InputProcessor.FromKey(action, InputSettings.JumpButtonKeyCode,
 479                        InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 480                    break;
 481                case DCLAction_Hold.ZoomIn:
 482                    InputProcessor.FromKey(action, KeyCode.KeypadPlus, InputProcessor.Modifier.None);
 483                    InputProcessor.FromKey(action, KeyCode.Plus, InputProcessor.Modifier.None);
 484                    break;
 485                case DCLAction_Hold.ZoomOut:
 486                    InputProcessor.FromKey(action, KeyCode.KeypadMinus, InputProcessor.Modifier.None);
 487                    InputProcessor.FromKey(action, KeyCode.Minus, InputProcessor.Modifier.None);
 488                    break;
 489                case DCLAction_Hold.FreeCameraMode:
 490                    //Disable until the fine-tuning is ready
 491                    if (ENABLE_THIRD_PERSON_CAMERA)
 492                        InputProcessor.FromKey(action, KeyCode.Y, InputProcessor.Modifier.NeedsPointerLocked);
 493                    break;
 494                case DCLAction_Hold.VoiceChatRecording:
 495                    // Push to talk functionality only triggers if no modifier key is pressed
 496                    InputProcessor.FromKey(action, KeyCode.T, InputProcessor.Modifier.FocusNotInInput, null);
 497                    break;
 498                case DCLAction_Hold.DefaultConfirmAction:
 499                    InputProcessor.FromKey(action, KeyCode.E, InputProcessor.Modifier.None);
 500                    break;
 501                case DCLAction_Hold.DefaultCancelAction:
 502                    InputProcessor.FromKey(action, KeyCode.F, InputProcessor.Modifier.None);
 503                    break;
 504                case DCLAction_Hold.BuildEditModeMultiSelection:
 505                    InputProcessor.FromKey(action, KeyCode.LeftShift, InputProcessor.Modifier.FocusNotInInput);
 506                    break;
 507                case DCLAction_Hold.BuildEditModeSquareMultiSelection:
 508                    InputProcessor.FromKey(action, KeyCode.LeftShift, InputProcessor.Modifier.FocusNotInInput);
 509                    break;
 510                case DCLAction_Hold.BuildEditModeFirstPersonRotation:
 511                    InputProcessor.FromKey(action, KeyCode.R, InputProcessor.Modifier.FocusNotInInput);
 512                    break;
 513                case DCLAction_Hold.BuildEditModeCameraAdvanceFoward:
 514                    InputProcessor.FromKey(action, KeyCode.UpArrow, InputProcessor.Modifier.FocusNotInInput);
 515                    InputProcessor.FromKey(action, KeyCode.W, InputProcessor.Modifier.FocusNotInInput);
 516                    break;
 517                case DCLAction_Hold.BuildEditModeCameraAdvanceBack:
 518                    InputProcessor.FromKey(action, KeyCode.DownArrow, InputProcessor.Modifier.FocusNotInInput);
 519                    InputProcessor.FromKey(action, KeyCode.S, InputProcessor.Modifier.FocusNotInInput);
 520                    break;
 521                case DCLAction_Hold.BuildEditModeCameraAdvanceLeft:
 522                    InputProcessor.FromKey(action, KeyCode.LeftArrow, InputProcessor.Modifier.FocusNotInInput);
 523                    InputProcessor.FromKey(action, KeyCode.A, InputProcessor.Modifier.FocusNotInInput);
 524                    break;
 525                case DCLAction_Hold.BuildEditModeCameraAdvanceRight:
 526                    InputProcessor.FromKey(action, KeyCode.RightArrow, InputProcessor.Modifier.FocusNotInInput);
 527                    InputProcessor.FromKey(action, KeyCode.D, InputProcessor.Modifier.FocusNotInInput);
 528                    break;
 529                case DCLAction_Hold.BuildEditModeCameraAdvanceUp:
 530                    InputProcessor.FromKey(action, KeyCode.E, InputProcessor.Modifier.FocusNotInInput);
 531                    break;
 532                case DCLAction_Hold.BuildEditModeCameraAdvanceDown:
 533                    InputProcessor.FromKey(action, KeyCode.Q, InputProcessor.Modifier.FocusNotInInput);
 534                    break;
 535                case DCLAction_Hold.BuildEditModeCameraPan:
 536                    InputProcessor.FromKey(action, KeyCode.LeftShift, InputProcessor.Modifier.FocusNotInInput);
 537                    break;
 538                case DCLAction_Hold.OpenExpressions:
 539                    InputProcessor.FromKey(action, KeyCode.B, InputProcessor.Modifier.FocusNotInInput);
 540                    break;
 541                default:
 542                    throw new ArgumentOutOfRangeException();
 543            }
 544        }
 545    }
 546
 547    /// <summary>
 548    /// Map the measurable actions to inputs + modifiers and check if their events must be triggered
 549    /// </summary>
 550    private void Update_Measurable(InputAction_Measurable[] measurableActions)
 551    {
 552        for (var i = 0; i < measurableActions.Length; i++)
 553        {
 554            var action = measurableActions[i];
 555            switch (action.GetDCLAction())
 556            {
 557                case DCLAction_Measurable.CharacterXAxis:
 558                    InputProcessor.FromAxis(action, "Horizontal",
 559                        InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 560                    break;
 561                case DCLAction_Measurable.CharacterYAxis:
 562                    InputProcessor.FromAxis(action, "Vertical",
 563                        InputProcessor.Modifier.FocusNotInInput | InputProcessor.Modifier.NotInStartMenu);
 564                    break;
 565                case DCLAction_Measurable.CameraXAxis:
 566                    InputProcessor.FromAxis(action, "Mouse X", InputProcessor.Modifier.NeedsPointerLocked);
 567                    break;
 568                case DCLAction_Measurable.CameraYAxis:
 569                    InputProcessor.FromAxis(action, "Mouse Y", InputProcessor.Modifier.NeedsPointerLocked);
 570                    break;
 571                case DCLAction_Measurable.MouseWheel:
 572                    InputProcessor.FromAxis(action, "Mouse ScrollWheel", modifiers: InputProcessor.Modifier.FocusNotInIn
 573                    break;
 574                default:
 575                    throw new ArgumentOutOfRangeException();
 576            }
 577        }
 578    }
 579
 580    private void Stop_Measurable(InputAction_Measurable[] measurableActions)
 581    {
 582        for (var i = 0; i < measurableActions.Length; i++)
 583        {
 584            measurableActions[i].RaiseOnValueChanged(0);
 585        }
 586    }
 587}
 588
 589/// <summary>
 590/// Helper class that wraps the processing of inputs and modifiers to trigger actions events
 591/// </summary>
 592public static class InputProcessor
 593{
 1594    private static readonly KeyCode[] MODIFIER_KEYS = new[] { KeyCode.LeftControl, KeyCode.LeftAlt, KeyCode.LeftShift, K
 595
 596    [Flags]
 597    public enum Modifier
 598    {
 599        //Set the values as bit masks
 600        None = 0b0000000, // No modifier needed
 601        NeedsPointerLocked = 0b0000001, // The pointer must be locked to the game
 602        FocusNotInInput = 0b0000010, // The game focus cannot be in an input field
 603        NotInStartMenu = 0b0000100, // The game focus cannot be in full-screen start menu
 604        OnlyWithInputFocused = 0b0001000 // The game focus must be in an input field
 605    }
 606
 607    /// <summary>
 608    /// Check if the modifier keys are pressed
 609    /// </summary>
 610    /// <param name="modifierKeys"> Keycodes modifiers</param>
 611    /// <returns></returns>
 612    public static Boolean PassModifierKeys(KeyCode[] modifierKeys)
 613    {
 2650596614        for (var i = 0; i < MODIFIER_KEYS.Length; i++)
 615        {
 1150357616            var keyCode = MODIFIER_KEYS[i];
 1150357617            var pressed = Input.GetKey(keyCode);
 1150357618            if (modifierKeys == null)
 619            {
 874705620                if (pressed)
 0621                    return false;
 622            }
 623            else
 624            {
 275652625                if (modifierKeys.Contains(keyCode) != pressed)
 58311626                    return false;
 627            }
 628        }
 629
 174941630        return true;
 631    }
 632
 633    /// <summary>
 634    /// Check if a miscellaneous modifiers are present. These modifiers are related to the meta-state of the application
 635    /// they can be anything such as mouse pointer state, where the focus is, camera mode...
 636    /// </summary>
 637    /// <param name="modifiers"></param>
 638    /// <returns></returns>
 639    public static bool PassModifiers(Modifier modifiers)
 640    {
 333965641        if (IsModifierSet(modifiers, Modifier.NeedsPointerLocked) && !DCL.Helpers.Utils.IsCursorLocked)
 26475642            return false;
 643
 307490644        var isInputFieldFocused = FocusIsInInputField();
 645
 307490646        if (IsModifierSet(modifiers, Modifier.FocusNotInInput) && isInputFieldFocused)
 0647            return false;
 648
 307490649        if (IsModifierSet(modifiers, Modifier.OnlyWithInputFocused) && !isInputFieldFocused)
 10602650            return false;
 651
 296888652        if (IsModifierSet(modifiers, Modifier.NotInStartMenu) && IsStartMenuVisible())
 0653            return false;
 654
 296888655        return true;
 656    }
 657
 58311658    private static bool IsStartMenuVisible() => DataStore.i.exploreV2.isOpen.Get();
 659
 660    /// <summary>
 661    /// Process an input action mapped to a keyboard key.
 662    /// </summary>
 663    /// <param name="action">Trigger Action to perform</param>
 664    /// <param name="key">KeyCode mapped to this action</param>
 665    /// <param name="modifierKeys">KeyCodes required to perform the action</param>
 666    /// <param name="modifiers">Miscellaneous modifiers required for this action</param>
 667    public static void FromKey(InputAction_Trigger action, KeyCode key, KeyCode[] modifierKeys = null,
 668        Modifier modifiers = Modifier.None)
 669    {
 238547670        if (!PassModifiers(modifiers))
 15897671            return;
 672
 222650673        if (!PassModifierKeys(modifierKeys))
 58311674            return;
 675
 164339676        if (Input.GetKeyDown(key))
 0677            action.RaiseOnTriggered();
 164339678    }
 679
 680    /// <summary>
 681    /// Process an input action mapped to a button.
 682    /// </summary>
 683    /// <param name="action">Trigger Action to perform</param>
 684    /// <param name="mouseButtonIdx">Index of the mouse button mapped to this action</param>
 685    /// <param name="modifiers">Miscellaneous modifiers required for this action</param>
 686    public static void FromMouseButton(InputAction_Trigger action, int mouseButtonIdx,
 687        Modifier modifiers = Modifier.None)
 688    {
 0689        if (!PassModifiers(modifiers))
 0690            return;
 691
 0692        if (Input.GetMouseButton(mouseButtonIdx))
 0693            action.RaiseOnTriggered();
 0694    }
 695
 696    public static void FromMouseButtonUp(InputAction_Trigger action, int mouseButtonIdx,
 697        Modifier modifiers = Modifier.None)
 698    {
 5301699        if (!PassModifiers(modifiers))
 5295700            return;
 701
 6702        if (Input.GetMouseButtonUp(mouseButtonIdx))
 0703            action.RaiseOnTriggered();
 6704    }
 705
 706    /// <summary>
 707    /// Process an input action mapped to a keyboard key
 708    /// </summary>
 709    /// <param name="action">Hold Action to perform</param>
 710    /// <param name="key">KeyCode mapped to this action</param>
 711    /// <param name="modifiers">Miscellaneous modifiers required for this action</param>
 712    public static void FromKey(InputAction_Hold action, KeyCode key, Modifier modifiers = Modifier.None)
 713    {
 63612714        if (!PassModifiers(modifiers))
 5295715            return;
 716
 58317717        if (Input.GetKeyDown(key))
 0718            action.RaiseOnStarted();
 58317719        if (Input.GetKeyUp(key))
 0720            action.RaiseOnFinished();
 58317721    }
 722
 723    /// <summary>
 724    /// Process an input action mapped to a keyboard key
 725    /// </summary>
 726    /// <param name="action">Hold Action to perform</param>
 727    /// <param name="key">KeyCode mapped to this action</param>
 728    /// <param name="modifiers">Miscellaneous modifiers required for this action</param>
 729    /// <param name="modifierKeys">KeyCodes required to perform the action</param>
 730    public static void FromKey(InputAction_Hold action, KeyCode key, Modifier modifiers, KeyCode[] modifierKeys)
 731    {
 10602732        if (!PassModifierKeys(modifierKeys))
 0733            return;
 734
 10602735        FromKey(action, key, modifiers);
 10602736    }
 737
 738    /// <summary>
 739    /// Process an input action mapped to a mouse button
 740    /// </summary>
 741    /// <param name="action">Hold Action to perform</param>
 742    /// <param name="mouseButtonIdx">Index of the mouse button</param>
 743    /// <param name="modifiers">Miscellaneous modifiers required for this action</param>
 744    public static void FromMouse(InputAction_Hold action, int mouseButtonIdx, Modifier modifiers = Modifier.None)
 745    {
 0746        if (!PassModifiers(modifiers))
 0747            return;
 748
 0749        if (Input.GetMouseButtonDown(mouseButtonIdx))
 0750            action.RaiseOnStarted();
 0751        if (Input.GetMouseButtonUp(mouseButtonIdx))
 0752            action.RaiseOnFinished();
 0753    }
 754
 755    /// <summary>
 756    /// Process an input action mapped to an axis
 757    /// </summary>
 758    /// <param name="action">Measurable Action to perform</param>
 759    /// <param name="axisName">Axis name</param>
 760    /// <param name="modifiers">Miscellaneous modifiers required for this action</param>
 761    public static void FromAxis(InputAction_Measurable action, string axisName, Modifier modifiers = Modifier.None)
 762    {
 26505763        if (!PassModifiers(modifiers))
 764        {
 10590765            action.RaiseOnValueChanged(0);
 10590766            return;
 767        }
 768
 15915769        action.RaiseOnValueChanged(Input.GetAxis(axisName));
 15915770    }
 771
 772    /// <summary>
 773    /// Bitwise check for the modifiers flags
 774    /// </summary>
 775    /// <param name="modifiers">Modifier to check</param>
 776    /// <param name="value">Modifier mapped to a bit to check</param>
 777    /// <returns></returns>
 778    public static bool IsModifierSet(Modifier modifiers, Modifier value)
 779    {
 0780        int flagsValue = (int)modifiers;
 0781        int flagValue = (int)value;
 782
 0783        return (flagsValue & flagValue) != 0;
 784    }
 785
 786    public static bool FocusIsInInputField()
 787    {
 307490788        if (EventSystem.current == null)
 272794789            return false;
 790
 34696791        if (EventSystem.current.currentSelectedGameObject != null &&
 792            (EventSystem.current.currentSelectedGameObject.GetComponent<TMP_InputField>() != null ||
 793             EventSystem.current.currentSelectedGameObject.GetComponent<UnityEngine.UI.InputField>() != null))
 794        {
 0795            return true;
 796        }
 797
 34696798        return false;
 799    }
 800}
Generated by: ReportGenerator 4.8.9.0
09/09/2022 - 13:27:13
GitHub | www.palmmedia.de

Methods/Properties

InputProcessor()
PassModifierKeys(UnityEngine.KeyCode[])
PassModifiers(InputProcessor/Modifier)
IsStartMenuVisible()
FromKey(InputAction_Trigger, UnityEngine.KeyCode, UnityEngine.KeyCode[], InputProcessor/Modifier)
FromMouseButton(InputAction_Trigger, System.Int32, InputProcessor/Modifier)
FromMouseButtonUp(InputAction_Trigger, System.Int32, InputProcessor/Modifier)
FromKey(InputAction_Hold, UnityEngine.KeyCode, InputProcessor/Modifier)
FromKey(InputAction_Hold, UnityEngine.KeyCode, InputProcessor/Modifier, UnityEngine.KeyCode[])
FromMouse(InputAction_Hold, System.Int32, InputProcessor/Modifier)
FromAxis(InputAction_Measurable, System.String, InputProcessor/Modifier)
IsModifierSet(InputProcessor/Modifier, InputProcessor/Modifier)
FocusIsInInputField()