Frictional Game Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

<h1>Event Database</h1> <div class="level1"> </div> <h1>Basics</h1> <div class="level1"> <p> For events can be used in a map, the current scene name must be set. Do this in the OnEnter method of the map, and easiest is to use the helper function: <em>EventDB_SetCurrentScene(…)</em>. </p> <p> The best way to manage the events, is to keep the owners and scenes (and any global events) in a global file. And then load all other events per level in the OnEnter method (before setting the current scene). </p> <p> For the standard facts and triggers to work, EventDatabase/UseStandardTriggers must be set to true in game.cfg. </p> </div> <h1>Properties</h1> <div class="level1"> </div> <h2>Command String Formatting</h2> <div class="level2"> <p> For both Criteria and Actions (see below), a simple syntax must be used when setting up the values. The basic syntax is:<br/> [varname][operator][value]<br/> Examples: </p> <pre class="code">Velocity&gt;32 Velocity==3 MyName=Dennis Street='Downtown 78b' </pre><p> </p> <p> <span class='np_break'> </span> Two important things to note here:<br/> - You can use both "=" and "==" for comparing values.<br/> - When writing strings you can skip ' or " if there are no spaces in the string.<br/> </p> <p> Another way writing is:<br/> </p> <pre class="code">MyVariable </pre><p> </p> <p> <span class='np_break'> </span> <br/> This checks if the variable exists and is set to 1. If using it for an actions, it creates the variable and sets it to 1.<br/> this means that the follow statements are equal:<br/> </p> <pre class="code">IsAtHome IsAtHome=1 </pre><p> </p> <p> Any variables that do not exist get the value 0 at a check, so <br/> </p> <pre class="code">IsAtHome=0 </pre><p> </p> <p> <span class='np_break'> </span> <br/> is true even if the variable has never been set.<br/> </p> <p> To have many statements, simple just sepperate them by spaces, like: </p> <pre class="code">IsAtHome=0 Fuel&gt;25 LastNote='In the woods' </pre><p> </p> </div> <h2>Owner</h2> <div class="level2"> <p> Owner is where an event belongs. Is basically only there to easily subdivide and sort the events. </p> <p> <b>ID</b><br/> The id of the owner, this must be unique and mostly only be set by the tool and never exposed. </p> <p> <b>Name</b><br/> Name of the owner. </p> <p> <b>GroupFlags</b><br/> This is a bitflag container that can be used to set different owners into groups (and make it possible to send queries to owners of belonging to certain groups only). </p> </div> <h2>Scene</h2> <div class="level2"> <p> Scene is basically like owner, and yet another way to subdivide events. </p> <p> <b>ID</b><br/> The id of the scene, this must be unique and mostly only be set by the tool and never exposed. </p> <p> <b>Name</b><br/> Name of the scene. </p> </div> <h2>Event</h2> <div class="level2"> <p> The event is basically the important payload of the database. The following is a list of all properties of an event and what they do. </p> <p> <b>OwnerId</b><br/> The id of the owner connected to this event.<br/> </p> <p> <b>SceneId</b><br/> The id of the scene connected to this event. If -1 then this is a global event that will be check in every scene.<br/> </p> <p> <b>Trigger</b><br/> This is the trigger for this event. See below for some standard triggers. Triggers can also be user defined though (for instance as callback whena voice line is over). </p> <p> <b>Name</b><br/> The name of the event, only used to easier track-keeping. </p> <p> <b>Criteria</b><br/> This outlines the facts that need to be true for the event to happen. See "Command String Formatting" above for general info. Available operators are:<br/> </p> <pre class="code">== (=), >, >=, &lt;, &lt;=, != </pre><p> </p> <p> <span class='np_break'> </span> <br/> Also, it is possible to check intervals using the syntax:<br/> [varname] ( [min] [max] )<br/> and <br/> [varname] [ [min] [max] ]<br/> "()" includes the min/max into the interval (an open interval), and "[]" excludes the min,max (a closed interval). So for instances if the value is 0, then (0 10) is true, but [0 10] i false.<br/> Examples:<br/> </p> <pre class="code">Prisoners(1 4) Health[0.1 0.75] </pre><p> </p> <p> <b>Actions</b><br/> This outlines the actions made to the facts when the event is chosen in a query. See "Command String Formatting" above for general info. Available operators are:<br/> </p> <pre class="code">=, +=, -=, /=, *= </pre><p> </p> <p> <b>Output</b><br/> The output string, depends on the type of output. </p> <p> <b>OutputType</b><br/> This type is user defined, but the default types are:<br/> 0: A voice subject<br/> 1: A description. Output is a category and entry in the lang file.<em>Syntax: "[category] [entry]"</em><br/> 2: Script callback function. <em>Syntax: "[Output](const tString& in asEventName)"</em><br/> </p> <p> <b>OutputDelay</b><br/> How long (in sec) the output of the event happens. </p> <p> <b>MaxRepetitions</b><br/> The number of times an event can be repeated. 0 means unlimted number of times. Max number is 255. </p> </div> <h1>Standard Triggers</h1> <div class="level1"> <p> Standard trigger types that can be checked for in any map. Below the name are the facts that are related to the triggers. Note that these must be enabled (in Player or any other module that triggers them for them to happpen). </p> <p> <b>PlayerCollide</b><br/> <em>CollideEntity:</em> Entity that is collided with.<br/> If the player collides with an entity. Note that this one is not checked every update and might miss very brief collisions. Mostly useful to check if player is in an area. </p> <p> <b>PlayerLeaveCollide</b><br/> <em>CollideEntity:</em> Entity that player has collided with.<br/> Triggered when player stops colliding with an entity. Mostly useful to check if player leaves an area. </p> <p> <b>PlayerInteract</b><br/> <em>InteractEntity:</em> Entity that is interacted with.<br/> If the player interacts with an entity. Note that this is triggered through the basic script. </p> <p> <b>PlayerLookAt</b><br/> <em>LookAtEntity:</em> Entity that is look upon.<br/> <em>LookAtDistance:</em> The distance to the entity that is looked upon.<br/> <em>LookAtDuration:</em> The amount of time the player has looked at the entity.<br/> If the player looks at an entity. Note that this is called about every 0.5 secs or so while inside the gaze of the player. This the first time it was triggered it might have been out of range.<br/> Note that if you want to do this check on an area, make sure it has BlocksLineOfSight set to true! </p> <p> <b>VoiceLineOver</b><br/> <em>VoiceSubject:</em> The name of the subject, syntax = [Character]_[Scene]_[Subject], eg "Simon_00_01_Apartment_Greeting".<br/> <em>VoiceLine:</em> The name of the line, note that if line name is _ckgedit_QUOT<u>ckgedit>, then this will be the index, eg "0", "1", etc.<br/> When a voice line is over. <b>VoiceSoundOver</b><br/> <em>VoiceSubject:</em> The name of the subject, syntax = [Character]_[Scene]_[Subject], eg "Simon_00_01_Apartment_Greeting".<br/> <em>VoiceLine:</em> The name of the line, note that if line name is _ckgedit_QUOT</u>ckgedit>, then this will be the index, eg "0", "1", etc.<br/> <em>VoiceSoundIndex:</em> The index of the sound that was just completed.<br/> When a voice sound file is over. </p> <p> <b>VoiceIdle</b><br/> <em>VoiceIdleDuration:</em> The time the voice has been idle.<br/> <em>VoiceCharacterIdleDuration_[charater]:</em> The idle time for a specific character.<br/> Called every 3rd seconds when there is no voice playing. </p> </div> <h1>Standard Global Facts</h1> <div class="level1"> <p> The following are facts that are always accessible. Note that some of this are related to specific triggers, and should only use for these.<br/> </p> <p> <b>CollideEntity</b><br/> Contains the entity that spawned a <em>PlayerCollide</em> trigger. Also used by <em>PlayerLeaveCollide</em> and contain what the player used to collide with then. If player is not colliding with anything, it is _ckgedit_QUOT<u>ckgedit> (it is reset after the PlayerLeaveCollide trigger).<br/> Additional facts: <em>CollideEntityTag</em>, <em>CollideEntityInstanceTag</em>. These are the tag values from the entity. <b>InteractEntity</b><br/> Contains the latest entity that spawned a <em>PlayerInteract</em> (see above).<br/> Additional facts: <em>InteractEntityTag</em>, <em>InteractEntityInstanceTag</em>. These are the tag values from the entity. <b>LookAtEntity</b><br/> Contains the entity that spawned a <em>PlayerLookAt</em> trigger. If player is not looking at anything, it is _ckgedit_QUOT</u>ckgedit>.<br/> Additional facts: <em>LookAtEntityTag</em>, <em>LookAtEntityInstanceTag</em>, these are the tag values from the entity. <em>LookAtDistance</em>, this is the distance to the viewed object. <em>LookAtDuration</em>, how long the player has looked at the object. </p> <p> <b>VoiceSubject</b><br/> The last sound line that was over. Used by <em>VoiceLineOver</em> and <em>VoiceSoundOver</em> triggers. syntax = [Character]_[Scene]_[Subject], eg "Simon_00_01_Apartment_Greeting". </p> <p> <b>VoiceLine</b><br/> The last sound line that was over. Used by <em>VoiceLineOver</em> and <em>VoiceSoundOver</em> triggers. </p> <p> <b>VoiceSoundIndex</b><br/> The index of the sound that was over. Used by <em>VoiceSoundOver</em> trigger. </p> <p> <b>VoiceIsPlaying</b><br/> Is 1 if a voice is currently playing, else it is 0. </p> <p> <b>VoiceIdleDuration</b><br/> The amount of time since there was a voice playing (messured in whole seconds only). </p> <p> <b>VoiceCharacterIdleDuration_[charater]</b><br/> How long it has been since a certain character has spoken. [character] is simply the name of the character, eg: "VoiceCharacterIdleDuration_Jack". </p> <p> <b>EventIsQueued</b><br/> If an event has been chosen but has not be been activated (meaning outputdelay time is not yet reached) this will be 1, else 0. </p> </div> <h1>Custom Facts and Triggers</h1> <div class="level1"> <p> Custom triggers can currently be made in two ways: </p> <ol> <li class="level1"> To call the Query or QuertToAll in the EventDatabase. This will let you choose the name any name at all for a trigger.</li> <li class="level1"> Using the EventCallbackTrigger property for a Voice Line, this will query the event database when the line has finshsed playing.</li> </ol> <p> To set your own facts (apart from setting them in action part of an event), you can call the SetFactXXX functions that exist in either cMap or in the cEventDatabaseHandler. If set in cMap, the fact will be local and only last the current map. Else it will be global and last for the entire game. </p> <p> The helper file "helper_eventdb.hps" contains helper functions for all of the above. </p> </div> <h1>File format</h1> <div class="level1"> <p> Events can be added in code, but it is almost always better to use the files to define them. An event database file is in XML and has the extension "event". The general format is like this: </p> <pre class="code xml">< EventDatabaseData> < Owners> < Owner [Properties] /> ... < /Owners> < Scenes> < Scene [Properties] /> ... < /Scenes> < Events> < Event[Properties] /> ... < /Events> < /EventDatabaseData> </pre><p> </p> <p> For information on the Properties that can be used, see Properties section above. </p> </div>