unreal.WebAPITypeInfo

class unreal.WebAPITypeInfo(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Holds information for an existing or pending type.

C++ Source:

  • Plugin: WebAPI

  • Module: WebAPIEditor

  • File: WebAPIType.h

Editor Properties: (see get_editor_property/set_editor_property)

  • containing_type (WebAPITypeNameVariant): [Read-Only] When the type is nested, this specifies who “owns” it.

  • debug_string (str): [Read-Only] Misc info for debug.

  • declaration_type (Name): [Read-Only] Declaration type, ie. struct, enum.

  • default_value (str): [Read-Only] Default value as a string, if applicable.

  • display_name (str): [Read-Only] Optional display name, different to the actual name, ie. “JsonObject” vs. “JsonObjectWrapper”.

  • include_paths (Set[str]): [Read-Only] Relative include paths required when referencing this type.

  • is_builtin_type (bool): [Read-Only] If this is false, the type is to be generated and should have a namespace.

  • is_nested (bool): [Read-Only] Flag specifying whether this type is used exclusively by a parent type (isn’t shared).

  • json_name (str): [Read-Only] Field name as sent to and received from the external API.

  • json_property_to_serialize (str): [Read-Only] Optional sub-property to serialize, instead of the object itself.

  • json_type (Name): [Read-Only] Json type. Should correspond with values in EJson.

  • model (Object): [Read-Only] Associated model, if any.

  • modules (Set[str]): [Read-Only] Module dependencies for this type.

  • name (str): [Read-Only] Type Name without prefix or namespace, ie. “Vector”, not “FVector”.

  • namespace (str): [Read-Only] Type Namespace, can be empty for built-in types.

  • pin_color (SlateColor): [Read-Only] Color for UI.

  • prefix (str): [Read-Only] Type Prefix, usually “F”, “U”, “A”, or “E”.

  • print_format_expression (str): [Read-Only] Optional tokenized string expression to get the value for printf, ie. ToString({Property})

  • print_format_specifier (str): [Read-Only] Optional specifier for printf, ie. “s”, “d”.

  • schema_type (WebAPISchemaType): [Read-Only] SchemaType to discern between ie. a Service and a Model with the same name.

  • suffix (str): [Read-Only] Optional suffix, ie. “Parameter”, “Item”, etc.