unreal.ToolCallAsyncResultString

class unreal.ToolCallAsyncResultString(outer: Object | None = None, name: Name | str = 'None')

Bases: ToolCallAsyncResult

Async tool call result that completes with a string.

C++ Source:

• Plugin: ToolsetRegistry

• Module: ToolsetRegistry

• File: ToolCallAsyncResultString.h

Editor Properties: (see get_editor_property/set_editor_property)

• error (str): [Read-Write] If this is an non-empty string, an error occurred while executing the tool that returned this instance. An empty string indicates either no error occurred or the associated tool call is not complete. warning: Do not set this from C++ instead use SetError() or SetValue() if implemented by the subclass.

• is_complete (bool): [Read-Write] Whether the associated tool call is complete and the result via Value and GetValueAsJson() or Error are available to read. warning: Do not set this from C++ instead use SetError() or SetValue() if implemented by the subclass.

• on_completed (ToolCallAsyncResultCompleted): [Read-Write] Notified when the tool call is completes successfully or with an error.

• value (str): [Read-Write] Value of the result.

set_value(value) → bool

Set the result.

Parameters:

value (str)

Return type:

bool

property value: str

[Read-Only] Value of the result.

Type:

(str)