Frictional Game Wiki

<h1>Naming Convention</h1> <div class="level1"> </div> <h2>Level Editor</h2> <div class="level2"> <p> The following is an overview of how different game elements should be named when created inside the Level Editor. For anybody working for Frictional Games, this is a must. For all else, see it as guidelines to have consistent style, which is especially good if you want share your stuff. </p> <p> Remember also to look at existing code and try and copy the looks. </p> <p> NOTE: <u>Not all entities need to follow the naming convention</u>. In case of art assets and background elements, it is not mandatory. Object that have a gameplay role or that are called through script, though, should follow the naming convention. </p> </div> <h3>Entities</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0">Type </th><th class="col1">Style </th><th class="col2">Example </th><th class="col3">Info </th> </tr> </thead> <tr class="row1"> <td class="col0">Prop </td><td class="col1">[Name]{_Description}{_#} </td><td class="col2">Throne <br/> Pillar_Left <br/> Pot_Blue_12 </td><td class="leftalign"> </td> </tr> <tr class="row2"> <td class="col0">Item </td><td class="col1">Item_[Description]{_#} </td><td class="col2">Item_MagicSword </td><td class="col3">Item that the player can pick up (ends in Inventory) </td> </tr> <tr class="row3"> <td class="col0">Readable </td><td class="col1">Readable_[Description]{_#} </td><td class="col2">Readable_DeathNote </td><td class="col3">Item that the player can read (ends in Notes) </td> </tr> <tr class="row4"> <td class="col0">Actor </td><td class="col1">[Type]_[Description]{_#} </td><td class="col2">Monster_DarkCorridor <br/> Flesher_Patrol_2 </td><td class="leftalign"> </td> </tr> <tr class="row5"> <td class="col0">Blocker </td><td class="col1">Blocker_[Description]{_#} </td><td class="col2">Blocker_DoorFrame_2 </td><td class="col3">Entity used as boundary box </td> </tr> </table> <span class='np_break'> </span> </div> <p> <br/> </p> </div> <h3>Areas</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0">Type </th><th class="col1">Style </th><th class="col2">Example </th><th class="col3">Info </th> </tr> </thead> <tr class="row1"> <td class="col0">Start Position </td><td class="col1">Start{_DS}_[Location] </td><td class="col2">Start_Begin <br/> Start_Corridor <br/> Start_DS_MonsterNest </td><td class="col3">The first StartPos is always called Start_Begin <br/> Use DS for Death Scenarios </td> </tr> <tr class="row2"> <td class="col0">Trigger </td><td class="col1">Trigger_[Verb][Object] </td><td class="col2">Trigger_OpenPortcullis <br/> Trigger_ActivateMonster <br/> Trigger_StartSeq1 </td><td class="col3">Triggers are only considered as areas that trigger <br/> functions OnCollide and OnLookAt </td> </tr> <tr class="row3"> <td class="col0">Fog </td><td class="col1">FogArea_[#] </td><td class="col2">FogArea_14 </td><td class="leftalign"> </td> </tr> <tr class="row4"> <td class="col0">Death </td><td class="col1">DeathArea_[Location]{_#} </td><td class="col2">DeathArea_Chambers_1 <br/> DeathArea_Corridor </td><td class="leftalign"> </td> </tr> <tr class="row5"> <td class="col0">Sound Area </td><td class="col1">SoundArea_[Description] </td><td class="col2">SoundArea_RockFalls </td><td class="col3">Area (empty Trigger) used to position a sound <br/> created through script </td> </tr> <tr class="row6"> <td class="col0">Soundscape </td><td class="col1">Soundscape_[Description]{_#} </td><td class="col2">Soundscape_MedRoom_2 </td><td class="leftalign"> </td> </tr> <tr class="row7"> <td class="col0">Path Node </td><td class="col1">PathNode{_RouteName}_[#] </td><td class="col2">PathNode_2 <br/> PathNode_ChamberRoute_13 </td><td class="leftalign"> </td> </tr> <tr class="row8"> <td class="col0">Player Path </td><td class="col1">PlayerPath_[Location]_[#] </td><td class="col2">PlayerPath_Corridor_14 </td><td class="col3">Area (empty Trigger, not actual PathNodes) <br/> used to define a sequence of player's positions </td> </tr> <tr class="row9"> <td class="col0">Other Types </td><td class="col1">[AreaType]{_Description}_[#] </td><td class="col2">GhoulHole_Chambers_1 <br/> SpawnArea_4 </td><td class="leftalign"> </td> </tr> </table> <span class='np_break'> </span> </div> </div> <h3>Sounds</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0">Type </th><th class="col1">Style </th><th class="col2">Example </th><th class="col3">Info </th> </tr> </thead> <tr class="row1"> <td class="col0">Sound </td><td class="col1">Sound_[Description] </td><td class="col2">Sound_RockFalls </td><td class="col3">Mostly used for OneShot sounds </td> </tr> </table> <span class='np_break'> </span> </div> </div> <h3>Lights</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0">Type </th><th class="col1">Name </th><th class="col2">Example </th><th class="col3">Info </th> </tr> </thead> <tr class="row1"> <td class="col0">Any </td><td class="col1">Light{_Description}_[Type]_[#] </td><td class="col2">Light_Point_3 <br/> Light_Spot_14 <br/> Light_MonsterAppears_Point_2 </td><td class="col3">Allows for good use of wildcards </td> </tr> </table> <span class='np_break'> </span> </div> </div> <h3>Particle Systems</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0">Type </th><th class="col1">Style </th><th class="col2">Example </th><th class="col3">Info </th> </tr> </thead> <tr class="row1"> <td class="col0">Any </td><td class="col1">PS_[Description]{_#} </td><td class="col2">PS_CeilingCrumble </td><td class="leftalign"> </td> </tr> </table> <span class='np_break'> </span> </div> </div> <h2>Script</h2> <div class="level2"> <p> The following is an overview of how different game elements should be named when created inside a script. For anybody working for Frictional Games, this is a must. For all else, see it as guidelines to have consistent style, which is especially good if you want share your stuff. </p> <p> Remember also to look at existing code and try and copy the looks. </p> </div> <h3>Objects</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0">Type </th><th class="col1">Style </th><th class="col2">Example </th> </tr> </thead> <tr class="row1"> <td class="col0">Timer </td><td class="leftalign"><code>Timer_[Description]</code> </td><td class="leftalign"><code>Map_AddTimer("Timer_MonsterLeaves",3,"OnTimer_MonsterLeaves");</code> </td> </tr> <tr class="row2"> <td class="col0">Sound </td><td class="leftalign"><code>Sound_[Description]</code> </td><td class="leftalign"><code>Sound_CreateAtEntity("Sound_MonsterScream", …);</code> </td> </tr> <tr class="row3"> <td class="col0">Particle System </td><td class="leftalign"><code>PS_[Description]{_#}</code> </td><td class="leftalign"><code>ParticleSystem_CreateAtEntity("PS_CeilingCrumble", …);</code> </td> </tr> </table> <span class='np_break'> </span> </div> </div> <h3>Methods</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0">Type </th><th class="col1">Style </th><th class="col2">Example </th> </tr> </thead> <tr class="row1"> <td class="col0">Main Callbacks (Player) </td><td class="leftalign"><code>On[Verb][Object]_[Name]</code> </td><td class="leftalign"><code>OnCollideTrigger_DeactivateFog(){}</code> <br/> ​​​​​​<code>OnLookAtAgent_GhoulTunAway(){} <br/> OnInteractEntity_ConfigNote(){}</code> </td> </tr> <tr class="row2"> <td class="col0">Main Callbacks (Not Player) </td><td class="leftalign"><code>On[Subject][Verb][Object]_[Name]</code> </td><td class="leftalign"><code>OnEntityCollideTrigger_MakeLoudSound(){}</code> <br/> <code>OnAgentCollideTrigger_StartSequence(){}</code> </td> </tr> <tr class="row3"> <td class="col0">Death </td><td class="leftalign"><code>OnDeath_[Cause]</code> </td><td class="leftalign"><code>OnDeath_MonsterCorridor(){}</code> </td> </tr> <tr class="row4"> <td class="col0">Change State </td><td class="leftalign"><code>OnConnectionStateChange_[Object]</code> </td><td class="leftalign"><code>OnConnectionStateChange_PortcullisLever(){}</code> </td> </tr> <tr class="row5"> <td class="col0">End Of Track </td><td class="leftalign"><code>OnEndOfTrack_[MonsterName]</code> </td><td class="leftalign"><code>OnEndOfTrack_Monster_Corridor(){}</code> </td> </tr> <tr class="row6"> <td class="col0">Timer </td><td class="leftalign"><code>OnTimer_[TimerDescription]</code> </td><td class="leftalign"><code>OnTimer_MonsterLeaves(){}</code> </td> </tr> <tr class="row7"> <td class="col0">Sequence </td><td class="leftalign"><code>Seq_[Description]</code> </td><td class="leftalign"><code>Seq_CallElevator(){}</code> </td> </tr> <tr class="row8"> <td class="col0">Other </td><td class="leftalign"><code>[Object]_[Verb]</code> </td><td class="leftalign"><code>Corridor_SetupAfterDeath(){}</code> <br/> <code>Corpse_Reset(){}</code> <br/> <code>LeftPillar_Move(){} <br/> Monster_ClimbWindow(){}</code> </td> </tr> </table> <span class='np_break'> </span> </div> <p> <br/> </p> </div>