improve docstring descriptions for FOV degrees and Asset.id not asset paths for diff asset properties

Signed-off-by: jromnoa <80134229+jromnoa@users.noreply.github.com>
monroegm-disable-blank-issue-2
jromnoa 4 years ago
parent b36ad7aaff
commit a38c59372c

@ -55,7 +55,7 @@ class AtomComponentProperties:
def camera(property: str = 'name') -> str: def camera(property: str = 'name') -> str:
""" """
Camera component properties. Camera component properties.
- 'Field of view': Sets the value for the camera's FOV (Field of View), i.e. 60.0 - 'Field of view': Sets the value for the camera's FOV (Field of View) in degrees, i.e. 60.0
:param property: From the last element of the property tree path. Default 'name' for component name string. :param property: From the last element of the property tree path. Default 'name' for component name string.
:return: Full property path OR component name if no property specified. :return: Full property path OR component name if no property specified.
""" """
@ -229,7 +229,7 @@ class AtomComponentProperties:
def hdri_skybox(property: str = 'name') -> str: def hdri_skybox(property: str = 'name') -> str:
""" """
HDRi Skybox component properties. HDRi Skybox component properties.
- 'Cubemap Texture': Path to the asset file to use for the cubemap texture asset. - 'Cubemap Texture': Asset.id for the cubemap texture to set.
:param property: From the last element of the property tree path. Default 'name' for component name string. :param property: From the last element of the property tree path. Default 'name' for component name string.
:return: Full property path OR component name if no property specified. :return: Full property path OR component name if no property specified.
""" """
@ -274,7 +274,7 @@ class AtomComponentProperties:
Material component properties. Requires one of Actor OR Mesh component. Material component properties. Requires one of Actor OR Mesh component.
- 'requires' a list of component names as strings required by this component. - 'requires' a list of component names as strings required by this component.
Only one of these is required at a time for this component.\n Only one of these is required at a time for this component.\n
- 'Material Asset': Path to the material asset file to use as the material asset. - 'Material Asset': the material Asset.id of the material.
:param property: From the last element of the property tree path. Default 'name' for component name string. :param property: From the last element of the property tree path. Default 'name' for component name string.
:return: Full property path OR component name if no property specified. :return: Full property path OR component name if no property specified.
""" """

Loading…
Cancel
Save