Warhorse ScripBind documentation
ContentsIndexHome
PreviousUpNext
Signal
Syntax
C++
int Signal(IFunctionHandler * pH);
Parameters 
Description 
signalFilter 
filter which defines the subset of AIobjects which will receive the signal: 
SIGNALFILTER_SENDER 
signal is sent to the sender only (may be not the caller itself in this case) 
SIGNALFILTER_GROUPONLY 
signal is sent to all the AIObjects in the same sender's group, within its communication range 
SIGNALFILTER_GROUPONLY_EXCEPT 
signal is sent to all the AIObjects in the same sender's group, within its communication range, except the sender itself 
SIGNALFILTER_SUPERGROUP 
signal is sent signal is sent to all the AIObjects in the same sender's group 
SIGNALFILTER_SPECIESONLY 
signal is sent to all the AIObjects in the same sender's species, in his comm range 
SIGNALFILTER_SUPERSPECIES 
signal is sent to all AIObjects in the same sender's species 
SIGNALFILTER_ANYONEINCOMM 
signal is sent to all the AIObjects in sender's communication range 
SIGNALFILTER_NEARESTGROUP 
signal is sent to the nearest AIObject in the sender's group 
SIGNALFILTER_NEARESTINCOMM 
signal is sent to the nearest AIObject, in the sender's group, within sender's communication range 
SIGNALFILTER_NEARESTINCOMM_SPECIES 
signal is sent to the nearest AIObject, in the sender's species, within sender's communication range 
SIGNALFILTER_HALFOFGROUP 
signal is sent to the first half of the AI Objects in the sender's group 
SIGNALFILTER_LEADER 
signal is sent to the sender's group CLeader Object 
SIGNALFILTER_LEADERENTITY 
signal is sent to the sender's group leader AIObject (which has the CLeader associated) 
signalType 
-1: signal is processed by all entities, even if they're disabled/sleeping 0: signal is processed by all entities which are enabled 1: signal is processed by all entities which are enabled and not sleeping 10: signal is added in the sender's signal queue even if another signal with same text is present (normally it's not) 
signalText 
signal text which will be processed by the receivers (in a Lua callback with the same name as the text, or directly by the CAIObject) (optional) signalExtraData: lua table which can be used to send extra data. It can contains the following values: 
point 
a vector in format {x,y,z} 
point2 
a vector in format {x,y,z} 
ObjectName 
a string 
id 
an entity id 
fValue 
a float value 
iValue 
an integer value 
iValue2 
a second integer value
 

Syntax: AI.Signal(signalFilter, signalType, SignalText, senderId [, signalExtraData] ) 

Sends a signal to an entity or a group of entities

Copyright (c) 2012. All rights reserved.