The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE2:ScriptControllerBase (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
U2XMP Object >> ScriptControllerInterf >> ScriptControllerBase
Package: 
U2AI

ScriptControllerBase.uc Created By: Mike Fox Created On: 8/01/00 $Author: Mfox $ $Date: 2/11/03 5:53p $ $Revision: 122 $

Constants[edit]

See ScriptControllerBase constants.

Properties[edit]

Property group 'ScriptControllerBase'[edit]

CommandFileName[edit]

Type: string

name of file with commands

CommandInfo[edit]

Type: CommandInfoT

Array size: MaxCommandInfoEntries

Modifiers: const


Default value, index 0:

Member Value
CommandCode CMD_Error
CommandString "error"
Signature "X"

Default value, index 1:

Member Value
CommandCode CMD_AddAmmo
CommandString "addammo"
Signature "SIb"

Default value, index 10:

Member Value
CommandCode CMD_AnimRelease
CommandString "animrelease"
Signature "X"

Default value, index 100:

Member Value
CommandCode CMD_SleepRand
CommandString "sleeprand"
Signature "f"

Default value, index 101:

Member Value
CommandCode CMD_Spawn
CommandString "spawn"
Signature "TSbss"

Default value, index 102:

Member Value
CommandCode CMD_Stop
CommandString "stop"
Signature "X"

Default value, index 103:

Member Value
CommandCode CMD_StopMovement
CommandString "stopmovement"
Signature "X"

Default value, index 104:

Member Value
CommandCode CMD_StopSound
CommandString "stopsound"
Signature "TNb"

Default value, index 105:

Member Value
CommandCode CMD_TestActorInRange
CommandString "testactorinrange"
Signature "NFss"

Default value, index 106:

Member Value
CommandCode CMD_TestProperty
CommandString "testproperty"
Signature "TSSss"

Default value, index 107:

Member Value
CommandCode CMD_TestPropertyCI
CommandString "testpropertyci"
Signature "TSSss"

Default value, index 108:

Member Value
CommandCode CMD_TestPropertyE
CommandString "testpropertye"
Signature "TSSss"

Default value, index 109:

Member Value
CommandCode CMD_TestPropertyG
CommandString "testpropertyg"
Signature "TSSss"

Default value, index 110:

Member Value
CommandCode CMD_AnimTween
CommandString "animtween"
Signature "Mfb"

Default value, index 111:

Member Value
CommandCode CMD_TestPropertyGE
CommandString "testpropertyge"
Signature "TSSss"

Default value, index 112:

Member Value
CommandCode CMD_TestPropertyL
CommandString "testpropertyl"
Signature "TSSss"

Default value, index 113:

Member Value
CommandCode CMD_TestPropertyLE
CommandString "testpropertyle"
Signature "TSSss"

Default value, index 114:

Member Value
CommandCode CMD_TestRandom
CommandString "testrandom"
Signature "Fss"

Default value, index 115:

Member Value
CommandCode CMD_TestState
CommandString "teststate"
Signature "TNss"

Default value, index 116:

Member Value
CommandCode CMD_TurnToActor
CommandString "turntoactor"
Signature "tib"

Default value, index 117:

Member Value
CommandCode CMD_Use
CommandString "use"
Signature "T"

Default value, index 118:

Member Value
CommandCode CMD_Unuse
CommandString "unuse"
Signature "T"

Default value, index 119:

Member Value
CommandCode CMD_WeaponLoad
CommandString "weaponload"
Signature "X"

Default value, index 120:

Member Value
CommandCode CMD_WeaponSetAmmoType
CommandString "weaponsetammotype"
Signature "S"

Default value, index 121:

Member Value
CommandCode CMD_AnimTweenEx
CommandString "animtweenex"
Signature "IMfb"

Default value, index 122:

Member Value
CommandCode CMD_WeaponSupportsAltFire
CommandString "weaponsupportsaltfire"
Signature "NB"

Default value, index 123:

Member Value
CommandCode CMD_WeaponSupportsFire
CommandString "weaponsupportsfire"
Signature "NB"

Default value, index 124:

Member Value
CommandCode CMD_Call
CommandString "call"
Signature "S"

Default value, index 125:

Member Value
CommandCode CMD_CallEnd
CommandString "callend"
Signature "X"

Default value, index 126:

Member Value
CommandCode CMD_ClearEvents
CommandString "clearevents"
Signature "X"

Default value, index 127:

Member Value
CommandCode CMD_ClearTimers
CommandString "cleartimers"
Signature "X"

Default value, index 128:

Member Value
CommandCode CMD_ClearTriggers
CommandString "cleartriggers"
Signature "X"

Default value, index 129:

Member Value
CommandCode CMD_ConsoleCommand
CommandString "consolecommand"
Signature "S"

Default value, index 130:

Member Value
CommandCode CMD_DebugAI
CommandString "debugai"
Signature "B"

Default value, index 131:

Member Value
CommandCode CMD_AgentBind
CommandString "agentbind"
Signature "MM"

Default value, index 132:

Member Value
CommandCode CMD_DebugAIEvents
CommandString "debugaievents"
Signature "B"

Default value, index 133:

Member Value
CommandCode CMD_DebugAIFlags
CommandString "debugaiflags"
Signature "I"

Default value, index 134:

Member Value
CommandCode CMD_DebugMode
CommandString "debugmode"
Signature "I"

Default value, index 135:

Member Value
CommandCode CMD_DecProperty
CommandString "decproperty"
Signature "TSf"

Default value, index 136:

Member Value
CommandCode CMD_DeployInventory
CommandString "deployinventory"
Signature "Sb"

Default value, index 137:

Member Value
CommandCode CMD_Destroy
CommandString "destroy"
Signature "X"

Default value, index 138:

Member Value
CommandCode CMD_DialogDisable
CommandString "dialogdisable"
Signature "M"

Default value, index 139:

Member Value
CommandCode CMD_DialogEnable
CommandString "dialogenable"
Signature "M"

Default value, index 140:

Member Value
CommandCode CMD_DialogFar
CommandString "dialogfar"
Signature "MSs"

Default value, index 141:

Member Value
CommandCode CMD_DialogFarWait
CommandString "dialogfarwait"
Signature "MSs"

Default value, index 142:

Member Value
CommandCode CMD_AgentCall
CommandString "agentcall"
Signature "Mb"

Default value, index 143:

Member Value
CommandCode CMD_DialogInitiate
CommandString "dialoginitiate"
Signature "sm"

Default value, index 144:

Member Value
CommandCode CMD_DialogTerminate
CommandString "dialogterminate"
Signature "S"

Default value, index 145:

Member Value
CommandCode CMD_DirectionalPatrol
CommandString "directionalpatrol"
Signature "B"

Default value, index 146:

Member Value
CommandCode CMD_Dormant
CommandString "dormant"
Signature "Bb"

Default value, index 147:

Member Value
CommandCode CMD_DropInventory
CommandString "dropinventory"
Signature "S"

Default value, index 148:

Member Value
CommandCode CMD_EnableProbeEvent
CommandString "enableprobeevent"
Signature "NB"

Default value, index 149:

Member Value
CommandCode CMD_EnableXMPHandling
CommandString "enablexmphandling"
Signature "B"

Default value, index 150:

Member Value
CommandCode CMD_EventDisable
CommandString "eventdisable"
Signature "N"

Default value, index 151:

Member Value
CommandCode CMD_EventEnable
CommandString "eventenable"
Signature "N"

Default value, index 152:

Member Value
CommandCode CMD_EventWait
CommandString "eventwait"
Signature "Nn"

Default value, index 153:

Member Value
CommandCode CMD_AgentExecute
CommandString "agentexecute"
Signature "Sb"

Default value, index 154:

Member Value
CommandCode CMD_FindActor
CommandString "findactor"
Signature "sffiiiss"

Default value, index 155:

Member Value
CommandCode CMD_Fire
CommandString "fire"
Signature "f"

Default value, index 156:

Member Value
CommandCode CMD_FireAlt
CommandString "firealt"
Signature "f"

Default value, index 157:

Member Value
CommandCode CMD_Gib
CommandString "gib"
Signature "bi"

Default value, index 158:

Member Value
CommandCode CMD_GibAll
CommandString "giball"
Signature "Sbi"

Default value, index 159:

Member Value
CommandCode CMD_GiveInventory
CommandString "giveinventory"
Signature "S"

Default value, index 160:

Member Value
CommandCode CMD_GiveItemToPlayer
CommandString "giveitemtoplayer"
Signature "Si"

Default value, index 161:

Member Value
CommandCode CMD_GiveTossedItem
CommandString "givetosseditem"
Signature "S"

Default value, index 162:

Member Value
CommandCode CMD_GotoActor
CommandString "gotoactor"
Signature "Tfb"

Default value, index 163:

Member Value
CommandCode CMD_GotoActorSafe
CommandString "gotoactorsafe"
Signature "Nfb"

Default value, index 164:

Member Value
CommandCode CMD_AgentUnbind
CommandString "agentunbind"
Signature "M"

Default value, index 165:

Member Value
CommandCode CMD_GotoLabel
CommandString "gotolabel"
Signature "S"

Default value, index 166:

Member Value
CommandCode CMD_IncProperty
CommandString "incproperty"
Signature "TSf"

Default value, index 167:

Member Value
CommandCode CMD_Inert
CommandString "inert"
Signature "B"

Default value, index 168:

Member Value
CommandCode CMD_HandlerGroup
CommandString "handlergroup"
Signature "X"

Default value, index 169:

Member Value
CommandCode CMD_HandlerGroupEnd
CommandString "handlergroupend"
Signature "X"

Default value, index 170:

Member Value
CommandCode CMD_HeadTracking
CommandString "headtracking"
Signature "B"

Default value, index 171:

Member Value
CommandCode CMD_Jump
CommandString "jump"
Signature "FFF"

Default value, index 172:

Member Value
CommandCode CMD_Kill
CommandString "kill"
Signature "X"

Default value, index 173:

Member Value
CommandCode CMD_KillAll
CommandString "killall"
Signature "S"

Default value, index 174:

Member Value
CommandCode CMD_Message
CommandString "message"
Signature "Si"

Default value, index 175:

Member Value
CommandCode CMD_AnimLoop
CommandString "animloop"
Signature "Mffb"

Default value, index 176:

Member Value
CommandCode CMD_OnEvent
CommandString "onevent"
Signature "Nssb"

Default value, index 177:

Member Value
CommandCode CMD_OnTimer
CommandString "ontimer"
Signature "Iffssi"

Default value, index 178:

Member Value
CommandCode CMD_OnTrigger
CommandString "ontrigger"
Signature "Mssbfss"

Default value, index 179:

Member Value
CommandCode CMD_PlaySound
CommandString "playsound"
Signature "TSnfbff"

Default value, index 180:

Member Value
CommandCode CMD_PlaySoundWait
CommandString "playsoundwait"
Signature "TSnfbff"

Default value, index 181:

Member Value
CommandCode CMD_PlaySoundTableSlot
CommandString "playsoundtableslot"
Signature "TS"

Default value, index 182:

Member Value
CommandCode CMD_PlaySoundTableSlotWait
CommandString "playsoundtableslotwait"
Signature "TS"

Default value, index 183:

Member Value
CommandCode CMD_RemoveInventory
CommandString "removeinventory"
Signature "s"

Default value, index 184:

Member Value
CommandCode CMD_RemoveInventoryFromPlayer
CommandString "removeinventoryfromplayer"
Signature "s"

Default value, index 185:

Member Value
CommandCode CMD_RemoveItemFromPlayer
CommandString "removeitemfromplayer"
Signature "S"

Default value, index 186:

Member Value
CommandCode CMD_AnimLoopEx
CommandString "animloopex"
Signature "IMffb"

Default value, index 187:

Member Value
CommandCode CMD_RemoveTossedItem
CommandString "removetosseditem"
Signature "s"

Default value, index 188:

Member Value
CommandCode CMD_ResumePatrol
CommandString "resumepatrol"
Signature "SSN"

Default value, index 189:

Member Value
CommandCode CMD_Return
CommandString "return"
Signature "X"

Default value, index 190:

Member Value
CommandCode CMD_SaveDestination
CommandString "savedestination"
Signature "X"

Default value, index 191:

Member Value
CommandCode CMD_SendEvent
CommandString "sendevent"
Signature "MB"

Default value, index 192:

Member Value
CommandCode CMD_SetActorRangeTest
CommandString "setactorrangetest"
Signature "NFb"

Default value, index 193:

Member Value
CommandCode CMD_SetAimOdds
CommandString "setaimodds"
Signature "F"

Default value, index 194:

Member Value
CommandCode CMD_SetAlert
CommandString "setalert"
Signature "B"

Default value, index 195:

Member Value
CommandCode CMD_SetAmmo
CommandString "setammo"
Signature "SIb"

Default value, index 196:

Member Value
CommandCode CMD_SetFocus
CommandString "setfocus"
Signature "t"

Default value, index 197:

Member Value
CommandCode CMD_AnimPlay
CommandString "animplay"
Signature "Mffb"

Default value, index 198:

Member Value
CommandCode CMD_SetHealth
CommandString "sethealth"
Signature "I"

Default value, index 199:

Member Value
CommandCode CMD_SetInventory
CommandString "setinventory"
Signature "TS"

Default value, index 200:

Member Value
CommandCode CMD_SetLocation
CommandString "setlocation"
Signature "Mb"

Default value, index 201:

Member Value
CommandCode CMD_SetLocationNamed
CommandString "setlocationnamed"
Signature "TMb"

Default value, index 202:

Member Value
CommandCode CMD_SetLocationVector
CommandString "setlocationvector"
Signature "TFFFb"

Default value, index 203:

Member Value
CommandCode CMD_SetMoveSpeed
CommandString "setmovespeed"
Signature "Fs"

Default value, index 204:

Member Value
CommandCode CMD_SetMoveSpeedAuto
CommandString "setmovespeedauto"
Signature "f"

Default value, index 205:

Member Value
CommandCode CMD_SetOrders
CommandString "setorders"
Signature "ntfn"

Default value, index 206:

Member Value
CommandCode CMD_SetPhysics
CommandString "setphysics"
Signature "NM"

Default value, index 207:

Member Value
CommandCode CMD_SetProperty
CommandString "setproperty"
Signature "TSS"

Default value, index 208:

Member Value
CommandCode CMD_AnimPlayEx
CommandString "animplayex"
Signature "IMffb"

Default value, index 209:

Member Value
CommandCode CMD_SetProperties
CommandString "setproperties"
Signature "SSS"

Default value, index 210:

Member Value
CommandCode CMD_SetSatellite
CommandString "setsatellite"
Signature "Mt"

Default value, index 211:

Member Value
CommandCode CMD_SetScript
CommandString "setscript"
Signature "Ss"

Default value, index 212:

Member Value
CommandCode CMD_SetSkill
CommandString "setskill"
Signature "F"

Default value, index 213:

Member Value
CommandCode CMD_SetStance
CommandString "setstance"
Signature "S"

Default value, index 214:

Member Value
CommandCode CMD_SetStationary
CommandString "setstationary"
Signature "Bb"

Default value, index 215:

Member Value
CommandCode CMD_SetTacticalMoveType
CommandString "settacticalmovetype"
Signature "I"

Default value, index 216:

Member Value
CommandCode CMD_SetWeapon
CommandString "setweapon"
Signature "s"

Default value, index 217:

Member Value
CommandCode CMD_Shutdown
CommandString "shutdown"
Signature "B"

Default value, index 218:

Member Value
CommandCode CMD_Sleep
CommandString "sleep"
Signature "f"

DebugMode[edit]

Type: int

Modifiers: globalconfig

script debug mode (use debugmode command or unreal.ini to enable)

ErrorMessageFrequency[edit]

Type: float

Modifiers: globalconfig


Default value: 3.0

Events[edit]

Type: EventT

Array size: 32 (MaxEvents)

list of events (string/name/waitstatename)

Default value, index 0:

Member Value
bCanToggle True
bEnabled True
EventName 'ActorInRange'
EventWaitState 'WaitActorInRange'
OnCmdIndex -1

Default value, index 1:

Member Value
bCanToggle True
bEnabled True
EventName 'ActorOutOfRange'
EventWaitState 'WaitActorOutOfRange'
OnCmdIndex -1

Default value, index 10:

Member Value
bEnabled True
EventName 'DialogBegin'
EventWaitState 'WaitDialogBegin'
OnCmdIndex -1

Default value, index 11:

Member Value
bEnabled True
EventName 'DialogUnPause'
OnCmdIndex -1

Default value, index 12:

Member Value
bEnabled True
EventName 'Died'
EventWaitState 'WaitDied'
OnCmdIndex -1

Default value, index 13:

Member Value
bCanToggle True
bEnabled True
EventName 'EnemyNotVisible'
OnCmdIndex -1

Default value, index 14:

Member Value
bCanToggle True
bEnabled True
EventName 'HearNoiseFriendly'
EventWaitState 'WaitHearNoiseFriendly'
OnCmdIndex -1

Default value, index 15:

Member Value
bCanToggle True
bEnabled True
EventName 'HearNoiseOther'
EventWaitState 'WaitHearNoiseOther'
OnCmdIndex -1

Default value, index 16:

Member Value
bCanToggle True
bEnabled True
EventName 'HearNoiseThreat'
EventWaitState 'WaitHearNoiseThreat'
OnCmdIndex -1

Default value, index 17:

Member Value
bCanToggle True
bEnabled True
EventName 'InheritEnemy'
OnCmdIndex -1

Default value, index 18:

Member Value
bEnabled True
EventName 'ScriptedLanding'
EventWaitState 'WaitScriptedLanding'
OnCmdIndex -1

Default value, index 19:

Member Value
bCanToggle True
bEnabled True
EventName 'SeeAlertFriend'
OnCmdIndex -1

Default value, index 20:

Member Value
bEnabled True
EventName 'AnimEnd'
OnCmdIndex -1

Default value, index 21:

Member Value
bCanToggle True
bEnabled True
EventName 'SeeEnemy'
EventWaitState 'WaitSeeEnemy'
OnCmdIndex -1

Default value, index 22:

Member Value
bCanToggle True
bEnabled True
EventName 'SeeFriend'
EventWaitState 'WaitSeeFriend'
OnCmdIndex -1

Default value, index 23:

Member Value
bCanToggle True
bEnabled True
EventName 'SeeOther'
EventWaitState 'WaitSeeOther'
OnCmdIndex -1

Default value, index 24:

Member Value
bCanToggle True
bEnabled True
EventName 'SeePlayer'
EventWaitState 'WaitSeePlayer'
OnCmdIndex -1

Default value, index 25:

Member Value
bCanToggle True
bEnabled True
EventName 'TakeDamage'
EventWaitState 'WaitTakeDamage'
OnCmdIndex -1

Default value, index 26:

Member Value
bCanToggle True
bEnabled True
EventName 'TookDamage'
EventWaitState 'WaitTookDamage'
OnCmdIndex -1

Default value, index 27:

Member Value
bEnabled True
EventName 'TookDamageEnemy'
EventWaitState 'WaitTookDamageEnemy'
OnCmdIndex -1

Default value, index 28:

Member Value
bEnabled True
EventName 'TookDamageFriend'
EventWaitState 'WaitTookDamageFriend'
OnCmdIndex -1

Default value, index 29:

Member Value
bCanToggle True
bEnabled True
EventName 'Trigger'
EventWaitState 'WaitTrigger'
OnCmdIndex -1

Default value, index 30:

Member Value
bCanToggle True
bEnabled True
EventName 'AutoBegin'
OnCmdIndex -1

Default value, index 31:

Member Value
bEnabled True
EventName 'AutoEnd'
OnCmdIndex -1

Default value, index 32:

Member Value
bCanToggle True
bEnabled True
EventName 'BumpEnemy'
EventWaitState 'WaitBumpEnemy'
OnCmdIndex -1

Default value, index 33:

Member Value
bCanToggle True
bEnabled True
EventName 'BumpFriend'
EventWaitState 'WaitBumpFriend'
OnCmdIndex -1

Default value, index 34:

Member Value
bCanToggle True
bEnabled True
EventName 'BumpOther'
EventWaitState 'WaitBumpOther'
OnCmdIndex -1

Default value, index 35:

Member Value
bCanToggle True
bEnabled True
EventName 'BumpPlayer'
EventWaitState 'WaitBumpPlayer'
OnCmdIndex -1

Default value, index 36:

Member Value
bEnabled True
EventName 'DestinationReached'
EventWaitState 'WaitDestinationReached'
OnCmdIndex -1

StartLabelName[edit]

Type: string


Timers[edit]

Type: TimerT

Array size: 10 (MaxTimers)

timer list (ontimer and ontrigger timers -- ontrigger timers use bottom of list)

TriggerEvents[edit]

Type: TriggerEventT

Array size: MaxTriggerEvents

list of trigger events which are being tracked (for "ontrigger xxx gotolable yyy" or "waitevent trigger xxx")

Internal variables[edit]

See ScriptControllerBase internal variables.

Default values[edit]

Property Value
bHasScript True

Enums[edit]

See ScriptControllerBase enums.

Structs[edit]

CommandInfoT[edit]

Modifiers: native

string CommandString 
ECommandCode CommandCode 
string Signature 

CommandT[edit]

Modifiers: native

string CommandString 
command string
int CommandIndex 
index into Commands list (stored so don't have to extract from command string each time)
Object CommandTarget 
command target (stored if possible so don't have to extract/find each time)

EventT[edit]

Modifiers: native

name EventName 
event name...
name EventWaitState 
state to use when waiting for the event
bool bEnabled 
event is enabled (default)
bool bCanToggle 
event can be enabled/disabled (false ==> always enabled)
int OnCmdIndex 
index to handler (line # after stripping comments)
bool bClear 
whether to clear handler when event arrives
int Group 
group event handler belongs to
bool bInterrupt 
whether to execute gotolabel (false) or interrupt (true)

TimerT[edit]

Modifiers: native

float InitialFrequency 
float RepeatFrequency 
int TriggerIndex 
index of assosiated trigger event for trigger timers
int OnCmdIndex 
int Group 
group event handler belongs to
bool bInterrupt 
whether to execute gotolabel (false) or interrupt (true)

TriggerEventT[edit]

Modifiers: native

name EventName 
int OnCmdIndex 
bool bClear 
whether to clear trigger handler when event arrives
int TimerIndex 
index of associated timer, -1 if none
int Group 
group event handler belongs to
bool bInterrupt 
whether to execute gotolabel (false) or interrupt (true)

Functions[edit]

Native functions[edit]

LoadCommandsFromFile[edit]

native function bool LoadCommandsFromFile (string FileName, LevelInfo Level)


Other instance functions[edit]

See ScriptControllerBase instance functions.

States[edit]

See ScriptControllerBase states.