birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add some docstring descriptions for Cubemap Texture, Material Asset, Secondary Grid Spacing, & Field of View component properties

Browse Source 
Signed-off-by: jromnoa <80134229+jromnoa@users.noreply.github.com>
This commit is contained in:
jromnoa
2021-11-11 13:23:38 -08:00
parent 01081fea32
commit ad81c311d8
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AutomatedTesting/Gem/PythonTests/Atom/atom_utils/atom_constants.py
+4
View File
@@ -58,6 +58,7 @@ class AtomComponentProperties:
"""
Camera component properties.
:param property: From the last element of the property tree path. Default 'name' for component name string.
- 'Field of view': Sets the value for the camera's FOV (Field of View), i.e. 60.0
:return: Full property path OR component name if no property specified.
"""
properties = {
@@ -204,6 +205,7 @@ class AtomComponentProperties:
"""
Grid component properties.
:param property: From the last element of the property tree path. Default 'name' for component name string.
- 'Secondary Grid Spacing': The spacing value for the secondary grid, i.e. 1.0
:return: Full property path OR component name if no property specified.
"""
properties = {
@@ -234,6 +236,7 @@ class AtomComponentProperties:
"""
HDRi Skybox component properties.
:param property: From the last element of the property tree path. Default 'name' for component name string.
- 'Cubemap Texture': Path to the asset file to use for the cubemap texture asset.
:return: Full property path OR component name if no property specified.
"""
properties = {
@@ -277,6 +280,7 @@ class AtomComponentProperties:
Material component properties. Requires one of Actor OR Mesh 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
- 'Material Asset': Path to the material asset file to use as the material asset.
: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.
"""