Skip to main content

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​

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​

description?​

optional description: string

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

Inherited from​

Tool.description

name​

name: string

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

Inherited from​

Tool.name

onTriggered()?​

optional onTriggered: (args) => unknown

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

Parameters​

args​

unknown

Returns​

unknown

Inherited from​

Tool.onTriggered

parameters?​

optional parameters: ToolSchema

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

Inherited from​

Tool.parameters

Methods​

execute()​

execute(args): Promise<string>

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

Executes the tool's action.

Parameters​

args​

The prompt to use to generate the skybox.

prompt​

string

Returns​

Promise<string>

A promise that resolves with the result of the skybox generation.

Overrides​

Tool.execute

toJSON()​

toJSON(): FunctionDeclaration

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

Returns a JSON representation of the tool.

Returns​

FunctionDeclaration

A valid FunctionDeclaration object.

Inherited from​

Tool.toJSON