2023-08-09 09:34:50 -06:00
|
|
|
# objects
|
|
|
|
|
|
2024-09-10 16:51:04 -06:00
|
|
|
|
2024-09-10 16:50:32 -06:00
|
|
|
|
2023-09-04 00:56:23 -06:00
|
|
|
[](https://pkg.go.dev/git.tebibyte.media/tomo/objects)
|
2023-09-04 00:49:24 -06:00
|
|
|
|
2024-09-10 16:51:55 -06:00
|
|
|
Objects contains a standard collection of re-usable objects. It should also be
|
|
|
|
|
viewed as a reference for how to create custom objects in Tomo.
|
2024-08-24 23:58:03 -06:00
|
|
|
|
|
|
|
|
## Styling
|
|
|
|
|
All objects in this module have roles of the form:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
objects.TypeName
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Where `TypeName` is the exact Go type name of the object in question. Objects
|
|
|
|
|
may also have different tags to indicate variations, states, etc. If applicable,
|
|
|
|
|
they are listed and described in the doc comment for the object's type. More
|
|
|
|
|
complex objects may have sub-components that are not accessible from the API.
|
|
|
|
|
These are listed alongside the tags.
|
|
|
|
|
|
|
|
|
|
## Setting Attributes
|
|
|
|
|
It is generally not recommended to set attributes on these objects. However, if
|
|
|
|
|
you must, they can be set by obtaining the object's underlying box through the
|
|
|
|
|
`GetBox` method. Be aware that the exact type of box that is returned here is
|
|
|
|
|
not part of the API, and may change unexpectedly even after v1.0. This caveat
|
2024-08-24 23:59:30 -06:00
|
|
|
also applies to boxes/sub-components making up the internal composition of the
|
|
|
|
|
objects.
|
