CryAudio::IObject

Public Member Functions | List of all members

CryAudio::IObjectabstract

A struct exposing public methods to interact with audio objects. More...

#include

Public Member Functions
virtual void	ExecuteTrigger (ControlId const triggerId, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	StopTrigger (ControlId const triggerId=InvalidControlId, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	SetTransformation (CObjectTransformation const &transformation, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	SetParameter (ControlId const parameterId, float const value, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	SetSwitchState (ControlId const audioSwitchId, SwitchStateId const audioSwitchStateId, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	SetEnvironment (EnvironmentId const audioEnvironmentId, float const amount, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	SetCurrentEnvironments (EntityId const entityToIgnore=INVALID_ENTITYID, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	ResetEnvironments (SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	SetOcclusionType (EOcclusionType const occlusionType, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	PlayFile (SPlayFileInfo const &playFileInfo, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	StopFile (char const *const szFile, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual void	SetName (char const *const szName, SRequestUserData const &userData=SRequestUserData::GetEmptyObject())=0

virtual EntityId	GetEntityId () const =0

Detailed Description

A struct exposing public methods to interact with audio objects.

Member Function Documentation

◆ ExecuteTrigger()

virtual void CryAudio::IObject::ExecuteTrigger	(	ControlId const	triggerId,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Executes the passed trigger ID on this audio object.

Parameters

triggerId	- ID of the trigger to execute.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

See also: StopTrigger

◆ GetEntityId()

virtual EntityId CryAudio::IObject::GetEntityId

(

)

const

pure virtual

Gets the entityId linked with this object (or INVALID_ENTITYID if not linked to an entity)

Returns: EntityId

◆ PlayFile()

virtual void CryAudio::IObject::PlayFile	(	SPlayFileInfo const &	playFileInfo,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Plays the given file on this audio object.

Parameters

playFileInfo	- reference to a struct that holds data necessary for playback.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

See also: StopFile

◆ ResetEnvironments()

virtual void CryAudio::IObject::ResetEnvironments ( SRequestUserData const & userData = SRequestUserData::GetEmptyObject() )

pure virtual

Removes all of the environments currently set to this audio object from this audio object.

Parameters

userData

- optional struct used to pass additional data to the internal request.

Returns: void

◆ SetCurrentEnvironments()

virtual void CryAudio::IObject::SetCurrentEnvironments	(	EntityId const	entityToIgnore = `INVALID_ENTITYID`,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Sets all of the environments in which this audio object is located to this audio object.

Parameters

entityToIgnore	- ID of the environment providing entity to ignore when determining environments and their values.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

◆ SetEnvironment()

virtual void CryAudio::IObject::SetEnvironment	(	EnvironmentId const	audioEnvironmentId,
		float const	amount,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Sets an environment to a given value on this audio object.

Parameters

audioEnvironmentId	- ID of the environment in question.
amount	- floating point value indicating the amount of the environment to apply.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

◆ SetName()

virtual void CryAudio::IObject::SetName	(	char const *const	szName,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Sets this audio object's name. Is only used during production whenever an entity's name is changed to adjust corresponding audio objects as well.

Parameters

szName	- name to set.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

◆ SetOcclusionType()

virtual void CryAudio::IObject::SetOcclusionType	(	EOcclusionType const	occlusionType,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Sets the occlusion type to be used by this audio object.

Parameters

occlusionType	- occlusion type to apply.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

◆ SetParameter()

virtual void CryAudio::IObject::SetParameter	(	ControlId const	parameterId,
		float const	value,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Sets a parameter to a given value on this audio object.

Parameters

parameterId	- ID of the parameter in question.
value	- floating point value to which the parameter should be set.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

◆ SetSwitchState()

virtual void CryAudio::IObject::SetSwitchState	(	ControlId const	audioSwitchId,
		SwitchStateId const	audioSwitchStateId,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Sets a switch to a given state on this audio object.

Parameters

audioSwitchId	- ID of the switch in question.
audioSwitchStateId	- ID of the switch's state in question.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

◆ SetTransformation()

virtual void CryAudio::IObject::SetTransformation	(	CObjectTransformation const &	transformation,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Sets this audio object's transformation.

Parameters

transformation	- const reference to the object holding the transformation to apply.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

◆ StopFile()

virtual void CryAudio::IObject::StopFile	(	char const *const	szFile,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Stops the given file on this audio object.

Parameters

szFile	- name of the file in question.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

See also: PlayFile

◆ StopTrigger()

virtual void CryAudio::IObject::StopTrigger	(	ControlId const	triggerId = `InvalidControlId`,
		SRequestUserData const &	userData = `SRequestUserData::GetEmptyObject()`
	)

pure virtual

Stops all instances of the passed trigger ID or all instances of all active triggers if CryAudio::InvalidControlId (default) is passed on this audio object.

Parameters

triggerId	- ID of the trigger to stop.
userData	- optional struct used to pass additional data to the internal request.

Returns: void

See also: ExecuteTrigger