ControllerMapEnablerRule Class |
Settings for persisting the enabled state of Controller Maps.
Inheritance HierarchySystemObject
RewiredControllerMapEnablerRule
RewiredControllerMapEnablerRule
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
[SerializableAttribute] public sealed class Rule
The ControllerMapEnablerRule type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ControllerMapEnablerRule |
Creates a new object instance.
|
| ControllerMapEnablerRule(ControllerMapEnablerRule) |
Creates a copy of an object instance.
|
Properties| Name | Description | |
|---|---|---|
 | categoryId |
The first Map Category id of the Controller Maps the rule applies to.
If you need to set more than one Map Category, use categoryIds instead.
This is optional. If this value is not specified, this will apply to all Controller Maps
regardless of the Map Category id.
[-1 = Match any Map Category id (wildcard)]
Note: If you set this value while an array of categories has already been set, the array will be cleared and only this value will remain.
|
| categoryIds |
The Map Category ids of the Controller Maps the rule applies to.
This is optional. If this value is set to null, this will apply to all Controller Maps
regardless of the Map Category id.
[Null = Match any Map Category id (wildcard)]
|
| categoryName |
The first Map Category of the Controller Maps the rule applies to.
This is an alternate way of setting the Map Category id.
This will automatically be set by the Map Category id and vice versa when changed.
This is optional. If this value is not specified, this will apply to all Controller Maps
regardless of the Map Category.
[Null = Match any Map Category (wildcard)]
Note: If you set this value while an array of categories has already been set, the array will be cleared and only this value will remain.
|
| categoryNames |
The Map Category names of the Controller Maps the rule applies to.
This is an alternate way of setting the Map Category id.
This will automatically be set by the Map Category id and vice versa when changed.
This is optional. If this value is set to null, this will apply to all Controller Maps
regardless of the Map Category.
[Null = Match any Map Category (wildcard)]
|
| controllerSetSelector |
Determines which Controller(s) this applies to.
|
| enable |
The enabled state to be set on the Controller Maps.
|
| layoutId |
The first Layout id of the Controller Maps the rule applies to.
If you need to set more than one Layout, use layoutIds instead.
This is optional. If this value is not specified, this will apply to all Controller Maps
regardless of the Layout id.
[-1 = Match any Layout id (wildcard)]
Note: If you set this value while an array of categories has already been set, the array will be cleared and only this value will remain.
|
| layoutIds |
The Layout ids of the Controller Maps the rule applies to.
This is optional. If this value is set to null, this will apply to all Controller Maps
regardless of the Layout id.
[Null = Match any Layout id (wildcard)]
|
| layoutName |
The first Layout of the Controller Maps the rule applies to.
This is an alternate way of setting the Layout id.
This will automatically be set by the Layout id and vice versa when changed.
This is optional. If this value is not specified, this will apply to all Controller Maps
regardless of the Layout.
[Null = Match any Layout (wildcard)]
Note: If you set this value while an array of categories has already been set, the array will be cleared and only this value will remain.
IMPORTANT: controllerSetSelector must be set before this value is set because controllerType
is used to determine the Controller Type for looking up the Layout id. Alway create the controllerSetSelector before
setting this value as a string. The same limitation does not apply to layoutId.
|
| layoutNames |
The Layout names of the Controller Maps the rule applies to.
This is an alternate way of setting the Layout id.
This will automatically be set by the Layout id and vice versa when changed.
This is optional. If this value is set to null, this will apply to all Controller Maps
regardless of the Layout.
[Null = Match any Layout (wildcard)]
IMPORTANT: controllerSetSelector must be set before this value is set because controllerType
is used to determine the Controller Type for looking up the Layout id. Alway create the controllerSetSelector before
setting this value as a string array. The same limitation does not apply to layoutIds.
|
| tag |
A tag which can be used to find an rule in the list. This is optional.
|
See Also