ScummVM API documentation
Nancy::Action::TextScroll Class Reference
Inheritance diagram for Nancy::Action::TextScroll:
Nancy::Action::Autotext Nancy::Action::PeepholePuzzle Nancy::Action::ActionRecord Nancy::Misc::HypertextParser Nancy::Action::PuzzleRecord Nancy::Action::RenderActionRecord Nancy::Action::ActionRecord Nancy::RenderObject

Public Types

enum  ScrollType { kTextScroll, kAutotextEntryList }
 
- Public Types inherited from Nancy::Action::ActionRecord
enum  ExecutionState { kBegin, kRun, kActionTrigger }
 
enum  ExecutionType { kOneShot = 1, kRepeating = 2 }
 

Public Member Functions

 TextScroll (ScrollType scrollType)
 
void init () override
 
void execute () override
 
void handleInput (NancyInput &input) override
 
void readData (Common::SeekableReadStream &stream) override
 
- Public Member Functions inherited from Nancy::Action::ActionRecord
virtual CursorManager::CursorType getHoverCursor () const
 
virtual bool cursorSetFromScript () const
 
virtual bool canHaveHotspot () const
 
virtual bool survivesSceneChange (bool nextSceneIsNoArt) const
 
- Public Member Functions inherited from Nancy::Misc::HypertextParser
bool hasBeenDrawn () const
 
- Public Member Functions inherited from Nancy::Action::PeepholePuzzle
bool isViewportRelative () const override
 
- Public Member Functions inherited from Nancy::Action::PuzzleRecord
 PuzzleRecord (uint zOrder)
 
Common::String getRecordExtraInfo () const override
 
- Public Member Functions inherited from Nancy::Action::RenderActionRecord
 RenderActionRecord (uint zOrder)
 
 RenderActionRecord (RenderActionRecord &&)=default
 
void onPause (bool pause) override
 
- Public Member Functions inherited from Nancy::RenderObject
 RenderObject (uint16 zOrder)
 
 RenderObject (uint16 zOrder, Graphics::ManagedSurface &surface, const Common::Rect &srcBounds, const Common::Rect &destBounds)
 
 RenderObject (RenderObject &&)=default
 
virtual void registerGraphics ()
 
virtual void updateGraphics ()
 
void moveTo (const Common::Point &position)
 
void moveTo (const Common::Rect &bounds)
 
void setVisible (bool visible)
 
void setTransparent (bool isTransparent)
 
bool isVisible () const
 
bool needsRedraw () const
 
void setNeedsRedraw (bool needsRedraw)
 
void setHasMoved (bool hasMoved)
 
bool isNativeResolution () const
 
void setNativeResolution (bool isNative)
 
void grabPalette (byte *colors, uint paletteStart=0, uint paletteSize=256)
 
void setPalette (const Common::Path &paletteName, uint paletteStart=0, uint paletteSize=256)
 
void setPalette (const byte *colors, uint paletteStart=0, uint paletteSize=256)
 
bool hasMoved () const
 
void updatePreviousScreenPosition ()
 
Common::Rect getScreenPosition () const
 
Common::Rect getScreenPositionRaw () const
 
Common::Rect getPreviousScreenPosition () const
 
Common::Rect convertToLocal (const Common::Rect &screen) const
 
Common::Rect convertToScreen (const Common::Rect &rect) const
 
Common::Rect getBounds () const
 
uint16 getZOrder () const
 
void setZOrder (uint16 z)
 

Protected Member Functions

Common::String getRecordTypeName () const override
 
void readExtraData (Common::SeekableReadStream &stream) override
 
- Protected Member Functions inherited from Nancy::Action::ActionRecord
void finishExecution ()
 
- Protected Member Functions inherited from Nancy::Misc::HypertextParser
void initSurfaces (uint width, uint height, const struct Graphics::PixelFormat &format, uint32 backgroundColor, uint32 highlightBackgroundColor)
 
void addTextLine (const Common::String &text)
 
void addImage (uint16 lineID, const Common::Rect &src)
 
void setImageName (const Common::Path &name)
 
void drawAllText (const Common::Rect &textBounds, uint leftOffsetNonNewline, uint fontID, uint highlightFontID)
 
virtual void clear ()
 
void drawInlineImage (const InlineImage &inlineImage, const Common::Rect &textBounds, uint horizontalOffset, uint justification, const Font *font)
 
void setDefaultTextRGB (byte r, byte g, byte b)
 
- Protected Member Functions inherited from Nancy::Action::PeepholePuzzle
void drawInner ()
 
void checkButtons ()
 
- Protected Member Functions inherited from Nancy::Action::PuzzleRecord
void loadImage ()
 
void initViewportSurface ()
 
void setDataCursor (uint16 cursorType, bool hotspotVariant=true) const
 
Common::Point getHeldPiecePos (const Common::Point &mousePos, const Common::Rect &src, const Common::Point &offset) const
 
SoundDescription playSoundBlock (const RandomSoundBlock &block)
 
bool isSoundBlockPlaying (const RandomSoundBlock &block) const
 
void readExitHotspot (Common::SeekableReadStream &stream)
 
bool isExitHotspotHovered (const NancyInput &input) const
 
void setExitCursor () const
 
bool hoverExitHotspot (const NancyInput &input) const
 
bool hasSolveSound () const
 
void playSolveSound ()
 
bool isSolveSoundPlaying () const
 

Protected Attributes

ScrollType _scrollType
 
- Protected Attributes inherited from Nancy::Action::Autotext
uint16 _transparency = kPlayOverlayPlain
 
uint16 _surfaceID = 0
 
uint16 _fontID = 0
 
uint16 _textColor = 0
 
Common::Point _offset
 
uint16 _surfWidth = 0
 
uint16 _surfHeight = 0
 
bool _useAutotextChunk = false
 
Common::String _textKey
 
Common::String _embeddedText
 
uint16 _order = kListFIFO
 
bool _shouldDrawMarks = false
 
Common::Array< uint16 > _hotspotScenes
 
bool _hasPlacementDescriptor = true
 
uint16 _placementMode = 0
 
Common::Rect _viewportDest
 
Common::Rect _viewportSrc
 
bool _selfDisplay = true
 
AutotextRender * _viewportRender = nullptr
 
Graphics::ManagedSurface _image
 
- Protected Attributes inherited from Nancy::Misc::HypertextParser
Graphics::ManagedSurface _fullSurface
 
Graphics::ManagedSurface _textHighlightSurface
 
uint32 _backgroundColor
 
uint32 _highlightBackgroundColor
 
uint _defaultTextColor
 
uint _defaultJustification = kJustifyLeft
 
FontColorState _fontColorState = kFontColorNormal
 
int _imageVerticalOffset
 
Common::Array< Common::String > _textLines
 
Common::Array< Common::Rect > _hotspots
 
bool _recordMarkHotspots = false
 
Common::Array< Common::Rect > _markHotspots
 
Common::Path _imageName
 
Common::Array< uint16 > _imageLineIDs
 
Common::Array< Common::Rect > _imageSrcs
 
uint16 _numDrawnLines
 
uint16 _drawnTextHeight
 
bool _needsTextRedraw
 
- Protected Attributes inherited from Nancy::Action::PeepholePuzzle
Common::Path _innerImageName
 
Common::Path _buttonsImageName
 
uint16 _transparency = 0
 
Common::Rect _innerBounds
 
Common::Rect _startSrc
 
Common::Rect _dest
 
Common::Array< Common::Rect > _buttonDests
 
Common::Array< Common::Rect > _buttonSrcs
 
Common::Array< Common::Rect > _buttonDisabledSrcs
 
byte _pixelsToScroll = 0
 
Graphics::ManagedSurface _innerImage
 
Graphics::ManagedSurface _buttonsImage
 
Common::Rect _currentSrc
 
int _pressedButton = -1
 
uint32 _pressStart = 0
 
Common::Array< bool > _disabledButtons = Common::Array<bool>(4, false)
 
- Protected Attributes inherited from Nancy::Action::PuzzleRecord
Common::Path _imageName
 
Graphics::ManagedSurface _image
 
SceneChangeWithFlag _solveScene
 
SoundDescription _solveSound
 
uint16 _solveSoundDelay = 0
 
SceneChangeWithFlag _exitScene
 
Common::Rect _exitHotspot
 
uint16 _exitCursorType = 0
 
bool _exitCursorFromData = false
 
- Protected Attributes inherited from Nancy::RenderObject
bool _needsRedraw
 
bool _isVisible
 
bool _hasMoved
 
bool _isNativeResolution = false
 
uint16 _z
 
Common::Rect _previousScreenPosition
 
Common::Rect _screenPosition
 

Additional Inherited Members

- Public Attributes inherited from Nancy::Action::ActionRecord
Common::String _description
 
Common::String _includeSource
 
byte _type
 
ExecutionType _execType
 
DependencyRecord _dependencies
 
bool _isActive
 
bool _isDone
 
bool _hasHotspot
 
Common::Rect _hotspot
 
ExecutionState _state
 
DependencyRecord * _cursorDependency
 
- Public Attributes inherited from Nancy::RenderObject
Graphics::ManagedSurface _drawSurface
 
- Protected Types inherited from Nancy::Misc::HypertextParser
enum  Justification { kJustifyLeft, kJustifyRight, kJustifyCenter }
 

The documentation for this class was generated from the following file: