FCISCharacterInteractionSettings

MODULECharacterInteractionSystemINCLUDEComponents/CISCharacterInteractionComponent.h

The settings of a character interaction component: how the character sees objects, how long the use button is held, which triggers find the objects, which tests choose the best one, and which data object class the character uses. Set them in the class defaults.

Properties

float InteractionAngle = 45.f

The angle, in degrees, of the cone in which the character sees objects. An object is in view while the character's forward direction lies within half of this angle from the direction to the object's facing point. An object can replace it with its own override. Default 45.

Default

45.f

Category

Settings

float TimeToUseObject = 0.f

Seconds the use button must stay held before the use starts. Default 0: the use starts on the next tick. An object's Override Object Use Time replaces it when that is on.

Default

0.f

Category

Settings

TArray<FCISPrimitiveComponentsOnActor> TriggerComponents

The character's components, such as its capsule, whose overlaps make the character track interaction objects. The socket name of an entry is not used here: the triggers ignore it.

Category

Settings

TArray<UCISDetermineUseObjectTest*> TestsToDetermineObjectForUse

The tests that score each tracked object. The scores of the tests are added, and the object with the highest total becomes the best object for use. Each test is a Blueprint or C++ class derived from UCISDetermineUseObjectTest. A new component starts with UCISUseObjectTest_ObjectPriority, which scores each object by its Object Priority.

Category

Settings

float TimeToClearInvalidObjectsData = 90.f

Seconds between two cleanups of the data of objects whose component or data object is no longer valid, and of objects that no longer overlap a trigger. An object in use keeps its data until its use ends. Default 90.

Default

90.f

Category

Settings

float UpdateCurrentUseObjectInterval = 0.1f

Seconds between two searches for the best usable object. OnBestObjectForUseChangedDelegate runs when the best object changes. Default 0.1.

Default

0.1f

Category

Settings

TSubclassOf<UCISInteractionDataObject> DataObjectClass

The data object class that the character gives each tracked object whose own Data Object Class is not overridden. Default UCISInteractionDataObject; when it is cleared, that base class is used.

Category

Settings