diff options
| author | Henrique Campos <henriiquecampos@gmail.com> | 2017-10-29 15:19:38 -0200 |
|---|---|---|
| committer | Henrique Campos <henriiquecampos@gmail.com> | 2017-10-30 12:28:53 -0200 |
| commit | 07d90b0e6f49fdefb44d151f5f772b0feb304887 (patch) | |
| tree | 8ba1d3382ad45744e0ee51070062bcae329a3371 | |
| parent | 9f4f630adf8d96b0a251c478c1ea69da36947503 (diff) | |
[DOCS] Added documentation for OccluderPolygon2D
| -rw-r--r-- | doc/classes/OccluderPolygon2D.xml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml index 99c1536ddf..7bc1f74762 100644 --- a/doc/classes/OccluderPolygon2D.xml +++ b/doc/classes/OccluderPolygon2D.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="OccluderPolygon2D" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Defines a 2D polygon for LightOccluder2D. </brief_description> <description> + Editor facility that helps you draw a 2D polygon used as resource for [LightOccluder2D]. </description> <tutorials> </tutorials> @@ -54,18 +56,24 @@ </methods> <members> <member name="closed" type="bool" setter="set_closed" getter="is_closed"> + If [code]true[/code] closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value [code]true[/code]. </member> <member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="OccluderPolygon2D.CullMode"> + Set the direction of the occlusion culling when not [code]CULL_DISABLED[/code]. Default value [code]DISABLED[/code]. </member> <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> + A [Vector2] array with the index for polygon's vertices positions. </member> </members> <constants> <constant name="CULL_DISABLED" value="0"> + Culling mode for the occlusion. Disabled means no culling. See [member cull_mode]. </constant> <constant name="CULL_CLOCKWISE" value="1"> + Culling mode for the occlusion. Sets the culling to be in clockwise direction. See [member cull_mode]. </constant> <constant name="CULL_COUNTER_CLOCKWISE" value="2"> + Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See [member cull_mode]. </constant> </constants> </class> |