Module view.fields.object_field

ObjectField module

Class ObjectField

ObjectField:ObjectField (opts) ObjectField constructor.


Class ObjectField

ObjectField class. Used to represent various map objects (e.g. Unit).
ObjectField:ObjectField (opts)
ObjectField constructor. It's possible to use this directly, by specifying the bridge parameter. Alternatively, each ObjectBridge class should have a dynamically generated Field. Builtin fields are: UnitField, FeatureField, AreaField and PositionField.

Parameters:

  • opts Table
    • title string Title.
    • bridge Object bridge.

See also:

Usage:

     -- using the bridge parameter
     ObjectField({
         name = "myUnitField",
         bridge = unitBridge,
         title = "My unit",
     })
     -- Using the generated field class
     FeatureField({
         name = "myFeatureField",
         title = "My feature",
     })
generated by LDoc 1.4.3 Last updated 2017-09-23 19:07:28