carla/PythonAPI/docs/blueprint.yml

294 lines
7.0 KiB
YAML

---
- module_name: carla
doc: >
# - CLASSES ------------------------------
classes:
- class_name: ActorAttributeType
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: Bool
doc: >
- var_name: Int
doc: >
- var_name: Float
doc: >
- var_name: String
doc: >
- var_name: RGBColor
doc: >
- class_name: Color
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: r
doc: >
- var_name: g
doc: >
- var_name: b
doc: >
- var_name: a
doc: >
# - METHODS ----------------------------
methods:
- def_name: __init__
params:
- param_name: r
type: int
default: 0
doc: >
- param_name: g
type: int
default: 0
doc: >
- param_name: b
type: int
default: 0
doc: >
- param_name: a
type: int
default: 255
doc: >
doc: >
Client constructor
# --------------------------------------
- def_name: __eq__
params:
- param_name: other
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
doc: >
# --------------------------------------
- def_name: __str__
doc: >
# --------------------------------------
- class_name: ActorAttribute
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: id
type: str
doc: >
- var_name: type
type: carla.ActorAttributeType
doc: >
- var_name: recommended_values
type: list(str)
doc: >
- var_name: is_modifiable
type: bool
doc: >
# - METHODS ----------------------------
methods:
- def_name: as_bool
doc: >
# --------------------------------------
- def_name: as_int
doc: >
# --------------------------------------
- def_name: as_float
doc: >
# --------------------------------------
- def_name: as_str
doc: >
# --------------------------------------
- def_name: as_color
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: other
type: bool
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: other
type: int
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: other
type: float
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: other
type: str
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: other
type: carla.Color
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: other
type: carla.ActorAttribute
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
type: bool
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
type: int
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
type: float
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
type: str
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
type: carla.Color
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: other
type: carla.ActorAttribute
doc: >
# --------------------------------------
- def_name: __nonzero__
doc: >
# --------------------------------------
- def_name: __bool__
doc: >
# --------------------------------------
- def_name: __int__
doc: >
# --------------------------------------
- def_name: __float__
doc: >
# --------------------------------------
- def_name: __str__
doc: >
# --------------------------------------
- def_name: __str__
doc: >
# --------------------------------------
- class_name: ActorBlueprint
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: id
type: str
doc: >
- var_name: tags
type: list(str)
doc: >
# - METHODS ----------------------------
methods:
- def_name: has_tag
return: bool
params:
- param_name: tag
type: str
doc: >
# --------------------------------------
- def_name: match_tags
return: bool
params:
- param_name: wildcard_pattern
type: str
doc: >
Test if any of the flags matches wildcard_pattern.
note: >
Wildcard_pattern follows Unix shell-style wildcards.
# --------------------------------------
- def_name: has_attribute
return: bool
params:
- param_name: id
type: str
doc: >
# --------------------------------------
- def_name: get_attribute
return: carla.ActorAttribute
params:
- param_name: id
type: str
doc: >
Return: carla.ActorAttribute
# --------------------------------------
- def_name: set_attribute
params:
- param_name: id
type: str
doc: >
# --------------------------------------
- param_name: value
type: str
doc: >
doc: >
# --------------------------------------
- def_name: __len__
doc: >
# --------------------------------------
- def_name: __iter__
doc: >
# --------------------------------------
- def_name: __str__
doc: >
# --------------------------------------
- class_name: BlueprintLibrary
# - DESCRIPTION ------------------------
doc: >
# - METHODS ----------------------------
methods:
- def_name: find
doc: >
# --------------------------------------
- def_name: filter
params:
- param_name: wildcard_pattern
type: str
doc: >
Filters a list of ActorBlueprint with id or tags matching wildcard_pattern.
# --------------------------------------
- def_name: __getitem__
params:
- param_name: pos
return: carla.BlueprintLibrary
doc: >
# --------------------------------------
- def_name: __len__
doc: >
# --------------------------------------
- def_name: __iter__
doc: >
# --------------------------------------
- def_name: __str__
doc: >
# --------------------------------------
...