diff --git a/docs/graphWorld.md b/docs/graphWorld.md index 2ac5b28..70f1bfe 100644 --- a/docs/graphWorld.md +++ b/docs/graphWorld.md @@ -35,11 +35,11 @@ The constructor method for CreateGraphWorld, which initializes an instance of th - `buttonText` (str): Text displayed on buttons. Default is "Start Agent". - `logoPath` (str, optional): File path to the logo image. Default is None. -#### Attributes +## Attributes -- `worldID` (str): Class identifier for the graph world. -- `nodeMap` (dict): Dictionary mapping node IDs to canvas objects. -- `root` (TreeNode): The root of the graph data structure. +- **worldID (str)**: Class identifier for the tree world. +- **nodeMap (dict)**: Dictionary mapping node IDs to canvas objects. +- **_agent**: The agent in the world. ## Methods diff --git a/docs/gridAgent.md b/docs/gridAgent.md index 214dc22..498025a 100644 --- a/docs/gridAgent.md +++ b/docs/gridAgent.md @@ -2,7 +2,13 @@ The `GridAgent` class represents an agent that operates within a grid world environment. -## Parameters +## Initialization + +### `__init__(self, world, agentName:str, agentColor:str="blue", heatMapView:bool=True, heatMapColor:str="#FFA732", agentPos:tuple=(0,0), heatGradient:float=0.05):` + +The constructor initializes an instance of the `GridAgent` class, which represents an agent operating within a grid-based world. + +- **Parameters**: - `world` (CreateGridWorld): The grid world object in which the agent operates. - `agentName` (str): The name of the agent. diff --git a/docs/treeAgent.md b/docs/treeAgent.md index 2d8a9d7..c7755bd 100644 --- a/docs/treeAgent.md +++ b/docs/treeAgent.md @@ -3,7 +3,14 @@ ## Class: `TreeAgent` The `TreeAgent` class represents an agent that operates within a tree-structured environment. The agent can traverse the tree, track its movement, and visualize its path using a heat map. -### Parameters + +## Initialization + +### `__init__(self, world, agentName:str, agentColor:str="blue", heatMapView:bool=True, heatMapColor:str="#FFA732", heatGradient:float=0.05):` + +The constructor initializes an instance of the `TreeAgent` class, which represents an agent operating within a tree-based world. + +- **Parameters**: - **world** (`CreateTreeWorld`): The world object that the agent belongs to. - **agentName** (`str`): The name of the agent. - **agentColor** (`str`, optional): The color of the agent. Defaults to "blue".