Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |
00001 00002 00003 00004 00005 00006 00007 00008 00009 00010 00011 00012 00013 00014 00015 00016 00017 00018 00019 00020 00021 00022 00023 00024 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 00036 00037 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 00061 00062 00063 00064 00065 00066 00067 00068 00069 00070 00071 00072 00073 00074 00075 00076 00077 00078 00079 00080 00081 00082 00083 00084 00085 00086 00087 00088 00089 00090 00091 00092 00093 00094 00095 00096 00097 00098 00099 00100 00101 00102 00103 00104 00105 00106 00107 00108 00109 00110 00111 00112 00113 00114 00115 00116 00117 00118 00119 00120 00121 00122 00123 00124 00125 00126 00127 00128 00129 00130 00131 00132 00133 00134 00135 00136 00137 00138 00139 00140 00141 00142 00143 00144 00145 00146 00147 00148 00149 00150 00151 00152 00153 00154 00155 00156 00157 00158 00159 00160 00161 00162 00163 00164 00165 00166 00167 00168 00169 00170 00171 00172 00173 00174 00175 00176 00177 00178 00179 00180 00181 00182 00183 00184 00185 00186 00187 00188 00189 00190 00191 00192 00193 00194 00195 00196 00197 00198 00199 00200 00201 00202 00203 00204 00205 00206 00207 00208 00209 00210 00211 00212 00213 00214 00215 00216 00217 00218 00219 00220 00221 00222 00223 00224 00225 00226 00227 00228 00229 00230 00231 00232 00233 00234 00235 00236 00237 00238 00239 00240 00241 00242 00243 00244 00245 00246 00247 00248 00249 00250 00251 00252 00253 00254 00255 00256 00257 00258 00259 00260 00261 00262 00263 00264 00265 00266 00267 00268 00269 00270 00271 00272 00273 00274 00275 00276 00277 00278 00279 00280 00281 00282 00283 00284 00285 00286 00287 00288 00289 00290 00291 00292 00293 00294 00295 00296 00297 00298 00299 00300 00301 00302 00303 00304 00305 00306 00307 00308 00309 00310 00311 00312 00313 00314 00315 00316 00317 00318 00319 00320 00321 00322 00323 00324 00325 00326 00327 00328 00329 00330 00331 00332 00333 00334 00335 00336 00337 00338 00339 00340 00341 00342 00343 00344 00345 00346 00347 00348 00349 00350 00351 00352 00353 00354 00355 00356 00357 00358 00359 00360 00361 00362 00363 00364 00365 00366 00367 00368 00369 00370 00371 00372 00373 00374 00375 00376 00377 00378 00379 00380 00381 00382 00383 00384 00385 00386 00387 00388 00389 00390 00391 00392 00393 00394 00395 00396 00397 00398 00399 00400 00401 00402 00403 00404 00405 00406 00407 00408 00409 00410 00411 00412 00413 00414 00415 |
class Script extends Engine.Actor native hidecategories(Advanced) hidecategories(Collision) hidecategories(Events) hidecategories(Force) hidecategories(Karma) hidecategories(Lighting) hidecategories(LightColor) hidecategories(Movement) hidecategories(Sound) hidecategories(Display) hidecategories(Object) hidecategories(Placement) hidecategories(Navigation) placeable; import class Engine.Message; #define DISALLOW_SCIPTS_IN_MP 0 enum eScriptType { TYPE_Normal, TYPE_IngameCutscene, TYPE_OpeningCutscene, TYPE_Max }; var() editcombotype(enumValidMessages) editdisplay(editorDisplayMessage) class<Message> messageClass; var() editinline editdisplay(editorDisplayFilter) deepcopy Message messageFilter; var() editinline deepcopy Array<Action> Actions; var() bool enabled; // Cutscene Script variables var(Cutscene) eScriptType scriptType "Type of script"; var(Cutscene) float cutscenePriority "priority - only valid if this is a cutscene script"; var bool bIsExecuting; var Array<WatcherBase> watchers; var private bool bExitScript; var private bool bExitLoop; var private Message currentMessage; var private Array<Message> messageQueue; var private Array<Variable> variables; var private Array<Variable> tempVariables; // Destoryed after script execution var globalconfig bool bTemporaryHiddenEdHack; // TEMPORARY delegate stopTalkingHead(Script requestingScript) { } // PostBeginPlay function PostBeginPlay() { local int i; for (i = 0; i < Actions.Length; ++i) if (Actions[i] != None) Actions[i].setParentScript(self); if (triggeredBy != "") registerMessage(messageClass, triggeredBy); } simulated event SetInitialState() { } simulated event PrecacheSpeech(SpeechManager Manager) { local int i; for (i = 0; i < Actions.Length; ++i) if (Actions[i] != None) Actions[i].PrecacheSpeech(Manager); } event Timer() { dispatchMessage(new class'MessageTimerExpired'); } function Variable findVariable(Name variableName) { local Name fullVariableName; local int i; fullVariableName = Name("Variable_" $ String(variableName)); for (i = 0; i < variables.length; ++i) { if (variables[i].name == fullVariableName) return variables[i]; } return None; } // newVariable // Variables are stored with the 'owner' script object as outer, prepended with the string "Variable_" to avoid any possible name clashes function Variable newVariable(Name variableName, class<Variable> variableType) { local Variable v; v = findVariable(variableName); if (v != None) return v; variables[variables.length] = new(self, "Variable_" $ variableName) variableType(self); return variables[variables.length - 1]; } // newTemporaryVariable // Temporary variables are destroyed after a script finishes execution function Variable newTemporaryVariable(class<Variable> variableType, optional string initValue) { local Variable v; v = new(self) variableType(self); tempVariables[tempVariables.length] = v; if (initValue != "") v.SetPropertyText("value", initValue); return v; } function addWatcher(WatcherBase newWatcher) { watchers[watchers.Length] = newWatcher; } function setWatcherEnabled(Name watcherName, bool enabled) { local int i; for (i = 0; i < watchers.Length; ++i) { if (watchers[i].watcherName == watcherName) { watchers[i].enabled = enabled; watchers[i].GotoState('LookAtExpression'); } } } // exit // Ends the script when called during script execution function exit() { bExitScript = true; } function bool continueExecution() { return !bExitScript; } // enterLoop // tells the script that a loop has started function enterLoop() { bExitLoop = false; } // keepLooping // true if the script should keep looping, false otherwise function bool keepLooping() { return !bExitLoop && !bExitScript; } // exitLoop // Ends the currently running loop, does nothing if no loop is running function exitLoop() { bExitLoop = true; } // onMessage function onMessage(Message msg) { if (!enabled) return; if (msg.Class != messageClass) return; if (messageFilter != None && !msg.passesFilter(messageFilter)) return; execute(msg); } // triggeringMessage function Message triggeringMessage() { return currentMessage; } // execute function execute(Message msg) { local Message msgCopy; local Name propName; assert(msg != None); #if DISALLOW_SCIPTS_IN_MP if (Level.NetMode != NM_Standalone) return; #endif if((scriptType != TYPE_Normal) && (! CutsceneManager(Level.cutsceneManager).CanExecute(self))) { log("Script " $Label $" was denied execution by the cutscene Manager"); return; } bExitScript = false; msgCopy = new messageClass; ForEach AllProperties(messageClass, class'Message', propName) { msgCopy.SetPropertyText(string(propName), msg.GetPropertyText(string(propName))); } if (currentMessage == None) { currentMessage = msgCopy; GotoState('ExecuteScript'); } else { messageQueue[messageQueue.Length] = msgCopy; } } function executeFromExec() { if (bIsExecuting) // Don't allow re-entry { Log("Script " $ Label $ " was denied execution because of attempted re-entry"); return; } bExitScript = false; GotoState('ExecuteScript'); } // Used to execute a script from another script. Note that currentMessage will be None latent function executeScriptFromScriptAction(bool blockCallingScript) { if (!enabled) return; if (bIsExecuting) // Don't allow re-entry { Log("Script " $ Label $ " was denied execution because of attempted re-entry"); return; } if((scriptType != TYPE_Normal) && (! CutsceneManager(Level.cutsceneManager).CanExecute(self))) { log("Script " $Label $" was denied execution by the cutscene Manager"); return; } bExitScript = false; if (blockCallingScript) executeActions(); else GotoState('ExecuteScript'); } latent private function executeActions() { local int i; SLog("Starting execution of script " $ Label); bIsExecuting = true; // execute script for (i = 0; i < Actions.Length && !bExitScript; i++) { if (Actions[i] != None) // Some wallies put None actions in their scripts :/ Actions[i].execute(); } stopTalkingHead(self); if (currentMessage != None) { Level.messageDispatcher.deleteMessage(currentMessage); currentMessage = None; } destroyTempVariables(); tempVariables.Length = 0; bIsExecuting = false; SLog("Finished executing script " $ Label); if(scriptType != TYPE_Normal) CutsceneManager(Level.cutsceneManager).ScriptEnded(self); } native function destroyTempVariables(); state ExecuteScript { begin: executeActions(); if (messageQueue.Length > 0) { currentMessage = messageQueue[0]; messageQueue.Remove(0, 1); Goto('Begin'); } else { GotoState(''); } } // enumValidMessages // Enumerate the valid message classes given the type of the object specified in TriggeredBy function enumValidMessages(Engine.LevelInfo l, out Array<class<Message> > s) { local class c; local class base; local class<Message> m; local Actor triggeredByActor; local Name triggeredByActorLabel; if (triggeredBy == "") return; if (triggeredBy != "all" && InStr(triggeredBy, ",") == -1) triggeredByActor = findStaticByLabel(class'Actor', name(triggeredBy)); if (triggeredByActor != None) triggeredByActorLabel = triggeredByActor.Label; base = class'Message'; ForEach AllClasses(base, c) { m = class<Message>(c); if (m.default.specificTo != None && m.static.editorDisplay(triggeredByActorLabel, None) != "") { if (triggeredByActor == None || triggeredByActor.IsA(m.default.specificTo.name)) s[s.Length] = m; } } } // editorDisplayMessage // Define the text used to display the messageClassName field within the editor function string editorDisplayMessage(class<Message> input) { if (triggeredBy == "") return "'TriggeredBy' is empty"; else if (input == None) return "No message specified"; else return input.static.editorDisplay(Name(triggeredBy), messageFilter); } function string editorDisplayFilter(Message input) { local String displayString; local Name propName; local String filterProp; if (input == None) return ""; displayString = editorDisplayMessage(messageClass); ForEach AllEditableProperties(messageClass, class'Message', propName) { filterProp = messageFilter.GetPropertyText(string(propName)); // If the property's not "empty" if (!(filterProp == "" || filterProp == "None" || filterProp == "0" || filterProp == "0.00")) { displayString = displayString $ ", " $ propName $ "=" $ filterProp; } } return displayString; } defaultproperties { bHidden = true enabled = true bNoDelete = true scriptType = TYPE_Normal cutscenePriority = 1.0 } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |