GameSignalsManager Interface Reference

Public Member Functions
proto external int	AddOrFindSignal (string signalName, float value=0)
	Add or Find a signal which is always local to the machine.
proto external int	AddOrFindMPSignal (string signalName, float valueThreshold, float blendSpeed, float value=0, SignalCompressionFunc compressionFunc=SignalCompressionFunc.None)
	Add or find a signal which is synchronized over the network automatically.
proto external int	FindSignal (string signalName)
	Find a signal with given name.
proto external void	SetSignalValue (int index, float value)
	Set the signal with an index of.
proto external float	GetSignalValue (int index)
	Get value of the signal with index.

Member Function Documentation

AddOrFindMPSignal()

proto external int GameSignalsManager.AddOrFindMPSignal	(	string	signalName,
		float	valueThreshold,
		float	blendSpeed,
		float	value = 0,
		SignalCompressionFunc	compressionFunc = SignalCompressionFunc.None
	)

Add or find a signal which is synchronized over the network automatically.

Parameters

signalName	Name of the signal to add / find
valueThreshold	How much the value has to changed compared to the previous one in order to sync it over the network.
blendSpeed	How fast the value is interpolated when synced over the network. It also influences how much time can pass before the values is synced over the network again. Time in seconds = 1.0/blendSpeed.
value	Value the newly created signal is going to have.
compressionFunc	Compression type to use to compress the value when transfering it over the network.

Warning

This has to be performed on authority. If an attempt to register a MP signal is made on proxies an ordinary signal is created instead. If authority registers a signal it makes sure to synchronize to state with proxies.

Returns

Index of the signal. Returns -1 in case of error.

AddOrFindSignal()

proto external int GameSignalsManager.AddOrFindSignal	(	string	signalName,
		float	value = 0
	)

Add or Find a signal which is always local to the machine.

Parameters

signalName	Name of the signal to add / find
value	Value the newly created signal is going to have.

Returns

index of signal. Returns -1 in case of error.

FindSignal()

proto external int GameSignalsManager.FindSignal

(

string

signalName

)

Find a signal with given name.

Parameters

signalName

Name of the signal to find

Returns

Index of the signal. Returns -1 in case of error.

GetSignalValue()

proto external float GameSignalsManager.GetSignalValue

(

int

index

)

Get value of the signal with index.

Parameters

index

Returns

Value of the siganl. Returns 0.0f if the signal is not found.

SetSignalValue()

proto external void GameSignalsManager.SetSignalValue	(	int	index,
		float	value
	)

Set the signal with an index of.

Parameters

index	to
value

---

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

• Game/generated/GameSignalsManager.c