doc: Expand API reference for Tiled maps.
authorDavid Thompson <dthompson2@worcester.edu>
Mon, 3 Jun 2019 00:59:34 +0000 (20:59 -0400)
committerDavid Thompson <dthompson2@worcester.edu>
Mon, 3 Jun 2019 00:59:34 +0000 (20:59 -0400)
* doc/api.texi (Tile Maps): Add more procedure documentation.

doc/api.texi

index 9a7591d..beb9e44 100644 (file)
@@ -1543,6 +1543,42 @@ Load the Tiled formatted map in @var{file-name} and return a new tile
 map object.
 @end deffn
 
+@deffn {Procedure} tile-map? obj
+Return @code{#t} if @var{obj} is a tile map.
+@end deffn
+
+@deffn {Procedure} tile-map-orientation tile-map
+Return the orientation of @var{tile-map}.
+@end deffn
+
+@deffn {Procedure} tile-map-width tile-map
+Return the width of @var{tile-map} in tiles.
+@end deffn
+
+@deffn {Procedure} tile-map-height tile-map
+Return the height of @var{tile-map} in tiles.
+@end deffn
+
+@deffn {Procedure} tile-map-tile-width tile-map
+Return the width of tiles in @var{tile-map}.
+@end deffn
+
+@deffn {Procedure} tile-map-tile-height tile-map
+Return the height of tiles in @var{tile-map}.
+@end deffn
+
+@deffn {Procedure} tile-map-tilesets tile-map
+Return the tilesets for @var{tile-map}.
+@end deffn
+
+@deffn {Procedure} tile-map-layers tile-map
+Return the layers of @var{tile-map}.
+@end deffn
+
+@deffn {Procedure} tile-map-properties tile-map
+Return the custom properties of @var{tile-map}.
+@end deffn
+
 @deffn {Procedure} draw-tile-map tile-map [#:layers] [#:region] @
        [#:origin] [#:position] [#:scale] [#:rotation]
 
@@ -1554,6 +1590,154 @@ Refer to @code{draw-sprite} (@pxref{Sprites}) for information about
 the other arguments.
 @end deffn
 
+@subsubsection Tilesets
+
+@deffn {Procedure} tileset? obj
+Return @code{#t} if @var{obj} is a tileset.
+@end deffn
+
+@deffn {Procedure} tileset-name tileset
+Return the name of @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-first-gid tileset
+Return the starting GID of @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-size tileset
+Return the number of tiles in @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-tile-width tileset
+Return the width of tiles in @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-tile-height tileset
+Return the height of tiles in @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-atlas tileset
+Return the texture atlas for @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-tiles tileset
+Return the tiles in @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-properties tileset
+Return the custom properties of @var{tileset}.
+@end deffn
+
+@subsubsection Tiles
+
+@deffn {Procedure} tile? obj
+Return @code{#t} if @var{obj} is a tile.
+@end deffn
+
+@deffn {Procedure} tile-id tile
+Return the ID of @var{tile}.
+@end deffn
+
+@deffn {Procedure} tile-animation tile
+Return the animation for @var{tile}.
+@end deffn
+
+@deffn {Procedure} tile-properties tile
+Return the custom properties of @var{tile}.
+@end deffn
+
+@subsubsection Animations
+
+@deffn {Procedure} animation-frame? obj
+Return @code{#t} if @var{obj} is an animation frame.
+@end deffn
+
+@deffn {Procedure} animation-frame-tile frame
+Return the tile for @var{frame}.
+@end deffn
+
+@deffn {Procedure} animation-frame-duration frame
+Return the duration of @var{frame}.
+@end deffn
+
+@subsubsection Layers
+
+@deffn {Procedure} tile-layer? obj
+Return @code{#t} if @var{obj} is a tile layer.
+@end deffn
+
+@deffn {Procedure} tile-layer-name layer
+Return the name of @var{layer}.
+@end deffn
+
+@deffn {Procedure} tile-layer-width layer
+Return the width in tiles of @var{layer}.
+@end deffn
+
+@deffn {Procedure} tile-layer-height layer
+Return the height in tiles of @var{layer}.
+@end deffn
+
+@deffn {Procedure} tile-layer-tiles layer
+Return the tile data for @var{layer}.
+@end deffn
+
+@deffn {Procedure} tile-layer-properties layer
+Return the custom properties of @var{layer}.
+@end deffn
+
+@deffn {Procedure} object-layer? obj
+Return @code{#t} if @var{obj} is an object layer.
+@end deffn
+
+@deffn {Procedure} object-layer-name layer
+Return the name of @var{layer}.
+@end deffn
+
+@deffn {Procedure} object-layer-objects layer
+Return the objects for @var{layer}.
+@end deffn
+
+@deffn {Procedure} object-layer-properties layer
+Return the custom properties of @var{layer}.
+@end deffn
+
+@subsubsection Objects
+
+@deffn {Procedure} map-object? obj
+Return @code{#t} if @var{obj} is a map object.
+@end deffn
+
+@deffn {Procedure} map-object-id obj
+Return the ID of @var{obj}.
+@end deffn
+
+@deffn {Procedure} map-object-name obj
+Return the name of @var{obj}.
+@end deffn
+
+@deffn {Procedure} map-object-type obj
+Return the type of @var{obj}.
+@end deffn
+
+@deffn {Procedure} map-object-shape obj
+Return the shape of @var{obj}.
+@end deffn
+
+@deffn {Procedure} map-object-properties obj
+Return the custom properties of @var{obj}.
+@end deffn
+
+@subsubsection Polygons
+
+@deffn {Procedure} polygon? obj
+Return @code{#t} if @var{obj} is a polygon.
+@end deffn
+
+@deffn {Procedure} polygon-points polygon
+Return the list of points that form @var{polygon}.
+@end deffn
+
 @node Lines and Shapes
 @subsection Lines and Shapes