Conversation action changing game music. More...
Classes | |
| class | Factory |
| Factory for loading actor actions. More... | |
Public Member Functions | |
| void | execute (ConversationPlayback playback) |
| Execute action. More... | |
| String | getName () |
| Name of music to change. More... | |
| CActionMusic | new () |
| Create a new conversation action. More... | |
| CActionMusic | new (PersistencyEnvironment env, FileReader reader) |
| Read from file. More... | |
| String | persistencyFactoryName () |
| Name of PersistencyFactory required to load object from file. More... | |
| void | setName (String name) |
| Set name of music to change. More... | |
| void | writeObjectToFile (PersistencyEnvironment env, FileWriter writer) |
| Write object to file writer. More... | |
 Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction | |
| float | getDelay () |
| Delay in seconds before processing this action. More... | |
| bool | getWaitForActor () |
| Wait for actor. More... | |
| String | getWaitForActorID () |
| ID of actor to wait for or null to wait for all actors. More... | |
| void | setDelay (float delay) |
| Set delay in seconds before processing this action. More... | |
| void | setWaitForActor (bool wait) |
| Set wait for actor. More... | |
| void | setWaitForActorID (String id) |
| Set ID of actor to wait for or null to wait for all actors. More... | |
Public Attributes | |
| String | pName |
| Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction | |
| float | pDelay |
| Delay before processing the action. More... | |
| bool | pWaitForActor |
| Wait for actor. More... | |
| String | pWaitForActorID |
| ID of actor to wait for or null to wait for all actors. More... | |
Detailed Description
Conversation action changing game music.
Calls ConversationPlayback.changeMusic() with the user defined identifier. It is up to the game script to decide what music to pick and how to change it.
Member Function Documentation
◆ execute()
| void Dragengine.ConversationSystem.CActionMusic.execute | ( | ConversationPlayback | playback | ) |
Execute action.
Reimplemented from Dragengine.ConversationSystem.ConversationAction.
◆ getName()
| String Dragengine.ConversationSystem.CActionMusic.getName | ( | ) |
Name of music to change.
◆ new() [1/2]
| CActionMusic Dragengine.ConversationSystem.CActionMusic.new | ( | ) |
Create a new conversation action.
Reimplemented from Dragengine.ConversationSystem.ConversationAction.
◆ new() [2/2]
| CActionMusic Dragengine.ConversationSystem.CActionMusic.new | ( | PersistencyEnvironment | env, |
| FileReader | reader | ||
| ) |
Read from file.
Reimplemented from Dragengine.ConversationSystem.ConversationAction.
◆ persistencyFactoryName()
| String Dragengine.ConversationSystem.CActionMusic.persistencyFactoryName | ( | ) |
Name of PersistencyFactory required to load object from file.
Name of PersistencyFactory is first written to the file as string with 8-bit length. Then writeToFile() is called to write the object itself. Empty name is not allowed as is names longer than 255 characters. Name has to match a PersistencyFactory present in the Persistency instance used for loading objects. Object is read using PersistencyFactory.readObjectFromFile() of the matching PersistencyFactory.
Implements Dragengine.LoadSave.Persistable.
◆ setName()
| void Dragengine.ConversationSystem.CActionMusic.setName | ( | String | name | ) |
Set name of music to change.
◆ writeObjectToFile()
| void Dragengine.ConversationSystem.CActionMusic.writeObjectToFile | ( | PersistencyEnvironment | env, |
| FileWriter | writer | ||
| ) |
Write object to file writer.
Implements Dragengine.LoadSave.Persistable.
Member Data Documentation
◆ pName
| String Dragengine.ConversationSystem.CActionMusic.pName |
The documentation for this class was generated from the following file:
