aboutsummaryrefslogtreecommitdiff
path: root/engines/parallaction
diff options
context:
space:
mode:
authorNicola Mettifogo2007-03-11 11:11:05 +0000
committerNicola Mettifogo2007-03-11 11:11:05 +0000
commit555d3ed3170667ef04c43bf57ac7ce0f7f51fe8d (patch)
tree44b9b7fb104f5eaa6ad2c8abf1c56ea5b0f79cd4 /engines/parallaction
parentf17cd6a577cada1c87c6e40671d638813811d5f5 (diff)
downloadscummvm-rg350-555d3ed3170667ef04c43bf57ac7ce0f7f51fe8d.tar.gz
scummvm-rg350-555d3ed3170667ef04c43bf57ac7ce0f7f51fe8d.tar.bz2
scummvm-rg350-555d3ed3170667ef04c43bf57ac7ce0f7f51fe8d.zip
added comment to changeLocation
svn-id: r26081
Diffstat (limited to 'engines/parallaction')
-rw-r--r--engines/parallaction/location.cpp17
1 files changed, 17 insertions, 0 deletions
diff --git a/engines/parallaction/location.cpp b/engines/parallaction/location.cpp
index ca97ceb947..a483635970 100644
--- a/engines/parallaction/location.cpp
+++ b/engines/parallaction/location.cpp
@@ -279,7 +279,24 @@ extern Zone *_hoverZone;
extern Job *_jDrawLabel;
extern Job *_jEraseLabel;
+/*
+ changeLocation handles transitions between locations, and is able to display slides
+ between one and the other. The input parameter 'location' exists in some flavours:
+ 1 - [S].slide.[L]{.[C]}
+ 2 - [L]{.[C]}
+
+ where:
+
+ [S] is the slide to be shown
+ [L] is the location to switch to (immediately in case 2, or right after slide [S] in case 1)
+ [C] is the character to be selected, and is optional
+
+ The routine tells one form from the other by searching for the '.slide.'
+
+ NOTE: there exists one script in which [L] is not used in the case 1, but its use
+ is commented out, and would definitely crash the current implementation.
+*/
void Parallaction::changeLocation(char *location) {
debugC(1, kDebugLocation, "changeLocation to '%s'", location);