Show / Hide Table of Contents

Class InputSettings

Project wide settings for input handling @

Inheritance
System.Object
UObject
InputSettings
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class InputSettings : UObject
Remarks

see https://docs.unrealengine.com/latest/INT/Gameplay/Input/index.html

Properties

| Improve this Doc View Source

bAltEnterTogglesFullscreen

Declaration
public bool bAltEnterTogglesFullscreen { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bAlwaysShowTouchInterface

Declaration
public bool bAlwaysShowTouchInterface { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bCaptureMouseOnLaunch

Declaration
public bool bCaptureMouseOnLaunch { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableFOVScaling

Declaration
public bool bEnableFOVScaling { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableGestureRecognizer

Declaration
public bool bEnableGestureRecognizer { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableMouseSmoothing

Declaration
public bool bEnableMouseSmoothing { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bF11TogglesFullscreen

Declaration
public bool bF11TogglesFullscreen { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShowConsoleOnFourFingerTap

Declaration
public bool bShowConsoleOnFourFingerTap { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUseAutocorrect

Declaration
public bool bUseAutocorrect { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUseMouseForTouch

Declaration
public bool bUseMouseForTouch { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static InputSettings DefaultObject { get; }
Property Value
Type Description
InputSettings
| Improve this Doc View Source

DefaultTouchInterface

The default on-screen touch input interface for the game (can be null to disable the onscreen interface)

Declaration
public SoftObjectPath DefaultTouchInterface { get; set; }
Property Value
Type Description
SoftObjectPath
| Improve this Doc View Source

DoubleClickTime

If a key is pressed twice in this amount of time it is considered a "double click"

Declaration
public float DoubleClickTime { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

FOVScale

The scaling value to multiply the field of view by

Declaration
public float FOVScale { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

AddActionMapping(InputActionKeyMapping, Boolean)

Programmatically add an action mapping to the project defaults

Declaration
public void AddActionMapping(InputActionKeyMapping KeyMapping, bool bForceRebuildKeymaps)
Parameters
Type Name Description
InputActionKeyMapping KeyMapping
System.Boolean bForceRebuildKeymaps
| Improve this Doc View Source

AddAxisMapping(InputAxisKeyMapping, Boolean)

Programmatically add an axis mapping to the project defaults

Declaration
public void AddAxisMapping(InputAxisKeyMapping KeyMapping, bool bForceRebuildKeymaps)
Parameters
Type Name Description
InputAxisKeyMapping KeyMapping
System.Boolean bForceRebuildKeymaps
| Improve this Doc View Source

ForceRebuildKeymaps()

When changes are made to the default mappings, push those changes out to PlayerInput key maps

Declaration
public void ForceRebuildKeymaps()
| Improve this Doc View Source

GetActionMappingByName(Name)

Get Action Mapping by Name

Declaration
public IReadOnlyCollection<InputActionKeyMapping> GetActionMappingByName(Name InActionName)
Parameters
Type Name Description
Name InActionName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<InputActionKeyMapping>
| Improve this Doc View Source

GetActionNames()

Populate a list of all defined action names

Declaration
public IReadOnlyCollection<Name> GetActionNames()
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Name>
| Improve this Doc View Source

GetAxisMappingByName(Name)

Retrieve all axis mappings by a certain name.

Declaration
public IReadOnlyCollection<InputAxisKeyMapping> GetAxisMappingByName(Name InAxisName)
Parameters
Type Name Description
Name InAxisName
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<InputAxisKeyMapping>
| Improve this Doc View Source

GetAxisNames()

Populate a list of all defined axis names

Declaration
public IReadOnlyCollection<Name> GetAxisNames()
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Name>
| Improve this Doc View Source

GetInputSettings()

Returns the game local input settings (action mappings, axis mappings, etc...)

Declaration
public static InputSettings GetInputSettings()
Returns
Type Description
InputSettings
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static InputSettings New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
InputSettings
| Improve this Doc View Source

RemoveActionMapping(InputActionKeyMapping, Boolean)

Programmatically remove an action mapping to the project defaults

Declaration
public void RemoveActionMapping(InputActionKeyMapping KeyMapping, bool bForceRebuildKeymaps)
Parameters
Type Name Description
InputActionKeyMapping KeyMapping
System.Boolean bForceRebuildKeymaps
| Improve this Doc View Source

RemoveAxisMapping(InputAxisKeyMapping, Boolean)

Programmatically remove an axis mapping to the project defaults

Declaration
public void RemoveAxisMapping(InputAxisKeyMapping KeyMapping, bool bForceRebuildKeymaps)
Parameters
Type Name Description
InputAxisKeyMapping KeyMapping
System.Boolean bForceRebuildKeymaps
| Improve this Doc View Source

SaveKeyMappings()

Flush the current mapping values to the config file

Declaration
public void SaveKeyMappings()

Operators

| Improve this Doc View Source

Implicit(IntPtr to InputSettings)

Convert from IntPtr to UObject

Declaration
public static implicit operator InputSettings(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
InputSettings
  • Improve this Doc
  • View Source
Back to top Generated by DocFX