tomo/objects
tomo/objects
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases 27 Wiki Activity
38434db75c
objects/README.md

1.2 KiB
Raw Blame History

objects

Some of the objects in this package

Go Reference

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.

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 also applies to boxes/sub-components making up the internal composition of the objects.