Avatar

This view allows you to display an avatar (frame with picture / some initials). It is often used in pair with the AvatarSection view, and to display a character's image. This view is the only way the player can choose a photo for a resource or character stat.

JSON Format

{
  "type": "avatar",
  "id": ...,
  "type": ...,
  "margin_left": ...,
  "margin_right": ...,
  "margin_top": ...,
  "margin_bottom": ...,
  "is_visible": ...,
  "validation_message": ...,
  "photo_stat": ...,
  "name_stat": ...,
  "interactable": ...,
  "preview_enabled": ...,
  "size": ...
}

Fields

Field	Type	Required	Description
id	String	✓	A unique identifier for the view. You can use it to reference view values in stat formulas by doing $view.view_id (where view_id is the id that was assigned to this view by you in the system definition)
type	RPGViewType	✓	The type of this view. Note that these are all in camelCase.
margin_left	double		Optional. How much margin to add to the left of this view.
margin_right	double		Optional. How much margin to add to the right of this view.
margin_top	double		Optional. How much margin to add to the top of this view.
margin_bottom	double		Optional. How much margin to add to the bottom of this view.
is_visible	StatFormulaComponent		Optional. A formula to specify if the view should be visible or not. Must return a bool.
validation_message	StatFormulaComponent		Optional. If this view is an input, you can define this formula to return a message when the input value is invalid. If the input is valid, you should return null. Otherwise, make the formula return the string that should be shown to the user.
photo_stat	String		Optional. A path to a stat in this resource/character that is of the Photo type and that should be displayed (if set).
name_stat	String	✓	The path to a name stat in this resource/character. Will be used to determine initials that will display in the avatar view whenever the photo stat is omitted or isn't set (ie: is null).
interactable	bool		Optional. Defaults to false. Whether this view should be interactable (ie: if tapping or long-pressing it should display a bottom sheet for the user to be able to edit the photo or not). Requires the photo_stat property to be set to work.
preview_enabled	bool		Optional. Defaults to false. Whether this view should display a full-screen version of the picture when tapping it. Requires the photo_stat property to be set to work.
size	AvatarRPGViewSize	✓	The size of this view.