Class: GenerateSkyboxTool

Defined in: src/agent/tools/GenerateSkyboxTool.ts:10

A tool that generates a 360-degree equirectangular skybox image based on a given prompt using an AI service.

Extends

• Tool

Constructors

Constructor

new GenerateSkyboxTool(ai, scene): GenerateSkyboxTool

Defined in: src/agent/tools/GenerateSkyboxTool.ts:11

Parameters

ai

AI

scene

Scene

Returns

GenerateSkyboxTool

Overrides

Tool.constructor

Properties

behavior?

optional behavior: "BLOCKING" | "NON_BLOCKING"

Defined in: src/agent/Tool.ts:54

Inherited from

Tool.behavior

---

description?

optional description: string

Defined in: src/agent/Tool.ts:51

Inherited from

Tool.description

---

name

name: string

Defined in: src/agent/Tool.ts:50

Inherited from

Tool.name

---

onTriggered()?

optional onTriggered: (args) => unknown

Defined in: src/agent/Tool.ts:53

Parameters

args

unknown

Returns

unknown

Inherited from

Tool.onTriggered

---

parameters?

optional parameters: ToolSchema

Defined in: src/agent/Tool.ts:52

Inherited from

Tool.parameters

Methods

execute()

execute(args): Promise<ToolResult<string>>

Defined in: src/agent/tools/GenerateSkyboxTool.ts:38

Executes the tool's action.

Parameters

args

The prompt to use to generate the skybox.

prompt

string

Returns

Promise<ToolResult<string>>

A promise that resolves with a ToolResult containing success/error information.

Overrides

Tool.execute

---

toJSON()

toJSON(): FunctionDeclaration

Defined in: src/agent/Tool.ts:98

Returns a JSON representation of the tool.

Returns

FunctionDeclaration

A valid FunctionDeclaration object.

Inherited from

Tool.toJSON