Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
93 lines (54 sloc) 2.86 KB

The Feedback Form

The feedback form is where players write their report. The feedback form object is highly customizable, and Easy Feedback comes with some prefabs for quickly adding new input fields to your form.

Configuring the Feedback Form

The Feedback Form component has a few exposed fields that can be configured. Unlike the settings found in the configuration window, changing these values will only affect the form instance you are editing.

Feedback Key

The key that toggles the feedback form in-game.

Default: F12

Include screenshot

Whether or not to include a screenshot with the report.

Default: checked

Form

The Form object in the Feedback game object children.

Alert

The Alert object in the Feedback game object children.

Customizing your Feedback Form

By default, the feedback form has category and priority dropdowns, a summary text field, and a detail text field. Objects containing scripts that collect metadata information like system information are also included under the MetadataCollectors object.

All of these elements may be removed or replaced as needed. Additional elements may be added to the form as well.

Form elements

Form elements are any components that alter the report in some way. The report category dropdown, debug log collector, and priority dropdown are all form elements.

.. seealso:: :ref:`report`

Form fields

Form fields are any components that alter a section on the report in some way. The detail text field, as well as most metadata collectors are form fields.

FormField inherits from FormElement, but also exposes some varibles that make it easier to quickly alter how the form field appears on the report.

All form fields have these public variables:

  • Section Title: The title of this field's section on the report.
  • Sort Order: Order of the section in the report (lowest first).

Prefabs

Easy Feedback comes with a few form field prefabs for quick drag and drop customization. These prefabs can be found in the project window at Easy Feedback -> Prefabs -> Fields. To add these fields to your form, just add them as children of Form on the Feedback object.

Dropdown

A simple dropdown input.

Public variables:

  • Label: The label to prepend to this field on the report. No label will be included if this field is left blank.

InputField

A text input field.

Public variables:

  • Label: The label to prepend to this field on the report. No label will be included if this field is left blank.

Toggle

A checkbox.

Public variables:

  • Label: The label to prepend to this field on the report. No label will be included if this field is left blank.
  • Default: The default value of the toggle.