unreal.WebAPIOperationParameter
¶
- class unreal.WebAPIOperationParameter(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
WebAPIProperty
Web APIOperation Parameter
C++ Source:
Plugin: WebAPI
Module: WebAPIEditor
File: WebAPIOperation.h
Editor Properties: (see get_editor_property/set_editor_property)
default_value
(str): [Read-Write] Default value (optional) as a string.default_values
(Array[str]): [Read-Write] Array of values if needed, ie. enumdescription
(str): [Read-Only] Describes this model.is_array
(bool): [Read-Write] If the property is an array of Type.is_mixin
(bool): [Read-Write] When the properties inside of this should be treated as though they’re directly in the parent.is_read_only
(bool): [Read-Only] By default all properties are read & write.is_required
(bool): [Read-Only] By default all properties are optional.maximum_value
(double): [Read-Only] Maximum value. Can also indicate maximum string length.media_type
(str): [Read-Write] The optional media-type, ie. “application/json”.minimum_value
(double): [Read-Only] Minimum value. Can also indicate minimum string length.model
(WebAPIModel): [Read-Write] Optional model definition.name
(WebAPINameVariant): [Read-Write] Name of the Property.pattern
(str): [Read-Only] Regex Pattern to validate against.storage
(WebAPIParameterStorage): [Read-Write] Where this parameter is stored/encoded in the request.type
(WebAPITypeNameVariant): [Read-Write] Type of the Property.use_maximum_value
(bool): [Read-Only] Whether to use Maximum value.use_minimum_value
(bool): [Read-Only] Whether to use Minimum value.use_pattern
(bool): [Read-Only] Whether to use a Regex Pattern for validation.