Metadata-Version: 2.4
Name: boacon
Version: 0.0.1
Project-URL: Homepage, https://github.com/blackrookgames/boacon
Project-URL: Issues, https://github.com/blackrookgames/boacon/issues
Author-email: Black Rook Games <blackrookgames@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.13
Requires-Dist: numpy>=2.4.1
Requires-Dist: windows-curses>=2.4.1; sys_platform == 'win32'
Description-Content-Type: text/markdown

<a id="boacon"></a>

# boacon

<a id="boacon.init"></a>

#### init

```python
def init()
```

<a id="boacon.final"></a>

#### final

```python
def final()
```

<a id="boacon.state"></a>

#### state

```python
def state()
```

State of the boacon system

<a id="boacon.panes"></a>

#### panes

```python
def panes()
```

Panes that are being displayed

:raise BCError:
    boacon system is not currently running

<a id="boacon.on_init"></a>

#### on\_init

```python
def on_init()
```

Emitted after the boacon system is initialized

<a id="boacon.on_final"></a>

#### on\_final

```python
def on_final()
```

Emitted before the boacon system is finalized

<a id="boacon.postdraw"></a>

#### postdraw

```python
def postdraw()
```

Emitted after drawing the panes and right before the screen is refreshed

:raise BCError:
    boacon system is not currently running

<a id="boacon.refresh"></a>

#### refresh

```python
def refresh()
```

Refreshes the screen

:raise BCError:
    boacon system is not currently running

<a id="boacon.getch"></a>

#### getch

```python
def getch()
```

Gets a character code from the keyboard

:return:
    Character code (or -1 if no character is pressed)
:raise BCError:
    boacon system is not currently running

<a id="boacon.get_border"></a>

#### get\_border

```python
def get_border()
```

Gets whether or not pane borders are enabled

:raise BCError:
    boacon system is not currently running

<a id="boacon.set_border"></a>

#### set\_border

```python
def set_border(value: bool)
```

Sets whether or not pane borders are enabled

:raise BCError:
    boacon system is not currently running

