Navigation
API > API/Plugins > API/Plugins/MLAdapter > API/Plugins/MLAdapter/Sensors
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMLAdapterAgentElement
- UMLAdapterSensor
- UMLAdapterSensor_AIPerception
- UMLAdapterSensor_Attribute
- UMLAdapterSensor_Camera
- UMLAdapterSensor_EnhancedInput
- UMLAdapterSensor_Input
- UMLAdapterSensor_Movement
References
| Module | MLAdapter |
| Header | /Engine/Plugins/AI/MLAdapter/Source/MLAdapter/Public/Sensors/MLAdapterSensor.h |
| Include | #include "Sensors/MLAdapterSensor.h" |
Syntax
UCLASS (Abstract, Blueprintable, EditInlineNew)
class UMLAdapterSensor : public UMLAdapterAgentElement
Remarks
Allows an agent to sense information about the game world or itself.
Variables
| Type | Name | Description | |
|---|---|---|---|
| FMLAdapter::FAgentID | AgentID | ||
| uint32: 1 | bIsPolling | ||
| uint32: 1 | bRequiresPawn | ||
| FCriticalSection | ObservationCS | This needs to be locked anytime the sensor is accessing shared state internally. | |
| FTicksOrSeconds | TickEvery | ||
| EMLAdapterTickPolicy | TickPolicy | Determines what frequency this sensor ticks at. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UMLAdapterSensor
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Clean up any references to the Pawn or its components. | ||
| bool | ConfigureForAgent
(
UMLAdapterAgent& Agent |
True if config was successful. | |
| const UMLAdapterAgent & | GetAgent () |
||
| FMLAdapter::FAgentID | GetAgentID () |
AIGym leftovers. Potentially to be removed. | |
| void | |||
| bool | IsConfiguredForAgent
(
const UMLAdapterAgent& Agent |
||
| bool | IsPolling () |
||
| void | OnPawnChanged
(
APawn* OldPawn, |
||
| void | Sense
(
const float DeltaTime |
Called for every sense, regardless of whether it's a polling-type or not. | |
| void | SenseImpl
(
const float DeltaTime |
Called from Sense based on TickPolicy. |
Overridden from UMLAdapterAgentElement
| Type | Name | Description | |
|---|---|---|---|
| void | Called before actuator's destruction. | ||
| void | OnAvatarSet
(
AActor* Avatar |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FTicksOrSeconds |