Inheritance diagram for CharacterSndComponent:

Additional Inherited Members
Public Member Functions inherited from SndComponent
proto external IEntity	GetOwner ()

proto external AudioHandle	PlayStr (string name)

proto external int	GetEventIndex (string name)

proto external int	SoundEventBegin (string eventName)

proto external int	SoundEventEnd (int eventBeginId)

proto external int	GetSignalIndex (string name)
	Returns the index of the given signal name or -1 if not found.

proto external void	SetSignalValue (int signal, float value)
	Sets signal value by index returned by GetSignalIndex(string name).

proto external void	SetSignalValueStr (string signal, float value)

proto external void	SetTransformation (vector transf[])

proto external void	SetSoundTransformation (AudioHandle handle, vector transf[])

proto external void	UpdateTrigger ()

proto external void	Terminate (AudioHandle handle)

proto external void	TerminateAll ()

proto external bool	IsPlaying ()

proto external bool	IsFinishedPlaying (AudioHandle handle)

proto external bool	IsHandleValid (AudioHandle handle)

proto external void	GetSignalNames (out array< string > signalNames)

Public Member Functions inherited from GenericComponent
proto external EntityComponentPrefabData	GetComponentData (notnull IEntity ent)
	Gets GenericComponentClass descendant instance with the prefab data.

proto external BaseContainer	GetComponentSource (notnull IEntity ent)
	Gets config container with the prefab data.

proto void	Rpc (func method, void p0=NULL, void p1=NULL, void p2=NULL, void p3=NULL, void p4=NULL, void p5=NULL, void p6=NULL, void p7=NULL)
	Attempts to run a remote procedure call (RPC) of this instance with parameters specified in method RplRpc attribute.

proto external int	GetEventMask ()
	Gets current eventmask of the component.

proto external int	SetEventMask (notnull IEntity owner, int mask)
	Sets eventmask.

proto external int	ClearEventMask (notnull IEntity owner, int mask)
	Clears bitmask.

proto external GenericComponent	FindComponent (TypeName typeName)
	Finds first occurance of the coresponding component.

proto external int	FindComponents (TypeName typeName, notnull array< GenericComponent > outComponents)
	Finds all occurances of the coresponding component.

proto external void	Activate (IEntity owner)
	Activate component and calls EOnActivate().

proto external void	Deactivate (IEntity owner)
	Deactivate component and calls EOnDectivate().

proto external bool	IsActive ()
	Returns activity state.

proto external void	OnTransformReset (bool isCorrection=false, vector newVelocity=vector.Zero)
	Notifies the component that a transformation of the owner entity has been discontinuously changed.

void	_WB_SetTransform (IEntity owner, inout vector mat[4], IEntitySource src)
	Editor changed entity transformation matrix source. Do not call editor API here!

void	_WB_OnInit (IEntity owner, inout vector mat[4], IEntitySource src)
	Called always after entity creation. It's purpose is to prepare entity for editing. Do not edit anything through editor API here because it's too early for undoable actions! Use plain BaseContainer API for changes through src parameter if needed!

bool	_WB_CanDelete (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be deleted. Do not call editor API here!

bool	_WB_CanRename (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be renamed. Do not call editor API here!

bool	_WB_CanCopy (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be copied. Do not call editor API here!

bool	_WB_CanSelect (IEntity owner, IEntitySource src)
	Editor needs to know whether this entity can be selected in scene window or not.

void	_WB_GetBoundBox (IEntity owner, inout vector min, inout vector max, IEntitySource src)
	Editor needs to know a bound box of entity (For ray-casting, visualizers etc.). You can return any custom size you need. Do not call editor API here!

void	_WB_SetExtraVisualiser (IEntity owner, EntityVisualizerType type, IEntitySource src)
	If entity needs to have a special visualizer instead of default one, here is the place where you can implement it. Do not call editor API here!

array< ref WB_UIMenuItem >	_WB_GetContextMenuItems (IEntity owner)
	An opportunity to append items into editor's "Component" context menu. Do not call editor API here!

bool	_WB_OnPhysSimulPlacementBegin (IEntity owner, IEntitySource src)
	Does this entity support editing transformation using physics simulation? Do not call editor API here!

bool	_WB_EnablePhysics (IEntity owner, IEntitySource src, bool physics)
	Prepare to edit transformation using physics simulation. Return previous status. Do not call editor API here!

bool	_WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
	Any property value has been changed. You can use editor API here and do some additional edit actions which will be part of the same "key changed" action.

void	_WB_AfterWorldUpdate (IEntity owner, float timeSlice)
	Called after updating world in Workbench. The entity must be selected. You can use editor API here and do some edit actions if needed.

int	_WB_GetAfterWorldUpdateSpecs (IEntity owner, IEntitySource src)
	Called after _WB_OnInit or also later when editor needs to know whether _WB_AfterWorldUpdate needs to be called and when. Return value can be either 0 (event will not be called at all) or any combination of EEntityFrameUpdateSpecs. Avoid CALL_ALWAYS flag whenever possible to prevent performance issues.

void	_WB_OnContextMenu (IEntity owner, int id)
	User has chosen any of your menu item from editor's "Component" menu which you have recently provided in WB_GetContextMenuItems(). You can use editor API here and do some edit actions.

void	_WB_OnKeyDown (IEntity owner, int keyCode)
	User pressed a key and this entity is main member of entity selection. You can use editor API here and do some edit actions which will be undoable.

void	_WB_OnCreate (IEntity owner, IEntitySource src)
	Called after entity gets created in map during editing or when deleted entity gets restored after undo action. This event isn't called by loading map!!! If you need an event that is being called after every entity creation then use WB_OnInit instead it. You can use editor API here and do some additional edit actions which will be part of the same "create entity" action.

void	_WB_OnParentChange (IEntity owner, IEntitySource src, IEntitySource prevParentSrc)
	Parent entity has been changed ( it's available through src->GetParent() ). prevParentSrc is a pointer to a previous parent (if any)

void	_WB_OnDelete (IEntity owner, IEntitySource src)
	Entity is going to be deleted. You can use editor API here and do some additional edit actions which will be part of the same "entity delete" action.

void	_WB_OnRename (IEntity owner, IEntitySource src, string oldName)
	Entity has been renamed. You can use editor API here and do some additional edit actions which will be part of the same "entity rename" action.

array< ref ParamEnum >	_WB_GetUserEnums (string varName, IEntity owner, IEntityComponentSource src)
	Possibility to get variable value choices dynamically.

Static Public Member Functions inherited from GenericComponent
static bool	Preload (IEntityComponentSource src)

Protected Member Functions inherited from SndComponent
proto external void	SetCallbackMask (SndComponentCallbacks mask)
	Enables scripted component callbacks.

proto external void	SetForceUpdate (bool forceUpdate)
	When set to TRUE, Update is called regardless of audibility and other conditions.

proto external void	SetDisableUpdate (bool forceUpdate)
	When set to TRUE, Update is not called, but component stays registered in SndSystem.

void	Update (float dt)
	Called when the component is audible.

void	OnUpdateBegin ()
	Called when the component enters an audible range.

void	OnUpdateEnd ()
	Called when the component gets out of audible range.

void	OnInit (IEntity owner)
	Requires SndComponentCallbacks.OnInit to be set.

void	OnPostInit (IEntity owner)
	Requires SndComponentCallbacks.OnPostInit to be set.

void	OnDelete (IEntity owner)
	Requires SndComponentCallbacks.OnDelete to be set.

Protected Member Functions inherited from GenericComponent
proto external void	ConnectToDiagSystem (IEntity owner)

proto external void	DisconnectFromDiagSystem (IEntity owner)

void	OnTransformResetImpl (TransformResetParams params)
	Script-side implementation of OnTransformReset.

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

GameLib/generated/Components/Character/CharacterSndComponent.c

Additional Inherited Members