Wwise SDK 2022.1.7
_first_time_creation_message_8h_source
Version
menu_open
link
FirstTimeCreationMessage.h
Go to the documentation of this file.
28 * \brief Wwise Authoring Plug-ins - Plug-in that provides a special usage message when first instantiated.
59 * \brief Returns a unique key used in the .wproj to indicate whether the licensing message was shown.
61 * The key should be representative of the plug-in or plug-in family, as well as user readable. Even if a GUID
67 const char*(*GetKey)(const struct ak_wwise_plugin_first_time_creation_message_instance_v1* in_this);
77 const char*(*GetCreationMessage)(const struct ak_wwise_plugin_first_time_creation_message_instance_v1* in_this);
82 AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_FIRST_TIME_CREATION_MESSAGE, 1)
83 #define AK_WWISE_PLUGIN_FIRST_TIME_CREATION_MESSAGE_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
85 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_FIRST_TIME_CREATION_MESSAGE_V1_ID(), in_pluginInfo, in_data) \
112 };
122 };
132 CFirstTimeCreationMessage::GetKey = [](const struct ak_wwise_plugin_first_time_creation_message_instance_v1* in_this) { return static_cast<const Instance*>(in_this)->GetKey(); };
133 CFirstTimeCreationMessage::GetCreationMessage = [](const struct ak_wwise_plugin_first_time_creation_message_instance_v1* in_this) { return static_cast<const Instance*>(in_this)->GetCreationMessage(); };
156 * \brief Returns a unique key used in the .wproj to indicate whether the licensing message was shown.
V1::FirstTimeCreationMessage FirstTimeCreationMessage
Latest version of the C++ FirstTimeCreationMessage interface.
Definition: FirstTimeCreationMessage.h:179
const char *(* GetCreationMessage)(const struct ak_wwise_plugin_first_time_creation_message_instance_v1 *in_this)
Returns a unique creation message shown to the user.
Definition: FirstTimeCreationMessage.h:77
Interface()
Definition: FirstTimeCreationMessage.h:130
const char *(* GetKey)(const struct ak_wwise_plugin_first_time_creation_message_instance_v1 *in_this)
Returns a unique key used in the .wproj to indicate whether the licensing message was shown.
Definition: FirstTimeCreationMessage.h:67
@ k_interfaceType
The interface type, as provided by this plug-in.
Definition: FirstTimeCreationMessage.h:111
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:50
Base instance type for providing a message shown the first time an instance is created through ak_wwi...
Definition: PluginDef.h:888
Plug-in that provides a special usage message when first instantiated.
Definition: FirstTimeCreationMessage.h:44
FirstTimeCreationMessage()
Definition: FirstTimeCreationMessage.h:148
InterfacePtr GetInterfacePointer()
Definition: FirstTimeCreationMessage.h:137
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
ak_wwise_plugin_first_time_creation_message_v1 CFirstTimeCreationMessage
Definition: FirstTimeCreationMessage.h:94
The C interface, fulfilled by your plug-in.
Definition: FirstTimeCreationMessage.h:128
CFirstTimeCreationMessage::Instance * GetInstancePointer()
Definition: FirstTimeCreationMessage.h:141
virtual const char * GetKey() const =0
Returns a unique key used in the .wproj to indicate whether the licensing message was shown.
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:49
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_FIRST_TIME_CREATION_MESSAGE
2021.1 First Time Creation Message plug-in. ak_wwise_plugin_first_time_creation_message_v1
Definition: PluginBaseInterface.h:60
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
ak_wwise_plugin_first_time_creation_message_v1()
Definition: FirstTimeCreationMessage.h:53
const CFirstTimeCreationMessage::Instance * GetInstancePointer() const
Definition: FirstTimeCreationMessage.h:144
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: FirstTimeCreationMessage.h:121
virtual ~FirstTimeCreationMessage()
Definition: FirstTimeCreationMessage.h:153
virtual const char * GetCreationMessage() const =0
Returns a unique creation message shown to the user.
ak_wwise_plugin_first_time_creation_message_instance_v1 Instance
Base instance type for providing a message shown the first time an instance is created.
Definition: FirstTimeCreationMessage.h:51
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
Definition: AudioPlugin.h:111
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell us about your project. We're here to help.
Register your project and we'll help you get started with no strings attached!
Get started with Wwise