ScummVM API documentation
MTropolis::Modifier Class Referenceabstract
Inheritance diagram for MTropolis::Modifier:
MTropolis::RuntimeObject MTropolis::IMessageConsumer MTropolis::Debuggable MTropolis::IInterfaceBase MTropolis::IDebuggable MTropolis::IInterfaceBase MTropolis::AXLogic::AlienWriterModifier MTropolis::AliasModifier MTropolis::BehaviorModifier MTropolis::BoundaryDetectionMessengerModifier MTropolis::ChangeSceneModifier MTropolis::CollisionDetectionMessengerModifier MTropolis::ColorTableModifier MTropolis::CompoundVariableModifier MTropolis::CursorModifierV1 MTropolis::DragMotionModifier MTropolis::ElementTransitionModifier MTropolis::FTTS::MotionModifier MTropolis::FTTS::SparkleModifier MTropolis::GraphicModifier MTropolis::Hoologic::BitmapVariableModifier MTropolis::Hoologic::CaptureBitmapModifier MTropolis::Hoologic::DisplayBitmapModifier MTropolis::Hoologic::ImportBitmapModifier MTropolis::Hoologic::KeyStateModifier MTropolis::Hoologic::PainterModifier MTropolis::Hoologic::PrintBitmapModifier MTropolis::Hoologic::SaveBitmapModifier MTropolis::Hoologic::ScaleBitmapModifier MTropolis::IfMessengerModifier MTropolis::ImageEffectModifier MTropolis::KW::StrUtilModifier MTropolis::KeyboardMessengerModifier MTropolis::MLine::MLineLauncherModifier MTropolis::MTI::SampleModifier MTropolis::MTI::ShanghaiModifier MTropolis::MessengerModifier MTropolis::Midi::MidiModifier MTropolis::MiniscriptModifier MTropolis::Obsidian::DictionaryModifier MTropolis::Obsidian::MovementModifier MTropolis::Obsidian::RectShiftModifier MTropolis::Obsidian::TextWorkModifier MTropolis::Obsidian::WordMixerModifier MTropolis::Obsidian::XorCheckModifier MTropolis::Obsidian::XorModModifier MTropolis::PathMotionModifier MTropolis::Pierian::FlattenModifier MTropolis::Pierian::SaveFileModifier MTropolis::Pierian::WasteModifier MTropolis::RWC::ThighBlasterModifier MTropolis::ReturnModifier MTropolis::SaveAndRestoreModifier MTropolis::SceneTransitionModifier MTropolis::SetModifier MTropolis::SharedSceneModifier MTropolis::SimpleMotionModifier MTropolis::SoundEffectModifier MTropolis::SoundFadeModifier MTropolis::Standard::CursorModifier MTropolis::Standard::FadeModifier MTropolis::Standard::MediaCueMessengerModifier MTropolis::Standard::NavigateModifier MTropolis::Standard::OpenAppModifier MTropolis::Standard::OpenTitleModifier MTropolis::Standard::PanningModifier MTropolis::Standard::PrintModifier MTropolis::Standard::STransCtModifier MTropolis::Standard::SysInfoModifier MTropolis::TextStyleModifier MTropolis::Thereware::AlphaMaticModifier MTropolis::Thereware::ConductorModifier MTropolis::Thereware::DoubleClickModifier MTropolis::Thereware::EasyScrollerModifier MTropolis::Thereware::GoThereModifier MTropolis::Thereware::HotTextModifier MTropolis::Thereware::KeyScrollModifier MTropolis::Thereware::MouseTrapModifier MTropolis::Thereware::RandomizerModifier MTropolis::Thereware::RotatorModifier MTropolis::Thereware::TimeLoopModifier MTropolis::Thereware::TrackerModifier MTropolis::Thereware::WrapAroundModifier MTropolis::TimerMessengerModifier MTropolis::VariableModifier MTropolis::VectorMotionModifier

Public Member Functions

bool readAttribute (MiniscriptThread *thread, DynamicValue &result, const Common::String &attrib) override
 
MiniscriptInstructionOutcome writeRefAttribute (MiniscriptThread *thread, DynamicValueWriteProxy &writeProxy, const Common::String &attrib) override
 
void materialize (Runtime *runtime, ObjectLinkingScope *outerScope)
 
virtual bool isAlias () const
 
virtual bool isVariable () const
 
virtual bool isBehavior () const
 
virtual bool isCompoundVariable () const
 
virtual bool isKeyboardMessenger () const
 
virtual Common::SharedPtr< ModifierSaveLoad > getSaveLoad (Runtime *runtime)
 
bool isModifier () const override
 
virtual IModifierContainer * getMessagePropagationContainer ()
 
virtual IModifierContainer * getChildContainer ()
 
const Common::WeakPtr< RuntimeObject > & getParent () const
 
void setParent (const Common::WeakPtr< RuntimeObject > &parent)
 
Modifier * findNextSibling () const
 
Modifier * findPrevSibling () const
 
bool respondsToEvent (const Event &evt) const override
 
VThreadState consumeMessage (Runtime *runtime, const Common::SharedPtr< MessageProperties > &msg) override
 
void setName (const Common::String &name)
 
const Common::String & getName () const
 
const ModifierFlags & getModifierFlags () const
 
virtual Common::SharedPtr< Modifier > shallowClone () const =0
 
virtual const char * getDefaultName () const =0
 
virtual void visitInternalReferences (IStructuralReferenceVisitor *visitor)
 
bool loadPlugInHeader (const PlugInModifierLoaderContext &plugInContext)
 
void recursiveCollectObjectsMatchingCriteria (Common::Array< Common::WeakPtr< RuntimeObject > > &results, bool(*evalFunc)(void *userData, RuntimeObject *object), void *userData, bool onlyEnabled)
 
Structural * findStructuralOwner () const
 
void setHooks (const Common::SharedPtr< ModifierHooks > &hooks)
 
const Common::SharedPtr< ModifierHooks > & getHooks () const
 
virtual void disable (Runtime *runtime)=0
 
- Public Member Functions inherited from MTropolis::RuntimeObject
uint32 getStaticGUID () const
 
uint32 getRuntimeGUID () const
 
void setRuntimeGUID (uint32 runtimeGUID)
 
void setSelfReference (const Common::WeakPtr< RuntimeObject > &selfReference)
 
const Common::WeakPtr< RuntimeObject > & getSelfReference () const
 
virtual bool isStructural () const
 
virtual bool isProject () const
 
virtual bool isSection () const
 
virtual bool isSubsection () const
 
virtual bool isModifier () const
 
virtual bool isElement () const
 
virtual bool readAttribute (MiniscriptThread *thread, DynamicValue &result, const Common::String &attrib)
 
virtual bool readAttributeIndexed (MiniscriptThread *thread, DynamicValue &result, const Common::String &attrib, const DynamicValue &index)
 
virtual MiniscriptInstructionOutcome writeRefAttribute (MiniscriptThread *thread, DynamicValueWriteProxy &result, const Common::String &attrib)
 
virtual MiniscriptInstructionOutcome writeRefAttributeIndexed (MiniscriptThread *thread, DynamicValueWriteProxy &result, const Common::String &attrib, const DynamicValue &index)
 
virtual bool respondsToEvent (const Event &evt) const =0
 
virtual VThreadState consumeMessage (Runtime *runtime, const Common::SharedPtr< MessageProperties > &msg)=0
 
- Public Member Functions inherited from MTropolis::Debuggable
 Debuggable (const Debuggable &other)
 
 Debuggable (Debuggable &&other)
 
- Public Member Functions inherited from MTropolis::IDebuggable
virtual SupportStatus debugGetSupportStatus () const =0
 
virtual const char * debugGetTypeName () const =0
 
virtual const Common::String & debugGetName () const =0
 
virtual const Common::SharedPtr< DebugInspector > & debugGetInspector ()=0
 
virtual void debugInspect (IDebugInspectionReport *report) const =0
 

Protected Member Functions

bool loadTypicalHeader (const Data::TypicalModifierHeader &typicalHeader)
 
virtual void linkInternalReferences (ObjectLinkingScope *scope)
 
- Protected Member Functions inherited from MTropolis::RuntimeObject
MiniscriptInstructionOutcome scriptSetClone (MiniscriptThread *thread, const DynamicValue &value)
 
MiniscriptInstructionOutcome scriptSetKill (MiniscriptThread *thread, const DynamicValue &value)
 
MiniscriptInstructionOutcome scriptSetParent (MiniscriptThread *thread, const DynamicValue &value)
 

Protected Attributes

Common::String _name
 
ModifierFlags _modifierFlags
 
Common::WeakPtr< RuntimeObject > _parent
 
Common::SharedPtr< ModifierHooks > _hooks
 
- Protected Attributes inherited from MTropolis::RuntimeObject
uint32 _guid
 
uint32 _runtimeGUID
 
Common::WeakPtr< RuntimeObject > _selfReference
 

Member Function Documentation

◆ readAttribute()

bool MTropolis::Modifier::readAttribute ( MiniscriptThread *  thread,
DynamicValue &  result,
const Common::String &  attrib 
)
overridevirtual

Reimplemented from MTropolis::RuntimeObject.

◆ writeRefAttribute()

MiniscriptInstructionOutcome MTropolis::Modifier::writeRefAttribute ( MiniscriptThread *  thread,
DynamicValueWriteProxy &  writeProxy,
const Common::String &  attrib 
)
overridevirtual

Reimplemented from MTropolis::RuntimeObject.

◆ isModifier()

bool MTropolis::Modifier::isModifier ( ) const
overridevirtual

Reimplemented from MTropolis::RuntimeObject.

◆ respondsToEvent()

bool MTropolis::Modifier::respondsToEvent ( const Event &  evt) const
overridevirtual

◆ consumeMessage()

VThreadState MTropolis::Modifier::consumeMessage ( Runtime *  runtime,
const Common::SharedPtr< MessageProperties > &  msg 
)
overridevirtual

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