ZVISION: More complete engine implementation #532

Marisa-Chan · 2014-11-17T09:28:19Z

No description provided.


        ZVISION: Don't need to set push flag in cursorDown because it's block…

… change cursor image.


        ZVISION: Change platform detection of ZGI, dos->win.


        ZVISION: screenSpaceToImageSpace return 0,0 when pointer outside work…

…ing window.


        ZVISION: Select needed workingWindow for ZGI and Nemesis.


        ZVISION: Detach raw stream reader from RawZorkStream for creating cor…

…rect avi raw reader.


        ZVISION: Streamvideo alwayas skippable. Skippable flag renamed to ski…

…pline.


        ZVISION: New base class similar to control for handling timers, music…

…, etc...


        ZVISION: Basic integration of SideFX into scriptManager.


        ZVISION: Added type field for SideFX


        ZVISION: Move TimerNode to SideFX-based class.


        ZVISION: Correcting TimerNode behavior.


        ZVISION: Style modifing by astyle.


        ZVISION: Forgotten change cursos to pressed in ZGI code.


        ZVISION: New render functions for rendering surface-to-surface.


        ZVISION: SetPartialScreen must update part of currentBackground image.


        ZVISION: Fix changelocation sscanf format string to original format.


        ZVISION: Set right reaction for mouse up/down events.


        ZVISION: Added system StateKey names enum.

RichieSams · 2013-10-22T22:59:05Z

What is the difference between this class and Control? The only thing I can find so far is SideFXType _type and it's being set in the constructor, but never used.

bluegr · 2013-10-31T19:51:13Z

I don't understand this. Why are you trying to rewrite the Control class into this class? Are there any actual benefits, apart from trying to remove inheritance?

Marisa-Chan · 2013-11-03T11:52:22Z

Basic different between control and sidefx is in interactions with user and type-specific. Control produce interactions and results, sidefx class produce only some results. action:kill and action:stop works only with sidefx objects. Additionally action:kill can interact with many sidefx objects like action:kill("ALL") or action:kill("AUDIO"). As well controls may use Mouse and Key interaction methods thats not needed in sidefx. In other words combine it in one class will cause many complication of code and simple graphical methods will be clogged by workarounds.


        ZVISION: New data types for script files and puzzle reference.


        ZVISION: Added clean function for script scope and body for queue

routine.


        ZVISION: Move setState to use queuePuzzle.


        ZVISION: Add flag to puzzle structure for use with new referenceTable.


        ZVISION: Added global StateFlags and set/get/unset functions.


        ZVISION: Refactoring script manager, massive changes.


        ZVISION: Replace disable/enable control functions by call to

getStateFlag.


        ZVISION: Remove not needed (de)serialize functions from controls class.


        ZVISION: Remove field "flags" from puzzle structure.

RichieSams · 2013-10-27T00:54:39Z

All my .scr files read as such: event:change_location(T,E,10,1139)

Marisa-Chan · 2013-10-27T04:10:53Z

Do you test it on real games, on Grand Inquisitor? Or only on syntetic tests from console? 2013/10/27 RichieSams notifications@github.com

…

All my .scr files read as such: event:change_location(T,E,10,1139) — Reply to this email directly or view it on GitHubhttps://github.com/Marisa-Chan/scummvm/commit/2e0e9dc1f64451485532bbd5b3532b6155288f6c#commitcomment-4435871 .

RichieSams · 2013-10-27T05:50:18Z

Yea that's a line from a ZNem .scr file

Marisa-Chan · 2013-10-27T06:32:20Z

And this line from GI action:change_location(p, s, 10, 874) 2013/10/27 RichieSams notifications@github.com

…

Yea that's a line from a ZNem .src file — Reply to this email directly or view it on GitHubhttps://github.com/Marisa-Chan/scummvm/commit/2e0e9dc1f64451485532bbd5b3532b6155288f6c#commitcomment-4436234 .

RichieSams · 2013-10-27T08:01:37Z

:( Kk. I need to look into sscanf anyway due to locale making reading floating-points wrong.

Marisa-Chan · 2013-10-27T08:16:19Z

Yeah, I also found this problem and will provide some solution after reorgonize engine with according to new reversed details. Without it engine will produce some bugs. And original engines are litle different in many things. P.S. For reading float point values original engines use atof.


        ZVISION: Add engine pointer to actionResult for manipulations with

engine.

wjp · 2014-11-17T12:16:35Z

I haven't gone throught the commits/code yet, but this looks like a lot has been improved. Nice work. Could you maybe summarize the current status of the engine? (Since there's no description on the pull request.)

Marisa-Chan · 2014-11-17T12:58:04Z

Implemented all base code and functionality. Games should be completable but massive testing is needed.
But some features not implemented yet like using scummvm load/save/menu dialogs, dvd version support(add handle for video vob's), fan-made translations and another little things

bluegr · 2014-11-17T13:37:15Z

engines/zvision/scripting/script_manager.cpp

+	next_loc.view = stream->readByte();
+	next_loc.offset = stream->readUint32LE() & 0x0000FFFF;
+
+	// What the fck, eos is not 'return pos >= size'


This sounds like a bug (and please remove the swear word). Perhaps the parent stream is not returning the EOS correctly

No, it sounds like eos() behaving exactly as it should.

Is it? I thought that these two should be equivalent:
while (!stream->eos())
and
while (stream->pos() < stream->size())

if pos() >= size(), then the eos flag should be set

No, that's just wrong.

See https://github.com/scummvm/scummvm/blob/master/common/stream.h#L171

bluegr · 2014-11-17T13:38:23Z

engines/zvision/scripting/script_manager.h

 private:
 	ZVision *_engine;
+
+	struct script_scope {


CamelCase: script_scope -> scriptScope (same for the struct members)

bluegr · 2014-11-17T13:38:59Z

engines/zvision/scripting/script_manager.h

+
+		PuzzleList *scope_queue; // For adding puzzles to queue
+		PuzzleList *exec_queue;  // Switch to it when execute
+		PuzzleList _priv_queue_one;


Why do you use an underscore prefix here? We use underscore prefixes for global variables in ScummVM

We don't use the underscore prefix for global variables. It's for class
variables. The struct should be consistent, though.

Yes, I should have said class member variables here. Here's the page with our code formatting conventions, esp. variable naming.
http://wiki.scummvm.org/index.php/Code_Formatting_Conventions#Naming

bluegr · 2014-11-17T13:39:13Z

engines/zvision/scripting/script_manager.h

+	struct puzzle_ref {
+		Puzzle *puz;
+		script_scope *scope;
+	};


CamelCase again

bluegr · 2014-11-17T13:39:56Z

engines/zvision/scripting/sidefx.h

+// TODO: Implement FistControl
+// TODO: Implement HotMovieControl
+// TODO: Implement PaintControl
+// TODO: Implement TilterControl


These have been implemented, so these TODOs can be removed

bluegr · 2014-11-17T13:40:17Z

engines/zvision/scripting/sidefx/distort_node.cpp

+
+namespace ZVision {
+
+DistortNode::DistortNode(ZVision *engine, uint32 key, int16 speed, float st_angl, float en_angl, float st_lin, float en_lin)


bluegr · 2014-11-17T13:41:59Z

engines/zvision/scripting/sidefx/ttytext_node.h

+	//int16 x;
+	//int16 y;
+	//uint16 w;
+	//uint16 h;


These should probably be removed now, since they are contained in the rect above

bluegr · 2014-11-17T13:49:34Z

engines/zvision/text/text.cpp

+			break;
+		}
+
+		// Crush each octet pair to a single octet with a simple cast


This doesn't look endian-safe... you should either use the endian-safe functions in endian.h, or add an if (SCUMMVM_BIG_ENDIAN) check

Why doesn't it look endian safe? Looks fine to me.

Hm, yes, disregard my original post, the code below is OK

The comments and variable names are confusing, though. "asciiString" doesn't seem to be ASCII, and I'm not sure what "Crush each octet pair to a single octet with a simple cast" refers to.

That's my old comment. The text files assume UTF16. However, we don't currently support UTF16. My old code just naively truncated the uint16 to a single byte

bluegr · 2014-11-17T13:51:56Z

engines/zvision/utility/win_keys.h

-#ifndef ZVISION_INVENTORY_MANAGER_H
-#define ZVISION_INVENTORY_MANAGER_H
+#ifndef ZVISION_WINKEY_H
+#define ZVISION_WINKEY_H


ZVISION_WINKEY_H -> ZVISION_WIN_KEYS_H


        ZVISION: Added detection for Zork Grand Inquisitor English Demo.


        ZVISION: Added detection for Zork Nemesis English Demo.


        ZVISION: Added detection for Zork Grand Inquisitor English DVD version.


        Merge pull request #2 from khbecker/zvision

ZVISION: (SECOND ATTEMPT) Add detection for Zork Nemesis and Zork Grand Inquisitor demos and Zork Grand Inquisitor DVD version


        ZVISION: Implement forgotten setVenus for controls


        ZVISION: More CamelCase and a bit of comments cleanup


        ZVISION: Remove wrong TODO from scripting/sidefx.h

Marisa-Chan · 2014-11-20T09:40:20Z

Huge renamings applied. Maybe something is missed.

bluegr · 2014-11-23T17:13:45Z

engines/zvision/core/events.cpp

+
+		if (checkCode("MIKESPANTS")) {
+			_scriptManager->changeLocation('g', 'j', 't', 'm', 0);
+		}


Just to add to this list: there are 3 more cheats in ZGI - "EAT ME", "WHOAMI" and "HUISOK". Check here:
http://www.mrbillsadventureland.com/amusing/funthings/zorkF/zgiF.htm

Those cheats are scripted in gjcr.scr, hp1e.scr, uh1f.scr

It would be good to add a small comment about these, then

bluegr · 2014-12-01T10:34:49Z

Overall, there are huge changes here, all major improvements, and almost all of the missing features have been implemented. Great work!

IMHO, this can be merged as-is, and any further development can continue in-tree. Some rough edges might need to be fixed here and there, but they're all minor issues.

Unless anyone objects, I'll merge this by tomorrow night (Tuesday, the 2nd of November).

RichieSams · 2014-12-01T16:22:57Z

I agree with @bluegr. Any further changes can be done in-branch. (Though I think you mean the 2nd of December :P)

I finally have a free week this week. So I intend to look further into the changes.

bluegr · 2014-12-02T22:06:34Z

Merging as mentioned already. Great work, thanks! Further changes will be continued in-tree


        Merge pull request #532 from Marisa-Chan/zvision

ZVISION: More complete engine implementation


        ZVISION: Document some more cheats for ZGI

Thanks to marisa-chan for providing the location of those in pull request #532

clone2727 · 2015-01-10T19:49:55Z

The bracket syntax is C99. Do all our platforms support this?

Marisa-Chan added 18 commits Oct 15, 2013

ZVISION: Don't need to set push flag in cursorDown because it's block…

4baa180

… change cursor image.

ZVISION: Change platform detection of ZGI, dos->win.

cf99a88

ZVISION: screenSpaceToImageSpace return 0,0 when pointer outside work…

b9ad7e8

…ing window.

ZVISION: Select needed workingWindow for ZGI and Nemesis.

f1c6b58

ZVISION: Detach raw stream reader from RawZorkStream for creating cor…

2050987

…rect avi raw reader.

ZVISION: Streamvideo alwayas skippable. Skippable flag renamed to ski…

7a3518d

…pline.

ZVISION: New base class similar to control for handling timers, music…

82348a7

…, etc...

ZVISION: Basic integration of SideFX into scriptManager.

a6f025c

ZVISION: Added type field for SideFX

96ac92a

ZVISION: Move TimerNode to SideFX-based class.

4ac2c3e

ZVISION: Correcting TimerNode behavior.

aefa58f

ZVISION: Style modifing by astyle.

25834fa

ZVISION: Forgotten change cursos to pressed in ZGI code.

bbe2950

ZVISION: New render functions for rendering surface-to-surface.

dbdefe2

ZVISION: SetPartialScreen must update part of currentBackground image.

db3d154

ZVISION: Fix changelocation sscanf format string to original format.

2e0e9dc

ZVISION: Set right reaction for mouse up/down events.

3e51ed6

ZVISION: Added system StateKey names enum.

9888e66

Marisa-Chan added 9 commits Oct 24, 2013

ZVISION: New data types for script files and puzzle reference.

803ff02

ZVISION: Added clean function for script scope and body for queue

d8ad0e5

routine.

ZVISION: Move setState to use queuePuzzle.

91cbb1e

ZVISION: Add flag to puzzle structure for use with new referenceTable.

c87ca1b

ZVISION: Added global StateFlags and set/get/unset functions.

8e4070c

ZVISION: Refactoring script manager, massive changes.

c0a709d

ZVISION: Replace disable/enable control functions by call to

6d5e8cb

getStateFlag.

ZVISION: Remove not needed (de)serialize functions from controls class.

4d02fe4

ZVISION: Remove field "flags" from puzzle structure.

6ace820

ZVISION: Add engine pointer to actionResult for manipulations with

66c9d1d

engine.

bluegr reviewed Nov 17, 2014
View changes

engines/zvision/scripting/script_manager.h Outdated

private:

ZVision *_engine;

struct script_scope {

This comment has been minimized.

Sign in to view

Copy link

bluegr Nov 17, 2014
Member

CamelCase: script_scope -> scriptScope (same for the struct members)

bluegr reviewed Nov 17, 2014
View changes

engines/zvision/scripting/script_manager.h Outdated

struct puzzle_ref {

Puzzle *puz;

script_scope *scope;

};

This comment has been minimized.

Sign in to view

Copy link

bluegr Nov 17, 2014
Member

CamelCase again

bluegr reviewed Nov 17, 2014
View changes

engines/zvision/scripting/sidefx/ttytext_node.h Outdated

//int16 x;

//int16 y;

//uint16 w;

//uint16 h;

This comment has been minimized.

Sign in to view

Copy link

bluegr Nov 17, 2014
Member

These should probably be removed now, since they are contained in the rect above

bluegr reviewed Nov 17, 2014
View changes

khbecker mentioned this pull request Nov 17, 2014

ZVISION: Add detection for Zork Nemesis and Zork Grand Inquisitor demos and Zork Grand Inquisitor DVD version #1

Merged

Marisa-Chan force-pushed the Marisa-Chan:zvision branch from fdb11de to e6f6687 Nov 19, 2014

khbecker and others added 5 commits Nov 19, 2014

ZVISION: Added detection for Zork Grand Inquisitor English Demo.

f7b2cd0

ZVISION: Added detection for Zork Nemesis English Demo.

b12b1e1

ZVISION: Added detection for Zork Grand Inquisitor English DVD version.

deeeb06

Merge pull request #2 from khbecker/zvision

03d33e8

ZVISION: (SECOND ATTEMPT) Add detection for Zork Nemesis and Zork Grand Inquisitor demos and Zork Grand Inquisitor DVD version

ZVISION: Implement forgotten setVenus for controls

d5f7a1d

Marisa-Chan force-pushed the Marisa-Chan:zvision branch from 70ae3c5 to d5f7a1d Nov 20, 2014

Marisa-Chan added 2 commits Nov 20, 2014

ZVISION: More CamelCase and a bit of comments cleanup

5b352da

ZVISION: Remove wrong TODO from scripting/sidefx.h

596a904

bluegr reviewed Nov 23, 2014
View changes

bluegr added a commit that referenced this pull request Dec 2, 2014

Merge pull request #532 from Marisa-Chan/zvision

637102d

ZVISION: More complete engine implementation

bluegr merged commit 637102d into scummvm:master Dec 2, 2014

bluegr added a commit that referenced this pull request Dec 3, 2014

ZVISION: Document some more cheats for ZGI

bbec6c9

Thanks to marisa-chan for providing the location of those in pull request #532


		namespace ZVision {

		DistortNode::DistortNode(ZVision *engine, uint32 key, int16 speed, float st_angl, float en_angl, float st_lin, float en_lin)

scummvm / scummvm

Join GitHub today

ZVISION: More complete engine implementation #532

ZVISION: More complete engine implementation #532

Conversation

Marisa-Chan commented Nov 17, 2014

This comment has been minimized.

RichieSams commented on 82348a7 Oct 22, 2013

This comment has been minimized.

bluegr replied Oct 31, 2013

This comment has been minimized.

Marisa-Chan replied Nov 3, 2013

This comment has been minimized.

RichieSams commented on 2e0e9dc Oct 27, 2013

This comment has been minimized.

Marisa-Chan replied Oct 27, 2013

This comment has been minimized.

RichieSams replied Oct 27, 2013

This comment has been minimized.

Marisa-Chan replied Oct 27, 2013

This comment has been minimized.

RichieSams replied Oct 27, 2013

This comment has been minimized.

Marisa-Chan replied Oct 27, 2013

wjp commented Nov 17, 2014

Marisa-Chan commented Nov 17, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Marisa-Chan commented Nov 20, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

bluegr commented Dec 1, 2014

RichieSams commented Dec 1, 2014

bluegr commented Dec 2, 2014

This comment has been minimized.

clone2727 commented on engines/zvision/subtitles.cpp in ac9b74d Jan 10, 2015

RichieSams commented on `82348a7` Oct 22, 2013

RichieSams commented on `2e0e9dc` Oct 27, 2013

clone2727 commented on `engines/zvision/subtitles.cpp` in `ac9b74d` Jan 10, 2015