ScummVM API documentation
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Nancy::Action::AutotextScroll Class Reference
Inheritance diagram for Nancy::Action::AutotextScroll:
Nancy::Action::RenderActionRecord Nancy::Action::ActionRecord Nancy::RenderObject

Classes

struct  ScrollingText
 

Public Member Functions

 AutotextScroll (bool hasDrawingOrder=false)
 
void init () override
 
void updateGraphics () override
 
void readData (Common::SeekableReadStream &stream) override
 
void execute () override
 
bool isViewportRelative () 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::Action::ActionRecord
virtual void readData (Common::SeekableReadStream &stream)=0
 
virtual void execute ()
 
virtual void onPause (bool pause)
 
virtual CursorManager::CursorType getHoverCursor () const
 
virtual bool cursorSetFromScript () const
 
virtual void handleInput (NancyInput &input)
 
virtual Common::String getRecordTypeName () const =0
 
virtual Common::String getRecordExtraInfo () const
 
virtual bool canHaveHotspot () const
 
virtual bool survivesSceneChange (bool nextSceneIsNoArt) const
 
- 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 init ()
 
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
 
const Common::Rect & getDrawnScreenPosition () const
 
void setDrawnScreenPosition (const Common::Rect &position)
 
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)
 
virtual bool isViewportRelative () const
 
const ViewTransform * getViewTransform () const
 
void setViewTransform (const ViewTransform *viewTransform)
 
bool isZoomed () const
 

Protected Member Functions

Common::String getRecordTypeName () const override
 
void startText (const Common::String &key)
 
bool scrollText (ScrollingText &text, int32 ticks)
 
void update (int32 ticks)
 
void redraw ()
 
- Protected Member Functions inherited from Nancy::Action::ActionRecord
void finishExecution ()
 

Protected Attributes

bool _hasDrawingOrder
 
int32 _startDepth = 0
 
Common::Rect _bounds
 
int32 _intervalTicks = 0
 
float _speed = 0
 
uint32 _fontID = 0
 
uint32 _colorID = 0
 
Common::Array< Common::String > _keys
 
FlagDescription _doneFlag
 
uint _nextKey = 0
 
int32 _intervalCounter = 0
 
Common::Array< ScrollingText * > _texts
 
uint32 _lastTickTime = 0
 
- Protected Attributes inherited from Nancy::RenderObject
bool _needsRedraw
 
bool _isVisible
 
bool _hasMoved
 
bool _isNativeResolution = false
 
uint16 _z
 
Common::Rect _drawnScreenPosition
 
Common::Rect _previousScreenPosition
 
Common::Rect _screenPosition
 
const ViewTransform * _viewTransform = nullptr
 

Additional Inherited Members

- Public Types inherited from Nancy::Action::ActionRecord
enum  ExecutionState { kBegin , kRun , kActionTrigger }
 
enum  ExecutionType { kOneShot = 1 , kRepeating = 2 }
 
- 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
 

Member Function Documentation

◆ init()

void Nancy::Action::AutotextScroll::init ( )
overridevirtual

Reimplemented from Nancy::RenderObject.

◆ updateGraphics()

void Nancy::Action::AutotextScroll::updateGraphics ( )
overridevirtual

Reimplemented from Nancy::RenderObject.

◆ readData()

void Nancy::Action::AutotextScroll::readData ( Common::SeekableReadStream &  stream)
overridevirtual

Implements Nancy::Action::ActionRecord.

◆ execute()

void Nancy::Action::AutotextScroll::execute ( )
overridevirtual

Reimplemented from Nancy::Action::ActionRecord.

◆ isViewportRelative()

bool Nancy::Action::AutotextScroll::isViewportRelative ( ) const
inlineoverridevirtual

Reimplemented from Nancy::RenderObject.

◆ getRecordTypeName()

Common::String Nancy::Action::AutotextScroll::getRecordTypeName ( ) const
inlineoverrideprotectedvirtual

Implements Nancy::Action::ActionRecord.

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