atiran/porymap
3
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Fix manual typos in setClippingRect

Browse source
This commit is contained in:
GriffinR 2022-10-10 13:23:04 -04:00 committed by GitHub
parent 150c02b05b
commit 0f49c76757
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docsrc/manual/scripting-capabilities.rst
View file

@ -1055,17 +1055,17 @@ All overlay functions are callable via the global ``overlay`` object.
Sets the rectangular clipping region for the specifieid overlay layer. A clipping region will cause the overlay's rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle. Sets the rectangular clipping region for the specifieid overlay layer. A clipping region will cause the overlay's rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle.
:param number x: the rectangle's pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border's region is :param number x: the rectangle's pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border's region is
:param number x: the rectangle's pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border's region is :param number y: the rectangle's pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border's region is
:param number width: the rectangle's pixel width :param number width: the rectangle's pixel width
:param number height: the rectangle's pixel height :param number height: the rectangle's pixel height
:param number layer: the layer id :param number layer: the layer id
.. js:function:: overlay.setClippingRect(x, y, width, height, layer) .. js:function:: overlay.setClippingRect(x, y, width, height)
This is an overloaded function. Sets the rectangular clipping region for all overlay layers. A clipping region will cause the overlay's rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle. This is an overloaded function. Sets the rectangular clipping region for all overlay layers. A clipping region will cause the overlay's rendering to be contained inside it. In other words, any content from the overlay layer will not be visible outside of the specified rectangle.
:param number x: the rectangle's pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border's region is :param number x: the rectangle's pixel x coordinate, 0 is the left edge of the current map. A negative value is where the left map border's region is
:param number x: the rectangle's pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border's region is :param number y: the rectangle's pixel y coordinate, 0 is the top edge of the current map. A negative value is where the top map border's region is
:param number width: the rectangle's pixel width :param number width: the rectangle's pixel width
:param number height: the rectangle's pixel height :param number height: the rectangle's pixel height