AURORA: Document which talktable versions are supported

xoreos · Nov 6, 2016 · 0bb7e78 · 0bb7e78
1 parent 8cf78f6
commit 0bb7e78
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/aurora/talktable_gff.h b/src/aurora/talktable_gff.h
@@ -46,6 +46,10 @@ namespace Aurora {
  *  is implicit in the talk tables file name), nor any other data
  *  besides the raw strings. getSoundResRef() always returns an empty
  *  string.
+ *
+ *  There are two versions of GFF'd talk tables known and supported
+ *  - V0.2, used by Sonic Chronicles and Dragon Age: Origins
+ *  - V0.5, used by Dragon Age II
  */
 class TalkTable_GFF : public TalkTable {
 public:

diff --git a/src/aurora/talktable_tlk.h b/src/aurora/talktable_tlk.h
@@ -48,6 +48,11 @@ namespace Aurora {
  *  format. It has a numerical, game-local ID of the language it
  *  contains, and stores a few more optional data points per string,
  *  like a reference to a voice-over file.
+ *
+ *  There are two versions of TLK files known and supported
+ *  - V3.0, used by Neverwinter Nights, Neverwinter Nights 2, Knight of
+ *    the Old Republic, Knight of the Old Republic II and The Witcher
+ *  - V4.0, used by Jade Empire
  */
 class TalkTable_TLK : public AuroraFile, public TalkTable {
 public: