• Home
• NScumm
• Scumm
• ScummEngine

C# Class NScumm.Scumm.ScummEngine

Datei anzeigen Open project: scemino/nscumm Class Usage Examples

Public Properties

Property	Type	Description
CharsetColorMap	byte[]
NewLineCharacter	byte
TownsCharsetColorMap	byte[]
VariableActiveObject1	int?
VariableActiveObject2	int?
VariableActiveVerb	int?
VariableCameraAccelX	int?
VariableCameraAccelY	int?
VariableCameraFastX	int?
VariableCameraMaxX	int?
VariableCameraMaxY	int?
VariableCameraMinX	int?
VariableCameraMinY	int?
VariableCameraPosX	int?
VariableCameraPosY	int?
VariableCameraThresholdX	int?
VariableCameraThresholdY	int?
VariableCharCount	int?
VariableCharIncrement	int?
VariableCurrentDisk	int?
VariableCurrentLights	int?
VariableCursorState	int?
VariableCutSceneEndScript	int?
VariableCutSceneExitKey	int?
VariableCutSceneStartScript	int?
VariableDebugMode	int?
VariableDefaultTalkDelay	int?
VariableEgo	int?
VariableEntryScript	int?
VariableEntryScript2	int?
VariableExitScript	int?
VariableExitScript2	int?
VariableFadeDelay	int?
VariableFixedDisk	int?
VariableGameLoaded	int?
VariableHaveMessage	int?
VariableHeapSpace	int?
VariableInputMode	int?
VariableInventoryScript	int?
VariableLastSound	int?
VariableLeftButtonDown	int?
VariableLeftButtonHold	int?
VariableMainMenu	int?
VariableMemoryPerformance	int?
VariableMouseX	int?
VariableMouseY	int?
VariableMusicBundleLoaded	int?
VariableMusicTimer	int?
VariableNewRoom	int?
VariableNoSubtitles	int?
VariableOverride	int?
VariableRightButtonDown	int?
VariableRightButtonHold	int?
VariableRoom	int?
VariableRoomFlag	int?
VariableRoomHeight	int?
VariableRoomResource	int?
VariableRoomWidth	int?
VariableSaveLoadScript	int?
VariableSaveLoadScript2	int?
VariableScrollScript	int?
VariableSentenceScript	int?
VariableSoundParam	int?
VariableSoundParam2	int?
VariableSoundParam3	int?
VariableSoundResult	int?
VariableSoundcard	int?
VariableTalkActor	int?
VariableTalkStopKey	int?
VariableTalkStringY	int?
VariableTimer	int?
VariableTimer1	int?
VariableTimer2	int?
VariableTimer3	int?
VariableTimerNext	int?
VariableTimerTotal	int?
VariableUserPut	int?
VariableV6EMSSpace	int?
VariableV6SoundMode	int?
VariableVerbAllowed	int?
VariableVerbScript	int?
VariableVideoMode	int?
VariableVideoPerformance	int?
VariableVirtualMouseX	int?
VariableVirtualMouseY	int?
VariableVoiceBundleLoaded	int?
VariableVoiceMode	int?
VariableWalkToObject	int?
_16BitPalette	ushort[]

Protected Properties

Property	Type	Description
_actorToPrintStrFor	int
_bgNeedsRedraw	bool
_bitVars	BitArray
_boxMatrix	List
_charset	CharsetRenderer
_charsetBufPos	int
_charsetBuffer	byte[]
_charsetColor	byte
_charsetData	byte[][]
_colorCycle	ColorCycle[]
_curPalIndex	int
_currentCursor	int
_currentScriptData	byte[]
_cursor	Cursor
_cursorData	byte[]
_cursorHotspots	byte[]
_cursorImages	ushort[][]
_darkenPalette	Palette
_defaultTalkDelay	int
_disableFadeInEffect	bool
_flashlight	FlashLight
_fullRedraw	bool
_gfxManager	IGraphicsManager
_haveActorSpeechMsg	bool
_haveMsg	int
_inputManager	IInputManager
_inputState	ScummInputState
_invData	ObjectData[]
_inventory	ushort[]
_keepText	bool
_mainVirtScreen	VirtScreen
_mousePos	Point
_newEffect	byte
_nextLeft	int
_objs	ObjectData[]
_opCode	byte
_opCodes	Action>.Dictionary
_palManipCounter	int
_palManipEnd	int
_palManipIntermediatePal	Palette
_palManipPalette	Palette
_palManipStart	int
_resManager	ResourceManager
_resourceMapper	byte[]
_resultVarIndex	int
_roomResource	byte
_saveLoadFlag	int
_saveLoadSlot	int
_saveSound	bool
_saveTemporaryState	bool
_savegame	string
_screenEndStrip	int
_screenStartStrip	int
_shadowPalette	byte[]
_stack	Stack
_strings	byte[][]
_talkDelay	int
_textPalette	byte[]
_townsActiveLayerFlags	byte
_townsClearLayerFlag	byte
_townsScreen	TownsScreen
_userPut	sbyte
_userState	UserStates
cursorColor	byte
defaultCursorColors	byte[]
mouseAndKeyboardStat	KeyCode
roomData	Room

Private Properties

Property	Type	Description
AnimateCursor	void
CheckThumbnailHeader	bool
CheckXYInBoxBounds	bool
ClearRoomObjects	void
ConvertIntMessage	int
ConvertNameMessage	int
ConvertStringMessage	int
ConvertVerbMessage	int
CreateCharset	void
CreateCharsetData	byte[][]
DecreaseScriptDelay	void
DoCycleIndirectPalette	void
DoCyclePalette	void
DoCyclePalette	void
DoTransitionEffect	void
EncodeName	byte[]
FindVirtScreen	NScumm.Scumm.Graphics.VirtScreen
GetBoxCoordinates	BoxCoords
GetBoxFlags	BoxFlags
GetBoxMask	int
GetClass	bool
GetCurrentLights	LightModes
GetInventorySlot	int
GetMaskBuffer	NScumm.Scumm.Graphics.PixelNavigator
GetNextBox	int
GetNumBoxes	int
GetNumZBuffers	int
GetObjectOrActorXY	bool
GetOrderedActors	IEnumerable
GetSavegameName	bool
GetScriptSlotIndex	byte
GetTimeToWaitBeforeLoop	System.TimeSpan
HandleActors	void
HandleEffects	void
HandleNextCharsetCode	bool
InitActors	void
InitSentences	NScumm.Scumm.Sentence[]
InitializeVerbs	void
IsCostumeInUse	bool
IsLightOn	bool
LoadHeader	NScumm.Core.Graphics.ThumbnailHeader
LoadInfos	NScumm.Scumm.IO.SaveStateMetaInfos
LoadResource	void
LoadSaveGameHeader	NScumm.Scumm.IO.SaveGameHeader
MarkRectAsDirty	void
MarkRectAsDirty	void
MoveScreen	void
NewLine	bool
OBJECT_V0_TYPE	ObjectV0Type
ParseEvents	void
ResetActorBgs	void
ResetCursors	void
ResetRoomObjects	void
ResetRoomSubBlocks	void
ResetScriptPointer	void
ResetV1ActorTalkColor	void
RestoreCharsetBg	void
RestoreVerbBG	void
RunAllScripts	void
RunEntryScript	void
RunExitScript	void
RunScriptNested	void
SaveHeader	void
SaveInfos	void
SaveLoad	void
SaveOrLoadResources	void
ScrollEffect	void
SetCameraFollows	void
ShowActors	void
SkipThumbnail	bool
StartScene	void
StopTalk	void
ToMd5Bytes	byte[]
TownsRestoreCharsetBg	void
UnkScreenEffect6	void
UpdateScriptData	void
VirtScreenContains	bool
WaitForTimer	void
WalkActors	void

Public Methods

Method	Description
Create ( GameSettings settings, IGraphicsManager gfxManager, IInputManager inputManager, IAudioOutput output, bool debugMode = false ) : ScummEngine
GetBoxScale ( byte boxNum ) : int
GetKeyState ( int key ) : bool
GetScale ( int boxNum, int x, int y ) : int
GetScaleFromSlot ( int slot, int x, int y ) : int
IsResourceInUse ( ResType type, int idx ) : bool
Load ( string savegame ) : void
Run ( ) : void
RunBootScript ( int bootParam ) : System.TimeSpan
RunScript ( int scriptNum, bool freezeResistant, bool recursive, int data ) : void
Save ( string filename ) : void
SetVarRange ( ) : void
StopScript ( int script ) : void
TranslateText ( byte src ) : byte[]
UpdateVariables ( ) : void

Protected Methods

Method	Description
AbortCutscene ( ) : void
ActorTalk ( byte msg ) : void
ActorToObj ( int actor ) : int
AddObjectToDrawQue ( byte obj ) : void
AddObjectToInventory ( int obj, byte room ) : void
AreBoxesNeighbors ( byte box1nr, byte box2nr ) : bool	Check if two boxes are neighbors.
BeginCutscene ( int args ) : void
BeginOverrideCore ( ) : void
BreakHereCore ( ) : void
CalcItineraryMatrix ( int num ) : ].byte[
CameraMoved ( ) : void
Charset ( ) : void
CheckAndRunSentenceScript ( ) : void
CheckExecVerbs ( ) : void
ClearClickedStatus ( ) : void
ClearDrawObjectQueue ( ) : void
ClearFlashlight ( ) : void
ClearOwnerOf ( int obj ) : void
ClearTextSurface ( ) : void
ConvertMessageToString ( byte src, byte dst, int dstPos ) : int
CyclePalette ( ) : void
DarkenPalette ( int redScale, int greenScale, int blueScale, int startColor, int endColor ) : void
DebugMessage ( byte msg ) : void
DissolveEffect ( int width, int height ) : void	Update width*height areas of the screen, in random order, until the whole screen has been updated. For instance: dissolveEffect(1, 1) produces a pixel-by-pixel dissolve dissolveEffect(8, 8) produces a square-by-square dissolve dissolveEffect(virtsrc[0].width, 1) produces a line-by-line dissolve
DoSentence ( byte verb, ushort objectA, ushort objectB ) : void
DrawBoxCore ( int x, int y, int x2, int y2, int color ) : void
DrawDirtyScreenParts ( ) : void
DrawFlashlight ( ) : void
DrawObject ( int obj, int arg ) : void
DrawObjectCore ( int &xpos, int &ypos, int &state ) : void
DrawRoomObject ( int i, int argument ) : void
DrawRoomObjects ( int argument ) : void
DrawString ( int a, byte msg ) : void
DrawStripToScreen ( VirtScreen vs, int x, int width, int top, int bottom ) : void	Blit the specified rectangle from the given virtual screen to the display. Note: t and b are in *virtual screen* coordinates, while x is relative to the *real screen*. This is due to the way tdirty/vdirty work: they are arrays which map 'strips' (sections of the real screen) to dirty areas as specified by top/bottom coordinate in the virtual screen.
DrawVerb ( int verb, int mode ) : void
DrawVerbBitmap ( int verb, int x, int y ) : void
EndCutsceneCore ( ) : void
EndOverrideCore ( ) : void
ExecuteOpCode ( byte opCode ) : void
FadeIn ( byte effect ) : void
FadeOut ( int effect ) : void
FetchScriptWord ( ) : uint
FindInventoryCore ( int owner, int idx ) : int
FindObjectCore ( int x, int y ) : int
FindVerbAtPos ( System.Point p ) : int
FreezeScripts ( int flag ) : void
GetActorFromPos ( System.Point p ) : int
GetBoxBase ( int boxnum ) : Box
GetInventoryCountCore ( int owner ) : int
GetIqFilename ( string filename ) : string
GetObjActToObjActDist ( int a, int b ) : int
GetObjX ( int obj ) : int
GetObjY ( int obj ) : int
GetObjectIndex ( int obj ) : int
GetObjectOrActorName ( int num ) : byte[]
GetObjectXYPos ( int obj ) : System.Point
GetObjectXYPos ( int obj, System.Point &p, int &dir ) : void
GetOwnerCore ( int obj ) : int
GetResult ( ) : void
GetSavegameName ( int slot, string &desc ) : bool
GetStateCore ( int obj ) : byte
GetStringAt ( int index ) : byte[]
GetVar ( ) : int
GetVarOrDirectByte ( OpCodeParameter param ) : int
GetVarOrDirectWord ( OpCodeParameter param ) : int
GetVerbEntrypointCore ( int obj, int entry ) : int
GetVerbSlot ( int id, int mode ) : int
GetWhereIsObject ( int obj ) : WhereIsObject
GetWordVarArgs ( ) : int[]
HandleDrawing ( ) : void
HandleMouseOver ( bool updateInventory ) : void
HandleShaking ( ) : void
HandleSound ( ) : void
InitCharset ( int charsetNum ) : void
InitOpCodes ( ) : void
InitPalettes ( ) : void
InitScreens ( int b, int h ) : void
IsActor ( int id ) : bool
IsScriptInUse ( int script ) : bool
IsScriptRunningCore ( int script ) : bool
IsValidActor ( int id ) : bool
JumpRelative ( bool condition ) : void
KillScriptsAndResources ( ) : void
KillVerb ( int slot ) : void
ListSavegames ( int num ) : bool[]
LoadCharset ( int no ) : void
LoadState ( int slot, bool compat ) : bool
LoadState ( string path ) : bool
Loop ( ) : System.TimeSpan
MakeSavegameName ( int slot, bool temporary ) : string
MarkObjectRectAsDirty ( int obj ) : void
MoveCamera ( ) : void
MoveMemInPalRes ( int start, int end, bool direction ) : void
ObjToActor ( int id ) : int
PalManipulate ( ) : void
PalManipulateInit ( int resID, int start, int end, int time ) : void
PanCameraToCore ( System.Point pos ) : void
PlayActorSounds ( ) : void
PrintString ( int textSlot, byte msg ) : void
ProcessActors ( ) : void
ProcessDrawQueue ( ) : void
ProcessInput ( ) : void
PutClass ( int obj, int cls, bool set ) : void
PutOwner ( int obj, byte owner ) : void
PutState ( int obj, int state ) : void
ReadByte ( ) : byte
ReadCharacters ( ) : byte[]
ReadVariable ( uint var ) : int
ReadWord ( ) : uint
ReadWordSigned ( ) : int
RedefineBuiltinCursorFromChar ( int index, int chr ) : void
RedefineBuiltinCursorHotspot ( int index, int x, int y ) : void
RedrawBGAreas ( ) : void	Redraw background as needed, i.e. the left/right sides if scrolling took place etc. Note that this only updated the virtual screen, not the actual display.
RedrawBGStrip ( int start, int num ) : void
RedrawVerbs ( ) : void
ResetScummVars ( ) : void
RestoreBackground ( Rect rect, byte backColor ) : void
RunCurrentScript ( ) : void
RunInputScript ( ClickArea clickArea, KeyCode code, int mode ) : void
RunInventoryScript ( int i ) : void
RunObjectScript ( int obj, byte entry, bool freezeResistant, bool recursive, int vars, int slot = -1 ) : void
SaveOrLoad ( Serializer serializer ) : void
SavePreparedSavegame ( int slot, string desc ) : bool
SaveState ( string path, string name ) : void
ScummEngine ( GameSettings settings, IGraphicsManager gfxManager, IInputManager inputManager, IMixer mixer ) : System
SetActorRedrawFlags ( ) : void
SetBoxFlags ( int box, int val ) : void
SetBuiltinCursor ( int idx ) : void
SetCameraAt ( System.Point pos ) : void
SetCurrentPalette ( Palette palette ) : void
SetCurrentPalette ( int palIndex ) : void
SetDefaultCursor ( ) : void
SetDirtyColors ( int min, int max ) : void
SetObjectNameCore ( int obj ) : void
SetOwnerOf ( int obj, int owner ) : void
SetPalColor ( int index, int r, int g, int b ) : void
SetPalette ( Palette palette ) : void
SetResult ( int value ) : void
SetScaleSlot ( int slot, int x1, int y1, int scale1, int x2, int y2, int scale2 ) : void
SetShadowPalette ( int redScale, int greenScale, int blueScale, int startColor, int endColor, int start, int end ) : void
SetShake ( bool enabled ) : void
SetVerbObject ( byte room, int obj, int verb ) : void
SetupMusic ( ) : void
SetupVars ( ) : void
ShowMenu ( ) : void
Step ( ) : void
StopCycle ( int i ) : void
StopObjectCode ( ) : void
StopObjectScriptCore ( ushort script ) : void
TownsDrawStripToScreen ( VirtScreen vs, int dstX, int dstY, int srcX, int srcY, int width, int height ) : void
TownsProcessPalCycleField ( ) : void
TownsResetPalCycleFields ( ) : void
TownsSetPalette ( Palette palette ) : void
TownsSetTextPalette ( Palette palette ) : void
TownsSetupPalCycleField ( int x1, int y1, int x2, int y2 ) : void
UnfreezeScripts ( ) : void
UpdateDirtyScreen ( VirtScreen vs ) : void
UpdateObjectStates ( ) : void
UpdatePalette ( ) : void
UpdateTalkDelay ( int delta ) : void
VerbMouseOver ( int verb ) : void
WriteVariable ( uint index, int value ) : void

Private Methods

Method	Description
AnimateCursor ( ) : void
CheckThumbnailHeader ( BinaryReader reader ) : bool
CheckXYInBoxBounds ( int boxnum, System.Point p ) : bool
ClearRoomObjects ( ) : void
ConvertIntMessage ( Array dst, int dstPos, uint var ) : int
ConvertNameMessage ( byte dst, int dstPos, uint var ) : int
ConvertStringMessage ( byte dst, int dstPos, uint var ) : int
ConvertVerbMessage ( byte dst, int dstPos, uint var ) : int
CreateCharset ( ) : void
CreateCharsetData ( ) : byte[][]
DecreaseScriptDelay ( int amount ) : void
DoCycleIndirectPalette ( byte palette, byte cycleStart, byte cycleEnd, bool forward, int palIndex ) : void
DoCyclePalette ( Palette palette, int cycleStart, int cycleEnd, bool forward ) : void	Cycle the colors in the given palette in the interval [cycleStart, cycleEnd] either one step forward or backward.
DoCyclePalette ( byte palette, byte cycleStart, byte cycleEnd, bool forward ) : void
DoTransitionEffect ( int a ) : void	Perform a transition effect. There are four different effects possible: 0: Iris effect 1: Box wipe (a black box expands from the upper-left corner to the lower-right corner) 2: Box wipe (a black box expands from the lower-right corner to the upper-left corner) 3: Inverse box wipe All effects operate on 8x8 blocks of the screen. These blocks are updated in a certain order; the exact order determines how the effect appears to the user.
EncodeName ( byte name ) : byte[]
FindVirtScreen ( int y ) : VirtScreen
GetBoxCoordinates ( int boxnum ) : BoxCoords
GetBoxFlags ( byte boxNum ) : BoxFlags
GetBoxMask ( byte boxNum ) : int
GetClass ( int obj, ObjectClass cls ) : bool
GetCurrentLights ( ) : LightModes
GetInventorySlot ( ) : int
GetMaskBuffer ( int x, int y, int z ) : PixelNavigator
GetNextBox ( byte from, byte to ) : int	Compute if there is a way that connects box 'from' with box 'to'.
GetNumBoxes ( ) : int
GetNumZBuffers ( ) : int
GetObjectOrActorXY ( int obj, System.Point &p ) : bool
GetOrderedActors ( ) : IEnumerable
GetSavegameName ( System.Stream stream, string &desc ) : bool
GetScriptSlotIndex ( ) : byte
GetTimeToWaitBeforeLoop ( System.TimeSpan lastTimeLoop ) : System.TimeSpan
HandleActors ( ) : void
HandleEffects ( ) : void
HandleNextCharsetCode ( Actor a, int &code ) : bool
InitActors ( ) : void
InitSentences ( ) : NScumm.Scumm.Sentence[]
InitializeVerbs ( ) : void
IsCostumeInUse ( int cost ) : bool
IsLightOn ( ) : bool
LoadHeader ( BinaryReader reader ) : ThumbnailHeader
LoadInfos ( BinaryReader reader ) : SaveStateMetaInfos
LoadResource ( BinaryReader reader, ResType type, ushort idx ) : void
LoadSaveGameHeader ( BinaryReader reader ) : SaveGameHeader
MarkRectAsDirty ( VirtScreen vs, Rect r, int dirtybit ) : void
MarkRectAsDirty ( VirtScreen vs, int left, int right, int top, int bottom, int dirtybit ) : void
MoveScreen ( int dx, int dy, int height ) : void	Moves the screen content by the offset specified via dx/dy. Only the region from x=0 till x=height-1 is affected.
NewLine ( ) : bool
OBJECT_V0_TYPE ( int obj ) : ObjectV0Type
ParseEvents ( ) : void
ResetActorBgs ( ) : void
ResetCursors ( ) : void
ResetRoomObjects ( ) : void
ResetRoomSubBlocks ( ) : void
ResetScriptPointer ( ) : void
ResetV1ActorTalkColor ( ) : void
RestoreCharsetBg ( ) : void
RestoreVerbBG ( int verb ) : void
RunAllScripts ( ) : void
RunEntryScript ( ) : void
RunExitScript ( ) : void
RunScriptNested ( int script ) : void
SaveHeader ( string name, BinaryWriter bw ) : void
SaveInfos ( BinaryWriter writer ) : void
SaveLoad ( ) : void
SaveOrLoadResources ( Serializer serializer ) : void
ScrollEffect ( int dir ) : void
SetCameraFollows ( Actor actor, bool setCamera = false ) : void
ShowActors ( ) : void
SkipThumbnail ( BinaryReader reader ) : bool
StartScene ( byte room, Actor a = null, int objectNr ) : void
StopTalk ( ) : void
ToMd5Bytes ( string md5 ) : byte[]
TownsRestoreCharsetBg ( ) : void
UnkScreenEffect6 ( ) : void
UpdateScriptData ( ushort slotIndex ) : void
VirtScreenContains ( VirtScreen vs, int y ) : bool
WaitForTimer ( int msec_delay ) : void
WalkActors ( ) : void

Method Details

Property Details