Frictional Game Wiki

<h1>New Scripts</h1> <div class="level1"> <p> Many scripts from TDD work in MFP, but some of them have been removed (e.g. SetInventoryDisabled).<br/> However, MFP has a set of its own new scripts, which are listed below. </p> <p> <span style = "color:#FF0000"><span style = "font-size:inherit"><span style = "font-family:inherit"><span style = "background-color:inherit"><em> This list might be incomplete. You can contribute by going through original MFP .hps files and listing any new scripts ("new" meaning: not a TDD script and not a function which is declared in the same file). </em></span></span></span></span> </p> <p> <span style = "color:#FF0000"><span style = "font-size:inherit"><span style = "font-family:inherit"><span style = "background-color:inherit"><em> You can also contribute by testing the untested functions or function arguments with uncertain usage. </em></span></span></span></span> </p> </div> <h2>Player</h2> <div class="level2"> <pre class="code">void SetLanternFlickerActive(bool abActive); </pre><p> </p> <p> Enables the lantern flicker effect. </p> <p> <em>abActive </em>- set to true to enable the effect </p> <pre class="code">void SetPlayerInfection(float afAmount); void AddPlayerInfection(float afAmount); float GetPlayerInfection(); </pre><p> </p> <p> Infection related scripts. </p> </div> <h2>Screen effects</h2> <div class="level2"> <pre class="code">void ShowScreenImage(string asImage, int alPosX, int alPosY, float afUnknown, bool abUnknown2, float afTime, float afFadeIn, float afFadeOut); </pre><p> </p> <p> Displays an image on the screen. Originally used to show the MFP logo in-game. </p> <p> <em>asImage </em>- the image to display. E.g. <code>startup_aamfp_logo.jpg</code> <br/> alPosX - horizontal position of the image. 0 is right screen border, smaller values are left. -400 was used for the middle of the screen.<br/> <em>alPosY </em>- vertical position of the image. 0 is bottom, smaller values are up. -350 was used for the middle of the screen.<br/> <em>afUnknown </em>- Unless set to below 0, the image won't appear. Might have more functionality to it.<br/> <em>abUnknown2 </em>- setting this to true makes the image not appear. Might have more functionality to it.<br/> <em>afTime </em>- image display time.<br/> <em>afFadeIn </em>- fade in time. It's added to the base display time.<br/> <em>afFadeOut </em>- fade out time. It's added to the base display time. </p> </div> <h2>Enemies</h2> <div class="level2"> <pre class="code">void SetEnemyMoveType(string &in asEnemy, string asMoveType); </pre><p> </p> <p> <b><img src="/lib/exe/fetch.php?w=15&h=15&tok=d42258&media=http%3A%2F%2Fwiki.frictionalgames.com%2Flib%2Fimages%2Fsmileys%2Ficon_question.gif" class="media" alt="" width="15" height="15" />This script has been tested, but yielded no results.</b> </p> <p> Sets the enemy move type. This applies to ???; Patrol move type is set in the LevelEditor. </p> <p> <em>asEnemy </em>- the in-game enemy entity </p> <p> <em>asMoveType </em>- options include: WalkBiped, RunBiped, ChargeBiped, and probably Quadruped variations as well. </p> <pre class="code">void AddEnemyPatrolNode(string& asName, string& asNodeName, float afWaitTime, string& asAnimation, bool abContinue); </pre><p> </p> <p> Adds a patrol node to the enemy's path. It has an additional argument when compared to TDD. </p> <p> <em>asName </em>- internal name of the enemy<br/> <em>asNodeName </em>- path node<br/> <em>afWaitTime </em>- time in seconds that the enemy waits at the path node before continuing<br/> <em>asAnimation </em>- the animation the enemy uses when reaching the path node<br/> abContinue - if false, the enemy will stop at the last patrolnode indefinitely(?) </p> <pre class="code">void SetManPigType(string &in asEntity, string &in asType); </pre><p> </p> <p> <b><img src="/lib/exe/fetch.php?w=15&h=15&tok=d42258&media=http%3A%2F%2Fwiki.frictionalgames.com%2Flib%2Fimages%2Fsmileys%2Ficon_question.gif" class="media" alt="" width="15" height="15" />This script hasn't been tested.</b> </p> <p> Seems to alter the enemy AI. It was mostly used in conjunction with Child enemies (but also with Wretches). </p> <p> <em>asEntity </em>- the enemy in question. Can be Enemy_ManPig or Enemy_Child type. </p> <p> <em>asType </em>- only "Freddy" has been used in the entire game. It is unknown whether other options work. </p> <p> From Peter Howell's PhD paper^{<a href="#fn__1" id="fnt__1" class="fn_top">1)</a>} : </p> <p> <em>"The initial design of the game’s enemy artificial intelligence system contained three unique sets of behavioural controls. […] every enemy agent in the game would be assigned one of three possible ‘personalities’, referred to in the game’s code as the ‘Rod’, ‘Jane’ and ‘Freddy’ personality types."</em> </p> <p> <em>Overview of proposed enemy agent personality types and key behavioural traits (Pre-Development, December 2011):</em> </p> <p> <b>‘Rod’:</b> </p> <p> • Will maintain a ‘safe’ distance from the player-character.<br/> • If unable to do so, will approach player character, investigate them (by getting close and smelling them), before continuing its patrol. </p> <p> <b>‘Jane’:</b> </p> <p> • Will maintain a ‘safe’ distance from player-character, whilst observing the player-character’s movements.<br/> • If unable to maintain ‘safe’ distance, will panic and flee.<br/> • If cornered and unable to flee, will attack and knock player-character to floor, then flee.<br/> • Will only attack and kill player-character as a last resort. </p> <p> <b>‘Freddy’</b> </p> <p> • Will actively hunt the player-character.<br/> • Will attack and kill them if given the opportunity. </p> <p> <a href="https://researchportal.port.ac.uk/portal/files/3364888/PeterHowell_PhD.pdf" class="urlextern" title="https://researchportal.port.ac.uk/portal/files/3364888/PeterHowell_PhD.pdf" rel="nofollow">Source</a> </p> </div> <h2>Other</h2> <div class="level2"> <pre class="code">void SetParticleSystemActive(string &in asParticle, bool abX); </pre><p> </p> <p> "Freezes" a particle (meaning, the last texture will linger). </p> <p> Manual particle optimising might have been the intended usage. It was seen used next to <em>SetPhysicsAutoDisable</em>.<br/> Another apparent usage is to place an inactive particle in the map and activate it when convenient (which might be a simpler way than <em>CreateParticleSystemAtEntity</em>) </p> <p> <em>asParticle </em>- the particle in question </p> <p> <em>abX </em>- whether to freeze or unfreeze the particle </p> <pre class="code">void AddHint(string &in asEntryName, string asUnknown); </pre><p> </p> <p> Adds a journal entry in the "My Journal" category. </p> <p> ui_add_quest.snt is played, but MFP has only silence in those sounds. </p> <p> <em>asEntryName -</em> entries the lang file.<br/> Like Notes, it must consist of two actual entries: <em>Hint_EntryName_Name </em> and <em>Hint_EntryName_Text</em>. Both must be in the "Journal" category.<br/> See english.lang for examples. </p> <p> <em>asUnknown - </em> this argument was never used. It always contained an empty string. Writing in it doesn't yield any error messages or log entries. </p> <pre class="code c++">SetLightVisible<span class="br0">(</span>string<span class="sy0">&</span> asLightName<span class="sy0">,</span> bool abVisible<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Enables/disables lights. Works with all 3 light types. </p> <p> <em>asLightName </em>- internal light name<br/> <em>abVisible </em>- determines the state of the light </p> <pre class="code">void SetPhysicsAutoDisable(string &in asEntity, bool abX); </pre><p> </p> <p> <b><img src="/lib/exe/fetch.php?w=15&h=15&tok=d42258&media=http%3A%2F%2Fwiki.frictionalgames.com%2Flib%2Fimages%2Fsmileys%2Ficon_question.gif" class="media" alt="" width="15" height="15" />This script has been tested, but yielded no results.</b> </p> <p> Unknown usage. Using it doesn't seem to have an effect on movement or collission. </p> <p> It seems to be used for optimising, so it might be something that only happens when the player is far from the object (not looking at it still makes it behave normally). </p> <p> <em>asEntity </em>- entity in question. It was used only with chandelier_nice. </p> <p> <em>abX </em>- whether to disable the object physics (<em>when?</em>). </p> </div> <div class="footnotes"> <div class="fn">^{<a href="#fnt__1" id="fn__1" class="fn_bot">1)</a>} "Disruptive Game Design: A Commercial Design and Development Methodology for Supporting Player Cognitive Engagement in Digital Games", Peter Howell, 2015</div> </div>