files: add F_getsprid description

diff --git a/src/files.c b/src/files.c
index b46856d21fcc8eb63d3697dba10bf37b8d8a58ec..913a5eea0358792653067faeab92a248f74eee7a 100644 (file)
--- a/src/files.c
+++ b/src/files.c
@@ -89,6 +89,22 @@ void F_getresname (char n[8], int r) {
   WADRES_getname(r, n);
 }
 
+// Get sprite resource id.
+// Sprite name has following format:
+//  (nnnn)('A'+s)('0'+d)[('A'+s)('0'+d)]
+//  Letter means animation frame
+//    A for first, B for second...
+//  Number means direction
+//    0 = front
+//    1 = left
+//    2 = right
+//  Optional part means that this file can be used for differnt frame/direction.
+//  Note that if found FRONT direction for this frame than it UNCONDITIONALLY used.
+//  Note that search performed between markers S_START and S_END in order as paced in wad.
+//  int n[4]  -- sprite name
+//  int s     -- sprite frame
+//  int d     -- sprite direction
+//  char *dir -- out flag "alternative used" (
 int F_getsprid (const char n[4], int s, int d, char *dir) {
   s += 'A';
   d += '0';