ScummVM API documentation
MTropolis::SoundElement Class Reference
Inheritance diagram for MTropolis::SoundElement:
MTropolis::NonVisualElement MTropolis::IPlayMediaSignalReceiver MTropolis::Element MTropolis::IInterfaceBase MTropolis::Structural MTropolis::RuntimeObject MTropolis::IModifierContainer MTropolis::IMessageConsumer MTropolis::Debuggable MTropolis::IInterfaceBase MTropolis::IInterfaceBase MTropolis::IDebuggable MTropolis::IInterfaceBase

Public Member Functions

bool load (ElementLoaderContext &context, const Data::SoundElement &data)
 
bool readAttribute (MiniscriptThread *thread, DynamicValue &result, const Common::String &attrib) override
 
MiniscriptInstructionOutcome writeRefAttribute (MiniscriptThread *thread, DynamicValueWriteProxy &writeProxy, const Common::String &attrib) override
 
VThreadState asyncConsumeCommand (Runtime *runtime, const Common::SharedPtr< MessageProperties > &msg) override
 
void activate () override
 
void deactivate () override
 
bool canAutoPlay () const override
 
void playMedia (Runtime *runtime, Project *project) override
 
void tryAutoSetName (Runtime *runtime, Project *project) override
 
bool resolveMediaMarkerLabel (const Label &label, int32 &outResolution) const override
 
Common::SharedPtr< StructuralshallowClone () const override
 
void visitInternalReferences (IStructuralReferenceVisitor *visitor) override
 
- Public Member Functions inherited from MTropolis::NonVisualElement
bool isVisual () const override
 
bool loadCommon (const Common::String &name, uint32 guid, uint32 elementFlags)
 
- Public Member Functions inherited from MTropolis::Element
virtual void queueAutoPlayEvents (Runtime *runtime, bool isAutoPlaying)
 
bool isElement () const override
 
uint32 getStreamLocator () const
 
void addMediaCue (MediaCueState *mediaCue)
 
void removeMediaCue (const MediaCueState *mediaCue)
 
void triggerAutoPlay (Runtime *runtime)
 
void visitInternalReferences (IStructuralReferenceVisitor *visitor) override
 
- Public Member Functions inherited from MTropolis::Structural
 Structural (Runtime *runtime)
 
bool isStructural () const override
 
SceneLoadState getSceneLoadState () const
 
void setSceneLoadState (SceneLoadState sceneLoadState)
 
bool readAttribute (MiniscriptThread *thread, DynamicValue &result, const Common::String &attrib) override
 
bool readAttributeIndexed (MiniscriptThread *thread, DynamicValue &result, const Common::String &attrib, const DynamicValue &index) override
 
MiniscriptInstructionOutcome writeRefAttribute (MiniscriptThread *thread, DynamicValueWriteProxy &result, const Common::String &attrib) override
 
const Common::Array< Common::SharedPtr< Structural > > & getChildren () const
 
void addChild (const Common::SharedPtr< Structural > &child)
 
void removeAllChildren ()
 
void removeAllModifiers ()
 
void removeChild (Structural *child)
 
void removeAllAssets ()
 
void holdAssets (const Common::Array< Common::SharedPtr< Asset > > &assets)
 
StructuralgetParent () const
 
StructuralfindNextSibling () const
 
StructuralfindPrevSibling () const
 
void setParent (Structural *parent)
 
VisualElementfindScene ()
 
const Common::StringgetName () const
 
const Common::Array< Common::SharedPtr< Modifier > > & getModifiers () const override
 
void appendModifier (const Common::SharedPtr< Modifier > &modifier) override
 
void removeModifier (const Modifier *modifier) override
 
bool respondsToEvent (const Event &evt) const override
 
VThreadState consumeMessage (Runtime *runtime, const Common::SharedPtr< MessageProperties > &msg) override
 
void materializeSelfAndDescendents (Runtime *runtime, ObjectLinkingScope *outerScope)
 
void materializeDescendents (Runtime *runtime, ObjectLinkingScope *outerScope)
 
void recursiveCollectObjectsMatchingCriteria (Common::Array< Common::WeakPtr< RuntimeObject > > &results, bool(*evalFunc)(void *userData, RuntimeObject *object), void *userData, bool onlyEnabled)
 
void setHooks (const Common::SharedPtr< StructuralHooks > &hooks)
 
const Common::SharedPtr< StructuralHooks > & getHooks () const
 
- 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 isProject () const
 
virtual bool isSection () const
 
virtual bool isSubsection () const
 
virtual bool isModifier () const
 
virtual MiniscriptInstructionOutcome writeRefAttributeIndexed (MiniscriptThread *thread, DynamicValueWriteProxy &result, const Common::String &attrib, const DynamicValue &index)
 
- 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::StringdebugGetName () const =0
 
virtual void debugInspect (IDebugInspectionReport *report) const =0
 

Additional Inherited Members

- Public Types inherited from MTropolis::NonVisualElement
typedef ElementConsumeCommandCoroutine NonVisualElementConsumeCommandCoroutine
 
- Public Types inherited from MTropolis::Element
typedef StructuralConsumeCommandCoroutine ElementConsumeCommandCoroutine
 
- Public Types inherited from MTropolis::Structural
enum  SceneLoadState { kNotAScene, kSceneNotLoaded, kSceneLoaded }
 
- Protected Member Functions inherited from MTropolis::Element
 Element (const Element &other)
 
- Protected Member Functions inherited from MTropolis::Structural
 Structural (const Structural &other)
 
virtual ObjectLinkingScopegetPersistentStructuralScope ()
 
virtual ObjectLinkingScopegetPersistentModifierScope ()
 
MiniscriptInstructionOutcome scriptSetPaused (MiniscriptThread *thread, const DynamicValue &value)
 
MiniscriptInstructionOutcome scriptSetLoop (MiniscriptThread *thread, const DynamicValue &value)
 
MiniscriptInstructionOutcome scriptSetDebug (MiniscriptThread *thread, const DynamicValue &value)
 
MiniscriptInstructionOutcome scriptSetUnload (MiniscriptThread *thread, const DynamicValue &value)
 
virtual void linkInternalReferences (ObjectLinkingScope *outerScope)
 
virtual void onPauseStateChanged ()
 
RuntimegetRuntime () const
 
- 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 inherited from MTropolis::Element
uint32 _streamLocator
 
uint16 _sectionID
 
Common::Array< MediaCueState * > _mediaCues
 
bool _haveCheckedAutoPlay
 
- Protected Attributes inherited from MTropolis::Structural
Structural_parent
 
Common::Array< Common::SharedPtr< Structural > > _children
 
Common::Array< Common::SharedPtr< Modifier > > _modifiers
 
Common::String _name
 
Common::Array< Common::SharedPtr< Asset > > _assets
 
bool _paused
 
bool _loop
 
int32 _flushPriority
 
SceneLoadState _sceneLoadState
 
Common::SharedPtr< StructuralHooks_hooks
 
- Protected Attributes inherited from MTropolis::RuntimeObject
uint32 _guid
 
uint32 _runtimeGUID
 
Common::WeakPtr< RuntimeObject_selfReference
 

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