> For the complete documentation index, see [llms.txt](https://icosa.gitbook.io/open-brush-plugin-scripting-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://icosa.gitbook.io/open-brush-plugin-scripting-docs/readme/group.md).

# Group

## Summary

Modifies grouped items

## Instance Properties

<table data-full-width="false"><thead><tr><th>Name</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td>images</td><td><a href="/open-brush-plugin-scripting-docs/readme/imagelist.md">ImageList</a><br>Read-only</td><td>All the images in this group</td></tr><tr><td>videos</td><td><a href="/open-brush-plugin-scripting-docs/readme/videolist.md">VideoList</a><br>Read-only</td><td>All the videos in this group</td></tr><tr><td>models</td><td><a href="/open-brush-plugin-scripting-docs/readme/modellist.md">ModelList</a><br>Read-only</td><td>All the models in this group</td></tr><tr><td>guides</td><td><a href="/open-brush-plugin-scripting-docs/readme/guidelist.md">GuideList</a><br>Read-only</td><td>All the guides in this group</td></tr><tr><td>cameraPaths</td><td><a href="/open-brush-plugin-scripting-docs/readme/camerapathlist.md">CameraPathList</a><br>Read-only</td><td>All the camera paths in this group</td></tr></tbody></table>

## Class Methods

### Group:New()

Creates and returns a new empty group

**Returns:** [Group](/open-brush-plugin-scripting-docs/readme/group.md) (The new group)

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myGroup = Group:New()
</strong></code></pre>

## Instance Methods

### group:Add(image)

Adds an image to this group moving it to the group's layer if necessary

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>image</td><td><a href="/open-brush-plugin-scripting-docs/readme/image.md">Image</a></td><td></td><td>The image to add</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myGroup:Add(myImage)
</strong></code></pre>

### group:Add(video)

Adds a video to this group moving it to the group's layer if necessary

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>video</td><td><a href="/open-brush-plugin-scripting-docs/readme/video.md">Video</a></td><td></td><td>The video to add</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myGroup:Add(myVideo)
</strong></code></pre>

### group:Add(model)

Adds a model to this group moving it to the group's layer if necessary

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>model</td><td><a href="/open-brush-plugin-scripting-docs/readme/model.md">Model</a></td><td></td><td>The model to add</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myGroup:Add(myModel)
</strong></code></pre>

### group:Add(guide)

Adds a guide to this group moving it to the group's layer if necessary

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>guide</td><td><a href="/open-brush-plugin-scripting-docs/readme/guide.md">Guide</a></td><td></td><td>The guide to add</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myGroup:Add(myGuide)
</strong></code></pre>

### group:Add(cameraPath)

Adds an image to this group moving it to the group's layer if necessary

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>cameraPath</td><td><a href="/open-brush-plugin-scripting-docs/readme/camerapath.md">CameraPath</a></td><td></td><td>The CameraPath to add</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myGroup:Add(myCameraPath)
</strong></code></pre>

### group:Add(stroke)

Adds a stroke to this group moving it to the group's layer if necessary

**Returns:** nil

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>stroke</td><td><a href="/open-brush-plugin-scripting-docs/readme/stroke.md">Stroke</a></td><td></td><td>The Stroke to add</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myGroup:Add(mystroke)
</strong></code></pre>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://icosa.gitbook.io/open-brush-plugin-scripting-docs/readme/group.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.