Divinity Engine Wiki - User contributions [en]

https://docs.larian.game/api.php?action=feedcontributions&feedformat=atom&user=LarIlya Divinity Engine Wiki - User contributions [en] 2026-04-19T21:18:13Z User contributions MediaWiki 1.41.0 https://docs.larian.game/index.php?title=Voice_Bark_editor&diff=6667 Voice Bark editor 2019-09-17T15:07:59Z

<p>LarIlya: </p> <hr /> <div>== The voicebark editor ==<br /> Voicebarks are a system to play an automated dialog for party members, selected based on their tags. This means that in itself, a voicebark is not a dialogue. Rather, it is a set of rules by which an AD can be selected for the player characters to speak.<br /><br /> <br /><br /> [[File:VBEditor.png|1400px]]<br /> <br /><br /> When a voicebark is played from a character (typically, with the [[Osiris/API/StartVoiceBark|StartVoiceBark]] Story call or [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|behaviour script]] call), the system selects the first (topmost) AD for which it can find appropriate speakers (having all of the tags in the 'Allow' column and none in the 'Deny column'), and plays that AD with those speakers. Note that, if their companions have tags which are preferred over that character's own, the character from whom the voicebark originates (the 'target character') will not be part of the selected AD. To be considered, speakers need to be:<br /> * Player characters<br /> * In the same party as the target character<br /> * Within 10 meters of the target character<br /> * Not summons or party followers<br /> * Not already in a dialog<br /> * Not a ghost<br /> * Not charmed<br /> * Alive<br /> * Visible and not sneaking<br /> * On-stage<br /> No AD is started if the requested Voicebark does not exist, if the target character is not a player or does not exist, or if no set of fitting characters is found. Story will get a [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] event. Otherwise, a [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]] event is sent, along with the usual events that accompany the start of an AD.</div>

LarIlya https://docs.larian.game/index.php?title=Osiris_Overview&diff=6508 Osiris Overview 2019-02-04T12:50:16Z

<p>LarIlya: /* Rule Evaluation State */</p> <hr /> <div>= Introduction =<br /> Osiris is a mostly declarative programming language, similar to [https://en.wikipedia.org/wiki/Prolog Prolog] in some ways. While it is somewhat counter-intuitive at first if you are not used to declarative programming, the language itself is quite simple and only has a few constructs. Its power mainly stems from its access to a very large number of [[:Category:Osiris_APIs|APIs]] (note: work-in-progress; there are 879 Osiris APIs at the time of writing). These APIs allow you to react to things that happen ([[:Category:Osiris_Events|events]]), to obtain information about the current game state ([[:Category:Osiris_Queries|queries]]), and to change the game state ([[:Category:Osiris_Calls|calls]]).<br /> <br /> If you are familiar with databases, you can think of an Osiris program as a collection of rules that operate on a single, game-wide database. The rules dynamically add and remove tables and rows in reaction to other database entries getting modified. Additionally, they can also react to game state changes, query the game state, and change the game state. Note that the tables are actually referred to as "databases" in Osiris, so below we will talk about defining databases rather than tables. Adding a row to a table is generally referred to as "defining a fact", although "defining a database" or "defining a database entry" is also used from time to time.<br /> <br /> Here is an example Osiris code fragment:<br /> <pre><br /> INIT<br /> DB_MyPrefix_Fruit("Apple"); // Defines the database DB_MyPrefix_Fruit with one column of type STRING, and adds a fact consisting of the string "Apple" to it.<br /> DB_MyPrefix_Fruit("Pear"); // Adds another fact to the DB_MyPrefix_Fruit database.<br /> DB_MyPrefix_Fruit("Banana"); // And one more.<br /> KB<br /> IF // Osiris rules always start with IF<br /> DB_MyPrefix_Fruit(_SomeFruit) // This rule will fire when any database with the name "DB_MyPrefix_Fruit" gets defined.<br /> // The name of the fruit will be stored in (bound to) the _SomeFruit variable.<br /> THEN // "THEN" indicates that the rule conditions have finished, and the rule actions follow.<br /> DB_MyPrefix_AtLeastOneFruit(1); // We define a new database with the name "DB_MyPrefix_AtLeastOneFruit" and type INTEGER,<br /> // and add a fact with the integer value 1 to it. Since there are three rows in the<br /> // DB_MyPrefix_Fruit database, this action will execute three times. However, as the value<br /> // is always the same (1), in the end the DB_MyPrefix_AtLeastOneFruit database will<br /> // contain only a single fact, which consists of the value 1.<br /> <br /> IF<br /> DB_MyPrefix_Fruit("Pear") // This rule will fire when DB_MyPrefix_Fruit("Pear") gets defined.<br /> AND // Osiris rule conditions can only be combined with AND, not with OR. There is<br /> // another ways to implement OR-conditions though, explained below (user-defined queries).<br /> NOT DB_MyPrefix_Fruit("Lemon") // This rule's actions will only execute if no DB_MyPrefix_Fruit("Lemon") entry exists.<br /> THEN<br /> DB_MyPrefix_PearNoLemon(1);<br /> <br /> EXIT<br /> NOT DB_MyPrefix_Fruit("Apple"); // Remove the "Apple" fact from the DB_MyPrefix_Fruit when the goal completes.<br /> NOT DB_MyPrefix_Fruit("Pear"); // Removing databases that are no longer used anywhere else after a goal completes<br /> NOT DB_MyPrefix_Fruit("Banana"); // reduces savegame sizes and speeds up the game.<br /> <br /> NOT DB_MyPrefix_AtLeastOneFruit(1); // Even if some of these databases would not exist, removing them would not result<br /> NOT DB_MyPrefix_AtLeastOneFruit(1); // in an error. Removing a non-existent database is simply ignored.<br /> </pre><br /> <br /> Note that you do not type '''INIT''', '''KB''' and '''EXIT''' in the [[Story_editor|story editor]]. These sections are represented by the separate panes that you see when opening a goal for editing.<br /> <br /> = Program Structure =<br /> An Osiris program is called a '''''Story'''''. A story consists of all (story) '''''Goals''''' for the current mod and its dependencies. E.g., the main game mod (DivinityOrigins) depends on the Shared mod, so the story of the main game includes all goals from both mods.<br /> <br /> A goal is a plain text file with three sections:<br /> ; INIT : The INIT section contains [[#Actions|actions]] that are executed when the goal [[#Goal_Initialisation_and_Completion|initialises]].<br /> ; KB : The KB section, or knowledge base, contains [[#Rules|rules]] that become active as soon as the goal starts [[#Goal_Initialisation_and_Completion|initialising]]. This means that the rules in the KB section can react to changes made in the INIT section of the same goal. The KB section cannot contain [[#Actions|actions]] outside rule bodies.<br /> ; EXIT : The EXIT section contains [[#Actions|actions]] that are executed when the goal [[#Goal_Initialisation_and_Completion|completes]].<br /> <br /> == Types ==<br /> Osiris supports ten different types:<br /> ; INTEGER : A 32-bit integer number. Examples: -4, 0, 10.<br /> ; INTEGER64 : A 64-bit integer number. Examples: -99999999999, -4, 0, 10, 12345678901.<br /> ; REAL : A single precision floating point number. Examples: -10.0, -0.1, 0.0, 0.5, 100.123.<br /> ; STRING : A character string. Examples: "A", "ABC", "_This is a string_".<br /> ; GUIDSTRING : A [https://en.wikipedia.org/wiki/Guid GUID] that refers to an object, or sometimes [[Modding:_Root_templates|root template]], in the game. This object can be any of the specialised GUID-types below. Examples: 123e4567-e89b-12d3-a456-426655440000, MyObjectName_123e4567-e89b-12d3-a456-426655440000, CHARACTERGUID_MyObjectName_123e4567-e89b-12d3-a456-426655440000. Osiris in fact only uses the GUID itself. Anything before it (as long as it does not contain "-") gets ignored by the compiler, and is only there to improve the readability of the code. This ensures that if you rename an object in game, its related scripting won't break.<br /> ; CHARACTERGUID : A GUIDSTRING referring to a [[Entity_types|character]] object in the game. Examples: (CHARACTERGUID)123e4567-e89b-12d3-a456-426655440000, (CHARACTERGUID)MyObjectName_123e4567-e89b-12d3-a456-426655440000, (CHARACTERGUID)CHARACTERGUID_MyObjectName_123e4567-e89b-12d3-a456-426655440000<br /> ; ITEMGUID : A GUIDSTRING referring to an [[Entity_types|item]] object in the game. <br /> ; TRIGGERGUID : A GUIDSTRING referring to a [[Entity_types|trigger]] object in the game. <br /> ; SPLINEGUID : A GUIDSTRING referring to a [[Entity_types|spline]] object in the game. <br /> ; LEVELTEMPLATEGUID : A GUIDSTRING referring to a [[Entity_types|level template]] object in the game. <br /> <br /> The specialised GUID-types all inherit from GUIDSTRING, and you can cast a GUIDSTRING to any of the specific types by adding ''(ITEMGUID)'' and the like in front of it. Note that while [[Story_editor#Code_editing_helper_functionality|code-completion]] will prepend the object type to the object name in the form of ''ITEMGUID_'', this does ''not'' define or change the type in any way to the Osiris compiler.<br /> <br /> {{warning|When you wish to refer to objects/local instances from script or elsewhere, make sure to follow the [[Templates_explanation#Local_instances.2Ftemplates|correct naming convention]].}}<br /> <br /> == Databases ==<br /> Osiris '''''databases''''' consist of a database name, which must start with ''DB_'', and one or more [[#Types|typed]] columns. As there is only one namespace (= all database names defined in all goals from all mods must be unique), it is a good idea to follow the ''DB_'' by a prefix that is unique to your mod or goal. Every entry that gets added to a database is called a '''''fact'''''. The structure of a fact definition is<br /> '''DB_'''''Prefix_DatabaseName'''''('''''TypedValue1''[''','''''TypedValue2''..]''');'''<br /> <br /> Examples:<br /> <pre><br /> // Type: String<br /> DB_Overview_StringDB("SomeString");<br /> DB_Overview_StringDB("AnotherString");<br /> <br /> // Type: float<br /> DB_Overview_FloatDB(1.0);<br /> <br /> // Type: Integer, String<br /> DB_Overview_IntegerStringDB(0, "String0");<br /> DB_Overview_IntegerStringDB(1, "String1");<br /> DB_Overview_IntegerStringDB(1, "String1");<br /> <br /> // Type: GUIDSTRING (not CHARACTERGUID, because no typecast)<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f);<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Beast_f25ca124-a4d2-427b-af62-df66df41a978);<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Lohse_bb932b13-8ebf-4ab4-aac0-83e6924e4295);<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_RedPrince_a26a1efb-cdc8-4cf3-a7b2-b2f9544add6f);<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Sebille_c8d55eaf-e4eb-466a-8f0d-6a9447b5b24c);<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Fane_02a77f1f-872b-49ca-91ab-32098c443beb);<br /> <br /> // Type: CHARACTERGUID, String<br /> DB_Overview_Origins((CHARACTERGUID)CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f, "IFAN");<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Beast_f25ca124-a4d2-427b-af62-df66df41a978, "BEAST");<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Lohse_bb932b13-8ebf-4ab4-aac0-83e6924e4295, "LOHSE");<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_RedPrince_a26a1efb-cdc8-4cf3-a7b2-b2f9544add6f, "RED PRINCE");<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Sebille_c8d55eaf-e4eb-466a-8f0d-6a9447b5b24c, "SEBILLE");<br /> DB_Overview_Origins(CHARACTERGUID_S_Player_Fane_02a77f1f-872b-49ca-91ab-32098c443beb, "FANE");<br /> </pre><br /> <br /> As the last example shows it is possible to overload databases: you can have multiple databases with the same name. The only requirement is that they have a different number columns (parameters). Also note that this last example only includes a ''(CHARACTERGUID)'' typecast for the first row. That is sufficient because the compiler uses the first occurrence of a database in story to determine the types. It will then typecast the values in any further occurrences of this database to the type it determined from the first declaration. Since a GUIDSTRING can be typecasted into a CHARACTERGUID, this works fine here. This is an important rule to keep in mind, as it is a frequent source of type errors when you're just starting out.<br /> <br /> Removing database facts can be done using the NOT-operator:<br /> <pre><br /> NOT DB_Overview_StringDB("SomeString");<br /> NOT DB_Overview_StringDB("AnotherString");<br /> </pre><br /> <br /> == Rules ==<br /> A '''''Rule''''' consist of one or more [[#Trigger_Conditions|trigger conditions]], a number of optional [[#Extra_Conditions|extra conditions]], and finally one or more [[#Actions|actions]]. A rule is evaluated whenever one of its trigger conditions get becomes fulfilled. If all trigger and extra conditions are fulfilled at that point, the actions of this rule are executed.<br /> <br /> The structure of a rule is as follows:<br /> '''IF'''<br /> ''TriggerCondition''<br /> [<br /> '''AND'''<br /> ''TriggerCondition | ExtraCondition''<br /> ]<br /> [<br /> '''AND'''<br /> ''TriggerCondition | ExtraCondition''<br /> ..<br /> ]<br /> '''THEN'''<br /> ''Action1''''';'''<br /> [<br /> ''Action2''''';'''<br /> ..<br /> ]<br /> <br /> You can have multiple rules that check on the same trigger conditions. They will all be executed when the trigger conditions are satisfied.<br /> <br /> === Trigger Conditions ===<br /> There are two categories of trigger conditions:<br /> ; Osiris Event : The game informs Osiris that a particular [[:Category:Osiris_Events|event]] has occurred. '''Warning''': an event can only be used as the '''''first''''' trigger condition. Putting it at any other place in a rule condition will result in a compilation error.<br /> ; Database : A new database fact has been ''added''. ''Removing'' a database fact can be a trigger condition, but not the first one. Database fact trigger conditions can appear anywhere in a condition.<br /> <br /> Note that you can check multiple databases as part of your trigger conditions, and the rule's trigger conditions will be considered as fulfilled as soon as all database checks succeed. Example:<br /> <br /> <pre><br /> IF<br /> DB_IsPlayer(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition<br /> AND<br /> DB_Dead(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition<br /> THEN<br /> DB_IfanIsDeadAsAPlayer(1);<br /> </pre><br /> <br /> This rule will trigger when ''DB_IsPlayer()'' is defined for Ifan first and then his ''DB_Dead()'', but also if they are defined in the opposite order. Second example:<br /> <br /> <pre><br /> IF<br /> DB_IsPlayer(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition<br /> AND<br /> NOT DB_Dead(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition<br /> THEN<br /> DB_IfanIsAliveAsAPlayer(1);<br /> </pre><br /> <br /> This rule will trigger when ''DB_IsPlayer()'' is defined for Ifan while no ''DB_Dead()'' fact was defined for him. However, it will also trigger if initially both ''DB_IsPlayer()'' and ''DB_Dead()'' were defined for him, and later on the ''DB_Dead()'' fact gets removed.<br /> <br /> === Extra Conditions ===<br /> Extra conditions are any conditions that are checked as part of a rule, but that are not trigger conditions:<br /> ; Osiris Query : Osiris can [[:Category:Osiris_Queries|query]] the game engine about many aspects of the current game state, or the state of an object.<br /> ; User Query : You can also define [[#Queries|your own queries]] in Osiris. This way you can implement OR-conditions.<br /> ; Comparison: You can use the comparison operators '''==''' (equals), '''!=''' (different), '''<=''', '''<''', '''>''' and '''>=''' as a condition. [[#Types|GUIDSTRING]] and its descendent types can only be compared for (non-)equality, while the other types can also be used with the other comparison operators.<br /> ; Any condition following a [[:Category:Osiris_Events|game engine event]] : Events are sent by the game engine to Osiris whenever specific things happen (a character dies, and item has been picked up, ...). Only when this happens, the extra conditions below that event get checked.<br /> <br /> Examples:<br /> <pre><br /> IF<br /> CharacterDied(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition<br /> AND<br /> NOT DB_IsPlayer(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Extra condition<br /> THEN<br /> DB_IfanDiedAsAPlayer(1);<br /> </pre><br /> In this case, ''DB_IfanDiedAsAPlayer(1)'' will only be defined if the ''CharacterDied'' event arrives while Ifan was not in the ''DB_IsPlayer'' database. If you remove him from that database after he died the rule will not re-evaluated, because only the ''CharacterDied'' event is part of the trigger conditions (and this event will not be sent again if he is already dead).<br /> <br /> <pre><br /> IF<br /> DB_IsPlayer(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition<br /> AND<br /> CharacterIsDead(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f, 0) // Extra condition<br /> AND<br /> DB_Avatars(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition (!)<br /> THEN<br /> DB_IfanIsAnAvatarPlayerAndNotDead(1);<br /> </pre><br /> <br /> ''CharacterIsDead'' is a query that takes two parameters: a CHARACTERGUID and an integer. The integer indicates whether the character is dead (1) or not (0). If all parameters match, the query condition will succeed. This means that the above rule succeeds in case ''CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f'' is not dead at the time he first appears in both the ''DB_IsPlayer'' and ''DB_Avatars'' databases. As mentioned earlier, it does not matter in which order he gets added to these databases. As soon as both facts are defined, the rule triggers and the extra condition(s) will be evaluated. If these extra conditions succeed, the actions in the rules section will be executed.<br /> <br /> On the other hand, if both database facts would already be defined and then Ifan gets resurrected (so '''CharacterIsDead(IFan, 0)''' would now succeed if it were called), the rule will not trigger. The reason is that it only get (re)evaluated when all of the trigger conditions become fulfilled (in this case, Ifan gets added to both databases). This also demonstrates the main difference between queries and events:<br /> * Events are triggered when the game state changes, but you cannot call them yourself.<br /> * Queries allow you to request information about the game state at any point, but they never get automatically triggered/(re)evaluated.<br /> <br /> === Actions ===<br /> All statements in the '''INIT''' and '''FINI''' sections must be actions. Additionally, at the end of a [[#Rule|rule]] you must also put at least one action. Every action ends in a semi-colon (''';''').<br /> <br /> Actions can make changes to both the Osiris program state and the game state:<br /> ; Osiris Call : Osiris can [[:Category:Osiris_Calls|call]] into the game engine to perform all kinds of changes to the current game state, either globally or specific to certain objects.<br /> ; Procedure : You can group conditions and actions in a [[#Procedures|procedure]] and call that from multiple locations.<br /> ; Database : As shown in the examples above, a new database fact can be added in an action by placing it there, followed by a semi-colon. You can also remove database facts by prepending them with '''NOT'''.<br /> <br /> Example:<br /> <pre><br /> IF<br /> DB_IsPlayer(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f) // Trigger condition<br /> AND<br /> CharacterIsDead(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f, 1) // Extra condition<br /> THEN<br /> CharacterResurrect(CHARACTERGUID_S_Player_Ifan_ad9a3327-4456-42a7-9bf4-7ad60cc9e54f);<br /> </pre><br /> <br /> If Ifan is added to the ''DB_IsPlayer'' database while he was already dead, he will be resurrected.<br /> <br /> == Variables ==<br /> All previous examples use concrete values to define and test database contents. However, in many cases you do not know the actual value, or you want a rule to be more general. In this case, you use variables. Like in most declarative programming languages, you do not declare these variables. Their type is defined by their first use, and their lifetime and scope is always limited to a single rule, [[#Procedures|procedure]] or [[#Query|query]].<br /> <br /> Example:<br /> <pre><br /> IF<br /> DB_IsPlayer(_Player)<br /> AND<br /> CharacterIsDead(_Player, 1)<br /> THEN<br /> CharacterResurrect(_Player)<br /> </pre><br /> Rather than only resurrecting Ifan in case he is dead when he gets added to the ''DB_IsPlayer'' database, any dead character that gets added to the ''DB_IsPlayer'' database will be resurrected at that point.<br /> <br /> More powerful uses of variables are demonstrated in the section on [[#Rule_Matching|Rule Matching]] below.<br /> <br /> == Subroutines ==<br /> <br /> There are two kinds of user-defined subroutines in Osiris: queries and procedures.<br /> <br /> === Queries ===<br /> Queries are new compared to DOS1. They are very handy to implement OR-conditions. The format of a query is:<br /> '''QRY'''<br /> ''QRY_MyPrefix_QueryName'''''(('''''TYPE1''''')'''''_Param1''[''',('''''TYPE2''''')'''''_Param2..'']''')'''<br /> [<br /> '''AND'''<br /> ''ExtraCondition1''<br /> ..<br /> ]<br /> '''THEN'''<br /> ''Action1''''';'''<br /> [<br /> ''Action2''''';'''<br /> ..<br /> ]<br /> <br /> Just like databases, queries can be overloaded with different numbers of parameters. And just like with [[#Rules|rules]], you can define the same query multiple times and every definition of that same query will be executed when it is called. When a user-defined query is called in a rule, it is considered to have succeeded if all conditions of at least one definition of this query succeeded (and hence its actions were executed).<br /> <br /> Example:<br /> <pre><br /> QRY<br /> QRY_Overview_CharacterIsIncapacitated((CHARACTERGUID)_Char)<br /> AND<br /> HasActiveStatus(_Char,"FROZEN",1)<br /> THEN<br /> DB_NOOP(1);<br /> <br /> QRY<br /> QRY_Overview_CharacterIsIncapacitated(_Char)<br /> AND<br /> HasActiveStatus(_Char,"PETRIFIED",1)<br /> THEN<br /> DB_NOOP(1);<br /> <br /> QRY<br /> QRY_Overview_CharacterIsIncapacitated(_Char)<br /> AND<br /> HasActiveStatus(_Char,"KNOCKED_DOWN",1)<br /> THEN<br /> DB_NOOP(1);<br /> <br /> IF<br /> CharacterReceivedDamage(_Char)<br /> AND<br /> // check whether _Char is FROZEN, PETRIFIED or KNOCKED_DOWN<br /> QRY_Overview_CharacterIsIncapacitated(_Char)<br /> THEN<br /> DB_Overview_CowardAttackingIncapacitatedCharacter(1);<br /> </pre><br /> <br /> Our ''QRY_Overview_CharacterIsIncapacitated'' query does not actually need to do anything if its conditions succeed. However, you cannot have condition checks without an action. For this reason, we define a dummy database fact (''DB_NOOP(1)'' by convention) if all rules succeed. So, when our rule calls ''QRY_Overview_CharacterIsIncapacitated(_Char)'', Osiris will evaluate all definitions of this query in the entire story (so not just in the current [[#Program_Structure|goal]]!) and if one of them succeeds, it will consider this query/extra condition to have succeeded.<br /> <br /> Just like with databases, only the first encountered definition of a query needs to specify the parameter type(s). It does not hurt to repeat them though. You can also see that parameters use the same syntax as [[#Variables|variables]].<br /> <br /> Note that Osiris has a [[Osiris/API/CharacterIsIncapacitated|built-in query]] to check whether a character is incapacitated (which checks more statuses than the ones listed above), so you won't need to implement the above query yourself.<br /> <br /> === Procedures ===<br /> Procedures are collections of actions that you may want to execute from multiple action blocks. Or, they may be a number of related actions of which some must only be executed under certain conditions. In this sense, they allow you to have extra condition checks in an action block.<br /> <br /> The format of a procedure is:<br /> '''PROC'''<br /> ''PROC_MyPrefix_ProcName'''''(('''''TYPE1''''')'''''_Param1''[''',('''''TYPE2''''')'''''_Param2..'']''')'''<br /> [<br /> '''AND'''<br /> ''ExtraCondition1''<br /> ..<br /> ]<br /> '''THEN'''<br /> ''Action1''''';'''<br /> [<br /> ''Action2''''';'''<br /> ..<br /> ]<br /> <br /> Just like with queries, you can have multiple definitions of the same procedure (even in different [[#Program_Structure|goals]]). When you invoke a procedure, all of those procedures will be executed. Unlike queries, procedures have no result, since statements in an action block do not return anything.<br /> <br /> Example:<br /> <pre><br /> PROC<br /> PROC_Overview_TeleportAlive((CHARATERGUID)_Char, (GUIDSTRING)_Destination)<br /> AND<br /> CharacterIsDead(_Char, 1)<br /> THEN<br /> CharacterResurrect(_Char);<br /> <br /> PROC<br /> PROC_Overview_TeleportAlive(_Char, _Destination)<br /> THEN<br /> TeleportTo(_Char, _Destination);<br /> </pre><br /> <br /> This procedure will first check whether the character to be teleported is dead. If so, the character will be resurrected. Next, the character (which is guaranteed to be alive now) is teleported to its destination, which can be a trigger, item, or other character.<br /> <br /> This way you can check extra conditions in an actions block, by delegating the checks to a procedure.<br /> <br /> = Program Execution =<br /> Osiris execution is completely event-driven:<br /> * Rules can only be triggered when an event is thrown, or when a database is defined by the action block of a procedure, user query or rule<br /> * Procedures and user queries can only be called from action blocks of other procedures, user queries or rules.<br /> <br /> This means that there is no ''main'' or other procedure at which an Osiris story (= program) starts executing. Story merely reacts to events thrown by the game engine and actions by the player in the game world. That said, the game engine does throw events such as [[Osiris/API/RegionStarted|RegionStarted]] and [[Osiris/API/GameStarted|GameStarted]] that signify the game may have entered a different phase.<br /> <br /> == Goal Initialisation and Completion ==<br /> As mentioned [[#Program_Structure|earlier]], when a goal initialises its INIT section gets executed and the rules in its KB section become active. Additionally, [[#Queries|QRY]]s and [[#Procedures|PROC]]s defined in this goal's KB become usable by this and other goals. This means that as long as a goal has not been initialised, or after it has been completed, none of its defined procedures and queries will be found/executed anymore by other goals.<br /> <br /> Now, when does a goal initialise? Let's have a look at the left pane of the following screenshot of the story editor:<br /> <br /> [[File:StoryEditor.png|800px]]<br /> <br /> At the top level, you see a goal named ''Start''. Under it, there are two other goals: ''AtaraxianArtifacts'' and ''FTJ_Origins_Ifan''. Top-level goals are initialised as soon as the mod is loaded. In case those three goals were the only ones in a mod, that would mean that only the ''Start'' goal would initialise when the mod gets loaded.<br /> <br /> Completing, or finalising a goal happens by placing a '''GoalCompleted;''' action in any action block. At that point,<br /> * all subgoals of the current goal will be initialised;<br /> * the EXIT section of the current goal will be executed;<br /> * none of the rules, queries or procedures in the current goal will be active/available anymore;<br /> * databases set in the completed goal, even in its init section, will ''remain'' active and available, unless they are deleted by the goal's EXIT code.<br /> <br /> However, the action block in which '''GoalCompleted;''' was called will still be executed till the end. This means that you can insert calls after that statement, even to procedures inside subgoals as these have been initialised once the '''GoalCompleted;''' statement has finished executing. Just make sure you do not rely on any databases that may be deleted by the EXIT code of the current goal.<br /> <br /> == Rule Order ==<br /> As mentioned in the [[#Program_Structure|program structure]] section, all goals of a mod and of the mods it depends on are merged into a single story. The question then is: in what order are the merged rules evaluated? This can be very important in case one rule defines databases upon which other rules may depend. For example, the [[Osiris/Shared/DB_DialogNPCs|DB_DialogNPCs]] database is defined by a goal in the Shared mod whenever a [[Osiris/API/DialogStarted|DialogStarted]] event fires. So if you also catch the DialogStarted event in your mod, can you rely on this database existing already or not at that time? In other words, how can you know whether the DialogStarted-rule from the Shared mod executes before or after the one in your mod?<br /> <br /> The answer is both simple and possibly a bit unsettling: rules are executed from top to bottom in the single story that contains all goals from all mods that are currently active. Inside this story, all goals are sorted alphabetically on '''''goal name'''''. This sorting disregards both parent/subgoal relations and mod dependencies. So a goal named ''FooBar'' in your mod, even if it is a subgoal located at five levels deep, will always be placed in story before e.g., the ''GLO_Follower'' of the Shared mod.<br /> <br /> Note that, as mentioned in the [[#Goal_Initialisation_and_Completion|previous section]], only rules/procedures/queries from active goals will be found. So as long as the FooBar goal from your mod has not be initialised, none of its rules/procedures/queries will execute at all, no matter where they are placed in story.<br /> <br /> Returning to the specific case of the [[Osiris/Shared/DB_DialogNPCs|DB_DialogNPCs]] database: these are defined in a goal of the Shared mod with name ''_AAA_FirstGoal''. While it is technically not the very first goal in the story, it does appear before any goal that uses this database. And if you wish to use this database in a mod of your own in a DialogStarted event, make sure that goal's name comes after ''_AAA_FirstGoal'' when sorted alphabetically (the '''_''' character is sorted before any letter or number).<br /> <br /> In summary:<br /> * All event handlers in top-level goals become available when the game starts.<br /> * Goals are initialised/activated in alphabetical order, so do not depend on PROCs/QRYs/events (including reacting to database facts) from other goals in your goal initialisation code.<br /> * Completing a goal renders it inactive, but activates all of its subgoals.<br /> <br /> == Rule Matching ==<br /> As explained in the section on [[#Variables|variables]], you can use variables to make rules generic. There are many more powerful uses of variables though, with associated gotchas.<br /> <br /> === Iterating Database Contents ===<br /> You can use variables to iterate all values in a database. Assuming the ''DB_Overview_Origins'' has been declared [[#Databases|as above]], consider the following rule:<br /> <pre><br /> IF<br /> DB_Overview_KillAllOrigins(1)<br /> AND<br /> DB_Overview_Origins(_Origin)<br /> THEN<br /> // Cast _Origin to CHARACTERGUID because that's what CharacterDie expects, and because the<br /> // first DB_Overview_Origins() database fact has been declared without a specific type<br /> // (hence defaulting to GUIDSTRING)<br /> CharacterDie((CHARACTERGUID)_Origin, 0, "DoT");<br /> </pre><br /> This rule means that as soon as the ''DB_Overview_KillAllOrigins(1)'' fact has been defined, we will iterate over all currently defined ''DB_Overview_Origins'' facts with one column. For each of those facts we will sequentially assign the actual value to the ''_Origin'' variable, and then evaluate the subsequent conditions (if any) for that value. If they succeed, we will perform the actions, again with this value.<br /> <br /> === Looking Up Facts (Associative Arrays) ===<br /> We can also use this technique to look up facts in a database:<br /> <pre><br /> IF<br /> DB_Overview_KillOriginByName(_Name)<br /> AND<br /> DB_Overview_Origins(_Origin, _Name)<br /> THEN<br /> // No need for typecast, as the first DB_Overview_Origins() database fact with two columns<br /> // has been declared as having CHARACTERGUIDs in the first column<br /> CharacterDie(_Origin, 0, "DoT");<br /> </pre><br /> Here we react to a database fact being set containing the name of the origin we want to kill. We then iterate over all ''DB_Overview_Origins'' facts with two columns, whereby the second column matches the name specified in the newly defined ''DB_Overview_ResurrectOriginByName'' fact. If one or more such entries are found, we will then kill them.<br /> <br /> === Rule Evaluation State ===<br /> But what if we want to be able to perform the above multiple times for the same origin? Once a database fact has been defined, redefining it again with the same value will not result in any event triggering. After all, the database fact already existed and the event only triggers when a new fact gets added. To solve this, we can simply remove the fact in the rules section:<br /> <pre><br /> IF<br /> DB_Overview_KillOriginByName(_Name)<br /> AND<br /> DB_Overview_Origins(_Origin, _Name)<br /> THEN<br /> NOT DB_Overview_KillOriginByName(_Name); // added<br /> CharacterDie(_Origin, 0, "DoT");<br /> </pre><br /> You may wonder whether removing the ''DB_Overview_KillOriginByName(_Name)'' will abort further execution of the rule in case there would be multiple ''DB_Overview_Origins'' facts for which ''_Name'' matches. That is not the case. The reason is that the execution of a rule occurs by generating a temporary internal table of the valid possibilities every time a condition is evaluated. Afterwards, Osiris keeps referring to this table.<br /> <br /> For example, in the above rule, at the second step Osiris will create an internal table that contains all matching ''DB_Overview_Origins(_Origin, _Name)'' facts for the specified ''_Name''. Then it will start evaluating all subsequent conditions (and actions) using this temporary table, rather than starting at the first condition again every time. The same happens with the second, third, ... condition.<br /> <br /> === Rule Trigger Evaluation ===<br /> Osiris uses a similar mechanism as the [[#Rule_Evaluation_State|Rule Evaluation State]] at the top-level, when determining which rules to execute. When a [[#Trigger_Conditions|trigger condition]] occurs, Osiris immediately collects all rules in all active goals that match the ''first'' trigger condition. Next, it will start executing these rules one by one with the matched parameter values. This means that even if you ensure that your rule triggers first, removing the first trigger condition or rendering it false will not prevent subsequent rules from executing.<br /> <br /> Example:<br /> <pre><br /> IF<br /> DB_Overview_KillOriginByName(_Name)<br /> AND<br /> DB_Overview_Origins(_Origin, _Name)<br /> THEN<br /> NOT DB_Overview_KillOriginByName(_Name); // added<br /> CharacterDie(_Origin, 0, "DoT");<br /> <br /> IF<br /> DB_Overview_KillOriginByName(_Name)<br /> AND<br /> DB_Overview_Origins(_Origin, _Name)<br /> AND<br /> ObjectGetFlag(_Origin,"Overview_ShouldBeResurrectedAfterDying")<br /> THEN<br /> CharacterResurrect(_Origin);<br /> </pre><br /> First of all, keep in mind that rules are executed in the order they appear in story, and fully execute before any rule after them gets executed. This means that we will first kill all origin characters whose name column in the ''DB_Overview_Origins'' database matches the specified name. We will also remove the ''DB_Overview_KillOriginByName(_Name)'' fact. Next the second rule will still execute, because Osiris has already previously determined that this rule gets activated by the triggering event.<br /> <br /> Conversely, removing (or adding) ''DB_Overview_Origins()'' facts in the first rule would affect the execution of the second rule. The reason is that only the first trigger gets cached while selecting which rules to evaluate.<br /> <br /> == Osiris Frames ==<br /> The evaluation of Osiris events is separated into frames. Everything that happens in a single frame happens atomically: it is not possible for a player to save in the middle of a frame, nor to abort part of the actions of a frame. Either a frame starts and runs to the finish, or does not start at all. In other words, frames are atomic, non-interruptible blocks of rule evaluations and actions.<br /> <br /> Whenever an event will execute a number of rules, as explained in the [[#Rule_Trigger_Evaluation|Rule Trigger Evaluation]] section, all of these rules will be evaluated and their actions executed in the same frame. Furthermore, any procedures or queries called by these rules will also execute in the same frame.<br /> <br /> == Frame Delays ==<br /> While all Osiris API and user-defined procedure calls are guaranteed to execute in the same frame during which the corresponding rule's event was triggered, their effects often will not happen instantaneously. This can be obvious, as for example a [[Osiris/API/CharacterMoveTo|CharacterMoveTo]] operation will probably take at least a few seconds complete. However, there are also a few less obvious cases. The most important one is flag visibility in dialogs.<br /> <br /> Take for example the following dialog:<br/>[[File:Dialog-framedelay.png|none|600px]]<br /> <br /> The following flags are set/checked in the nodes marked with with the blue squares:<br /> {|<br /> !Ask for blackroot<br /> !Had blackroot<br /> !Had no blackroot<br /> |-<br /> |[[File:Dialog-framedelay-askblackroot.png|none|400px]]<br /> |[[File:Dialog-framedelay-hadblackroot2.png|none|400px]]<br /> |[[File:Dialog-framedelay-noblackroot.png|none|400px]]<br /> |}<br /> <br /> This is combined with the example Osiris code from [[Osiris/Shared/DB_GiveTemplateFromPlayerDialogEvent|DB_GiveTemplateFromPlayerDialogEvent]]:<br /> // if you set the character flag "MYPRE_give_blackroot" on an NPC in this dialog, and this NPC has blackroot in his inventory, then<br /> // it will give one blackroot to the first player in that dialog and the flag "MYPRE_had_blackroot" will be set on the NPC.<br /> DB_GiveTemplateFromPlayerDialogEvent("QUEST_Blackroot_843689bf-6498-45ac-98ba-b375bdbbb189", "MYPRE_give_blackroot", "MYPRE_had_blackroot");<br /> <br /> Assume that frame 1 is when the player clicks to get the blackroot, then the following happens:<br /> {| border="1" style="border-collapse:collapse"<br /> !<br /> !Dialog<br /> !Osiris<br /> |-<br /> !Frame 1<br /> |<br /> * The flag '''MYPRE_give_blackroot''' is set on the NPC.<br /> * The dialog manager loads the following node(s) ("Frame delay node" in our example) and evaluates its (their) flag conditions, if any (none in our example).<br /> |<br /> * Osiris gets an [[Osiris/API/ObjectFlagSet|ObjectFlagSet]] event for the '''MYPRE_give_blackroot''' flag that was set on the NPC.<br /> * In combination with the [[Osiris/Shared/DB_GiveTemplateFromPlayerDialogEvent|DB_GiveTemplateFromPlayerDialogEvent]] definition above, this will result in a check whether the NPC has any instance of the '''QUEST_Blackroot_843689bf-6498-45ac-98ba-b375bdbbb189''' root template in its inventory, and if so transfer one such instance to the first player in the dialog and the set the '''MYPRE_had_blackroot''' flag on the NPC.<br /> |-<br /> !Frame 2<br /> |<br /> * The frame delay node is shown.<br /> * The dialog manager loads the following node(s) ('''Had blackroot''' and '''Had no blackroot''' in our example) and evaluates its (their flag conditions) (check whether '''MYPRE_had_blackroot''' is set on NPC in our example).<br /> |<br /> * Nothing relevant to the dialog.<br /> |-<br /> !Frame 3<br /> |<br /> * Depending on whether or not Osiris set the '''MYPRE_had_blackroot''' flag in '''Frame 1''', the '''Had blackroot''' or '''Had no blackroot''' node will be shown.<br /> * If the '''Had blackroot''' node got selected, the '''MYPRE_give_blackroot''' flag will be cleared again from the NPC.<br /> |<br /> * Nothing relevant to the dialog.<br /> |}<br /> <br /> If we did not add the '''Frame delay node''' between '''Ask blackroot''' and the '''Had (no) Blackroot''', then the dialog manager would check the '''MYPRE_had_blackroot''' flag before Osiris had set it, and hence the check would always fail. If you do not want any actual dialog text in between, you can make the '''Frame delay node''' a completely empty node (without a text block). Such nodes are automatically skipped immediately, but they still occupy a frame.<br /> [[Category:Osiris]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterReceivedDamage&diff=6444 Osiris/API/CharacterReceivedDamage 2018-10-23T09:57:13Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * event '''CharacterReceivedDamage'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Percentage''', ''(GUIDSTRING)'''''_Source''')<br /> ===== Description =====<br /> Thrown when a character receives damage from an attack or an environmental effect such as a surface.<br /> ===== Parameters =====<br /> * '''_Character''': The character that was damaged.<br /> * ''(new in DOS2 Patch 5)'' '''_Percentage''': The percentage of vitality/hit points that was removed by this damage event.<br /> * ''(new in DOS2 Patch 5)'' '''_Source''': The GUID of the character or item that caused the damage. In case the damage is caused by a surface, this will be the creator of said surface (can be NULL if the game cannot determine the party responsible, e.g. if you are damaged by a static fire surface that was painted in the editor).<br /> ===== Notes =====<br /> * This event is thrown even when '''_Percentage''' is 0.0, i.e., all damage was blocked by armor or '''_Character''' was immune to the damage type.<br /> * This event is ''not'' thrown if the "damage" healed '''_Character''' (e.g. poison damage to a zombie); in that case, a corresponding HEAL status will be applied to '''_Character''' instead.<br /> <br /> ===== See Also =====<br /> * [[Osiris/API/AttackedByObject|AttackedByObject]]<br /> * [[Osiris/API/CharacterStatusAttempt|CharacterStatusAttempt]]<br /> * [[Osiris/API/CharacterStatusApplied|CharacterStatusApplied]]<br /> * [[Osiris/API/CharacterVitalityChanged|CharacterVitalityChanged]]<br /> <br /> [[Category:Osiris Events|CharacterReceivedDamage]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterVitalityChanged&diff=6443 Osiris/API/CharacterVitalityChanged 2018-10-23T09:56:50Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * event '''CharacterVitalityChanged'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Percentage''') ===== Description ===== Thrown when..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * event '''CharacterVitalityChanged'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Percentage''')<br /> ===== Description =====<br /> Thrown when the character's vitality changes.<br /> ===== Parameters =====<br /> * '''_Character''': Character whose vitality changes.<br /> * '''_Percentage''': Percentage of their HP the character has after the change.<br /> ===== Notes =====<br /> -<br /> ===== See Also =====<br /> * [[Osiris/API/CharacterReceivedDamage|CharacterReceivedDamage]]<br /> * [[Osiris/API/AttackedByObject|AttackedByObject]]<br /> * [[Osiris/API/CharacterStatusAttempt|CharacterStatusAttempt]]<br /> * [[Osiris/API/CharacterStatusApplied|CharacterStatusApplied]]<br /> <br /> [[Category:Osiris Events|CharacterVitalityChanged]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/GenerateTreasure&diff=5984 Osiris/API/GenerateTreasure 2018-07-02T15:22:29Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''GenerateTreasure'''(''(ITEMGUID)'''''_Item''', ''(STRING)'''''_TreasureID''', ''(INTEGER)'''''_Level''', ''(CHARACTERGUID)'''''_Character''')<br /> ===== Description =====<br /> Generates treasure from the '''_TreasureID''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Item''''s inventory.<br /> *If the '''_Level''' is greater than or equal to 0, it will be used to generate treasure.<br /> *If the '''_Level''' is less than 0, if the item is set (in the sidebar) to ''Use Party Level For Treasure'', the highest level in the '''_Character''' 's party is used.<br /> *If the '''_Level''' is less than 0, and ''Use Party Level For Treasure'' is false, the item's ''Treasure Level'' setting is used.<br /> *If the ''Treasure Level'' setting is also less than 0, the level of the nearest character is used.<br /> *This adds the contents of the treasure to whatever is already inside the item's inventory. If it has a treasure table defined in the sidebar, it will get both. The treasure defined in the sidebar is generated whenever the first of the following occurs:<br /> **The item is destroyed<br /> **The item is used (e.g. opened)<br /> **The item is picked up<br /> **The item is unlocked<br /> **The item is moved<br /> **Something is added to the item's inventory (this can happen if an item is added e.g. through Story).<br /> ===== Notes =====<br /> */<br /> ===== See Also =====<br /> *[[Osiris/API/CharacterGiveReward|CharacterGiveReward]]<br /> *[[Osiris/API/CharacterGiveQuestReward|CharacterGiveQuestReward]]<br /> *[[Treasure_Tables|Treasure Table]]<br /> <br /> [[Category:Osiris Calls|GenerateTreasure]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/GenerateTreasure&diff=5983 Osiris/API/GenerateTreasure 2018-07-02T15:22:10Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''GenerateTreasure'''(''(ITEMGUID)'''''_Item''', ''(STRING)'''''_TreasureID''', ''(INTEGER)'''''_Level''', ''(CHARACTERGUID)'''''_Character''')<br /> ===== Description =====<br /> Generates treasure from the '''_TreasureID''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Item''''s inventory.<br /> *If the '''_Level''' is greater than or equal to 0, it will be used to generate treasure.<br /> *If the '''_Level''' is less than 0, if the item is set (in the sidebar) to ''Use Party Level For Treasure'', the highest level in the '''_Character''' 's party is used.<br /> *If the '''_Level''' is less than 0, and ''Use Party Level For Treasure'' is false, the item's ''Treasure Level'' setting is used.<br /> *If the ''Treasure Level'' setting is also less than 0, the level of the nearest character is used.<br /> *This adds the contents of the treasure to whatever is already inside the item's inventory. If it has a treasure table defined in the sidebar, it will get both. The treasure defined in the sidebar is generated whenever the first of the following occurs:<br /> **The item is destroyed<br /> **The item is used (e.g. opened)<br /> **The item is picked up<br /> **The item is unlocked<br /> **The item is moved<br /> **Something is added to the item's inventory (e.g. through Story).<br /> ===== Notes =====<br /> */<br /> ===== See Also =====<br /> *[[Osiris/API/CharacterGiveReward|CharacterGiveReward]]<br /> *[[Osiris/API/CharacterGiveQuestReward|CharacterGiveQuestReward]]<br /> *[[Treasure_Tables|Treasure Table]]<br /> <br /> [[Category:Osiris Calls|GenerateTreasure]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/ItemRemove&diff=5927 Osiris/API/ItemRemove 2018-06-15T09:08:03Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * call '''ItemRemove'''(''(ITEMGUID)'''''_Item''') ===== Description ===== * Deletes the '''_Item''' from the game. ===== Notes ===== * Unlike i..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''ItemRemove'''(''(ITEMGUID)'''''_Item''')<br /> ===== Description =====<br /> * Deletes the '''_Item''' from the game.<br /> ===== Notes =====<br /> * Unlike items set offstage, a deleted item is gone permanently.<br /> * Unlike [[Osiris/API/ItemDestroy|ItemDestroy]], ItemRemove leaves no debris and plays no destroy animation.<br /> ===== See Also =====<br /> * [[Osiris/API/ItemDestroy|ItemDestroy]]<br /> * [[Osiris/API/ObjectExists|ObjectExists]]<br /> * [[Osiris/API/ObjectIsCharacter|ObjectIsCharacter]]<br /> * [[Osiris/API/ObjectIsItem|ObjectIsItem]]<br /> * [[Osiris/API/SetOnStage|SetOnStage]]<br /> <br /> [[Category:Osiris Calls|ItemRemove]]</div>

LarIlya https://docs.larian.game/index.php?title=My_first:_Behaviour_Script&diff=5907 My first: Behaviour Script 2018-05-31T07:25:21Z

<p>LarIlya: Redirected page to Scripting</p> <hr /> <div>#REDIRECT [[Scripting]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/Shared/DB_DialogMoneyTransfer&diff=5464 Osiris/Shared/DB DialogMoneyTransfer 2018-02-02T08:39:44Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * '''DB_DialogMoneyTransfer'''(''(INTEGER)'''''_MoneyVarIndex''', ''(STRING)'''''_DialogName''', ''(INTEGER)'''''_Amount''')<br /> * '''DB_DialogMoneyTransfer'''(''(INTEGER)'''''_MoneyVarIndex''', ''(STRING)'''''_DialogName''', ''(INTEGER)'''''_Amount''', ''(INTEGER)'''''_CheckSpeakerIndex''')<br /> * '''DB_DialogMoneyTransfer'''(''(INTEGER)'''''_MoneyVarIndex''', ''(STRING)'''''_DialogName''', ''(INTEGER)'''''_Amount''', ''(INTEGER) '''''_CheckSpeakerIndex''', ''(INTEGER)'''''_TargetDBIndex''')<br /> ===== Description =====<br /> This functionality can be used in dialogs both to check whether a participant has a certain amount of gold, and to transfer this gold from one participant to another: <br /> * '''_MoneyVarIndex''': can be 1-5. Determines which of the '''GEN_CheckMagicPocketGold'''/'''_2'''/../'''_5''' dialog variables gets set, and hence whether you can use the '''GEN_CheckPocketGold'''/'''_2'''/../'''_5''' scrip var to check whether a dialog participant (see '''_CheckSpeakerIndex''') has at least the specified amount of money.<br /> * '''_DialogName''': the name of the dialog that this DB should influence.<br /> * '''_Amount''': the amount of money that should be checked and/or transferred.<br /> * '''_CheckSpeakerIndex''': This sets the speaker dialog variable used by '''GEN_CheckPocketGold'''/'''..''' and hence must refer to a speaker index in the dialog. It determines which speaker will be checked for having a sufficient amount of gold. If unspecified, it defaults to '''2''' (the player in most dialogs that have two speakers).<br /> * '''_TargetDBIndex''': This only affects money transfers. Money transfers can be performed by setting the '''GEN_TransferNPCPayment'''/'''_2'''/../'''_5''' (= transfer flag) character flag on either a player or an NPC in the dialog (independent of what '''_CheckSpeakerIndex''' is). It will then transfer up to '''_Amount''' gold (depending on how much gold this character had) '''''from''''' that flagged character to another character. This other character is determined by '''_TargetDBIndex''' as follows, with this value defaulting to '''1''' if unspecified:<br /> ** If the character on which the transfer flag is set is a player, the money will go to the NPC matching '''DB_DialogNPCs(_, _, _TargetDBIndex)''' for the current dialog. I.e., if '''_TargetDBIndex''' is '''1''', it will transfer the money to the first NPC in the dialog in this case.<br /> ** If the character on which the transfer flag is set is an NPC, the money will go to the player matching '''DB_DialogPlayers(_, _, _TargetDBIndex)''' for the current dialog. I.e., if '''_TargetDBIndex''' is '''1''', it will transfer the money to the first player in the dialog in this case.<br /> ===== Notes =====<br /> * The reason for the discrepancy between how '''_CheckSpeakerIndex''' and '''_TargetDBIndex''' are interpreted, is due to the fact that Osiris only supports requesting NPC and player speakers separately. Additionally, this also allows using a single '''DB_DialogMoneyTransfer'''() definition to transfer money back and forth between a player and an NPC (if you only need to check in one direction whether the source has in fact enough money).<br /> * If you wish to make sure a participant has enough gold before transferring, always perform the verification (check '''GEN_CheckMagicPocketGold'''/..) and the transfer (setting '''''GEN_TransferNPCPayment'''''/..) on the same node. Otherwise, the participant could lose gold in between the check and the transfer.<br /> * Examples<br /> ** '''DB_DialogMoneyTransfer(1,"FTJ_GhettoBoss",50);'''<br /> *** When the '''GEN_CheckMagicPocketGold''' script var is checked in the FTJ_GhettoBoss dialog, this will check whether speaker 2 (default, because unspecified; corresponds to the player in this dialog) has at least 50 gold.<br /> *** When the character flag '''GEN_TransferNPCPayment''' is set on the player in that dialog, up to 50 gold will be transferred from the player to the first NPC in that dialog (_TargetDBIndex defaults to 1). I.e., it will transfer up to 50 gold from the player to Griff. If it is set on Griff, the transfer will go in the other direction.<br /> ** '''DB_DialogMoneyTransfer(2,"ARX_Neighborhood_Street_TraderBaker",1000,3,2);'''<br /> *** Here we can check using the '''GEN_CheckMagicPocketGold_2''' script var whether speaker 3 (the player, in this dialog) has at least 1000 gold.<br /> *** By setting '''GEN_TransferNPCPayment_2''' on the player in that dialog, we can transfer up to thousand gold to the second NPC in this dialog. Setting this flag on an NPC will not do anything, because that would result in an attempt to transfer this money to a second player in this dialog, which does not exist.<br /> ===== See Also =====<br /> * /<br /> <br /> [[Category:Osiris Shared Mod Helpers|DialogMoneyTransfer]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/GetAngleTo&diff=5454 Osiris/API/GetAngleTo 2018-01-31T21:16:14Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * query '''GetAngleTo'''('''''[in]'''(REAL)'''''_x0''', '''''[in]'''(REAL)'''''_z0''', '''''[in]'''(REAL)'''''_x1''', '''''[in]'''(REAL)'''''_z1''', '''''[out]'''(INTEGER)'''''_Angle''')<br /> ===== Description =====<br /> Returns the angle around the Y-axis between two points in degrees.<br /> ===== Return Values =====<br /> * '''Success/Failure''': Always succeeds.<br /> * '''_Angle''': The angle between ('''_x0''', '''_z0''') and ('''_x1''', '''_z1''') around the Y-axis relative to the X-axis.<br /> ===== Notes =====<br /> * Unlike with [[Osiris/API/GetRotation|GetRotation]], the result of this call is has no offset relative to the X-axis.<br /> * Unlike with [[Osiris/API/GetRotation|GetRotation]], this angle increases when rotating in counter-clockwise direction.<br /> * The returned angle is in the interval [-180, 180].<br /> <br /> ===== See Also =====<br /> * [[Osiris/API/GetRotation|GetRotation]]<br /> <br /> [[Category:Osiris Queries|GetAngleTo]]</div>

LarIlya https://docs.larian.game/index.php?title=Dialog_editor&diff=5358 Dialog editor 2018-01-09T08:05:31Z

<p>LarIlya: </p> <hr /> <div>= Introduction =<br /> The Dialogue Designer is a visual tool for creating dialogues in our Divinity games. The tool is easy to use for writers and scripters alike and it is independent of the game we're working on.<br /> <br /> = Creating Dialogues =<br /> The Dialogue Designer can be found in the toolbar of our game editor. Look for the speech bubble.<br /> <br /> Click that icon to open an instance of the Dialogue Designer. Every time you click on that icon, you will open a new dialogue editor instance. You will be presented with an empty dialogue when the editor starts:<br /> <br/><br /> [[File:Dialog_Empty.png]]<br /> <br /> == New Dialogues ==<br /> From the File menu you can create a new empty dialogue (replaces the currently open dialogue, if any, with an empty one) or a dialogue from a template. For more about Templates see [[#Templates]].<br /> <br /> == Copying Dialogues ==<br /> If you want to create a new dialogue based on an existing dialogue, '''don't just copy the files'''! This will cause problems with voice recording. If you want to copy an existing dialogue you can either:<br /> # Open up the existing dialogue and use the "save as" function in the File menu to save a new dialogue with the name of your choice. You will then be working in the copied version of the dialogue.<br /> #:OR<br /> # Open up two instances of the Dialogue Editor. Open your source dialogue in the first instance and Copy the nodes. Then go to the second Dialogue Editor Instance and paste the nodes. For more about copying nodes see [[#Copying_Nodes|Copying Nodes]].<br /> <br /> = Dialog Categories =<br /> Different kinds of dialogs serve different purposes. You can select the dialog category using the pop-up menu on the top-right of the dialog window.<br /> <br /> == Generic NPC Dialog ==<br /> This is an interactive dialog with player interaction. It can contain any kind of dialog [[#Nodes|node]]. Generally it should include at least one player, as NPCs by themselves cannot progress through such a dialog (unless the dialog only contains [[#Greeting|Greeting]] and [[#Answer|Answer]] nodes, and all [[#Transition Mode|node transitions]] are timed; even then all you will see is a text balloon over the speakers' heads and the only way players can know what they are saying is by clicking on them while they are in the conversation — this could still result in fun "listen in" gameplay mechanics though!).<br /> <br /> Starting such a dialog shows the dialog interface for all involved players (if any), which they can use to click through the dialog and select their reactions where allowed. Players cannot exit an interactive dialog, except through [[#EndNode|Leave]] nodes.<br /> <br /> == Automated NPC Dialog ==<br /> This is a non-interactive/automated dialog. An automated dialog can only include [[#Greeting|Greeting]] and [[#Answer|Answer]] nodes. The default [[#Transition Mode|node transition mode]] will show each node a certain amount of time based on its length. An automated dialog can have any combination/absence of NPCs and players.<br /> <br /> Starting such a dialog shows the text of the dialog above the speakers' heads. Nobody is pulled into a modal interface like with the [[#Generic_NPC_Dialog|Generic NPC Dialog]].<br /> <br /> You '''must''' also check the [[#Automated|Automated]] checkbox in this case.<br /> <br /> == Repeated Automated NPC Dialog ==<br /> This is exactly the same as an [[#Automated_NPC_Dialog|Automated NPC Dialog]], except that it gives a hint to the sound subsystem that this AD is repeated from time to time. It is used for ADs by sellers on market squares and the likes. The effect is that the voice recordings are played at a lower volume, and only a maximum number of times per minute.<br /> <br /> If your dialog is not recorded, it will behave the same as a regular Automated NPC Dialog.<br /> <br /> You '''must''' also check the [[#Automated|Automated]] checkbox in this case.<br /> <br /> == PVP Dialog ==<br /> <br /> == Reflection Dialog ==<br /> <br /> == Voice bark ==<br /> A voice bark is an [[#Automated NPC Dialog|Automated NPC Dialog]] intended to be used with a [[Voice_Bark_editor|voicebark]] and functions the same in DOS2.<br /> <br /> == Ghost Dialog ==<br /> This is the same as [[#Generic_NPC_Dialog|Generic NPC Dialog]], except that the main NPC speaker is a ghost. This was added in order to give a hint to the sound subsystem that it should apply a "ghostly ambience" filter to ghost text. However, since dialogs can include both ghosts and non-ghosts, you need to process this per speaker rather than per dialog and hence this setting has no effect.<br /> <br /> == Ghost Automated Dialog ==<br /> The same as a regular [[#Automated_NPC_Dialog|Automated NPC Dialog]], with the same remarks as for [[#Ghost_Dialog|ghost dialogs]].<br /> <br /> You '''must''' also check the [[#Automated|Automated]] checkbox in this case.<br /> <br /> == Repeated Ghost Automated Dialog ==<br /> The same as a regular [[#Repeated_Automated_NPC_Dialog|Repeated Automated NPC Dialog]], with the same remarks as for [[#Ghost_Dialog|ghost dialogs]].<br /> <br /> You '''must''' also check the [[#Automated|Automated]] checkbox in this case.<br /> <br /> == Gameplay Automated Dialog ==<br /> <br /> You '''must''' also check the [[#Automated|Automated]] checkbox in this case.<br /> <br /> == Companion Dialog ==<br /> This is the same as a [[#Generic_NPC_Dialog|Generic NPC Dialog]], but it treats tag checks for the origin companions (IFAN, BEAST, ...) the same as their shapeshifted versions (SHAPESHIFT_IFAN, SHAPESHIFT_BEAST, ...).<br /> <br /> == Automated ==<br /> This checkbox must be checked for all automated dialogs. It is what actually determines whether a dialog is started in interactive or non-interactive mode. The difference between the automated and non-automated categories above are used by different systems (mainly sound).<br /> <br /> All dialogs with this checkbox checked treat tag checks for the origin companions (IFAN, BEAST, ...) the same as their shapeshifted versions (SHAPESHIFT_IFAN, SHAPESHIFT_BEAST, ...).<br /> <br /> = Nodes =<br /> The Dialogue Designer represents the logical structure of a dialogue with a node tree. A node is a logical block of text said by an actor in the dialogue. Everything an NPC or a player can say (or ask), is represented by such a node. Nodes form a tree by connecting to other nodes. These connections denote the flow of the dialogue. For example, if you want an NPC A to say something and another NPC B to reply to that, you have to make a node for NPC A and connect another node for NPC B to that. Nodes can be connected to multiple other nodes, but more about that later.<br /> <br /> == Adding Nodes ==<br /> In your dialogue window, right click the grey area to get the node popup menu:<br /> <br/><br /> [[File:Dialog_Nodemenu.png]]<br /> <br /> From this menu you can select which type of node you want to add to your dialogue. You'll notice that some of them are greyed out in this pictures. That's because not all node types can be added independently. Some node types require a parent node, before they can be added.<br /> <br /> == Connecting Nodes ==<br /> In the previous section we saw that some nodes need a parent node before they can be added to your dialogue. That's the case for most node types found in a dialogue. The Greeting node is an example of a node that doesn't need a parent, since it's the node where the dialogue will start execution. They form the roots of the dialogue tree and the rest of the dialogue flows from them.<br /> <br /> Let's create a greeting node, by selecting “Greeting” from the node popup menu:<br /> <br/><br /> [[File:Dialog_Greeting.png]]<br /> <br /> You'll see a green box appear in the main panel of your dialogue designer. Every node is represented as a little box like that, each with a unique colour, Notice the little circle at the top right of the greeting node? That's a connector. This is where other nodes will connect to this greeting node. The greeting node only has a single connector (to the right), because it does not accept parent nodes. You can only attach nodes to it, you can't attach a greeting node to another node since it has no connector on the left.<br /> <br /> Now lets add an Answer node to this greeting node. Answer nodes are plain text nodes, usually put in dialogues as answers to questions made by a player (hence the name). You can't have an answer without a preceding question or another text node of some kind, That just wouldn't make sense. That's why Answers require a parent node and that explains why they were greyed out when we first opened up the node popup menu.<br /> <br /> To add an answer node, we first select the greeting node, by left clicking on it. You'll notice the colour will change to a lighter shade of green. Now you right click to open the node popup menu:<br /> <br/><br /> [[File:Dialog_Connect.png]]<br /> <br /> You'll notice the previously greyed out options are now available to click. All those greyed out node types require a parent node before they can be used in a dialogue. Now select “Answer” from the menu. You'll see an Answer node appear next to your Greeting node:<br /> <br/><br /> [[File:Dialog_Connected.png]]<br /> <br /> Notice the line between the two nodes. That's a node connection. It extends from one node connector to another node connector. The Answer node has a node connector on its right side, That means you can attach other nodes to it. It also has a node connector on the left, which means it accepts incoming connections from other nodes.<br /> <br /> There is no limit on the number of node connections you can have. A single Greeting node can have multiple nodes attached to it. Just as a single Answer node can have multiple nodes as parents.<br /> <br /> == Inserting Nodes ==<br /> Some times you want to add a node in between a parent and its children. Instead of adding a new node to the parent and then manually connecting (and disconnecting) the parent's child nodes, you can use the node popup menu's “Insert Node” function.<br /> <br /> To insert a node, select the parent node and right click it. Then from the node popup menu open the “Insert Node” sub menu and select your desired node type from the list. This list only contains nodes that can be inserted in between 2 nodes. That is, it only contains nodes that accept parents and children.<br /> Selecting Nodes<br /> <br /> If you want to move a node, remove it or change its properties you have to first select it. You can select more than one node, though you can't change node properties if you have more than 1 node selected. The dialogue editor offers several ways to select nodes:<br /> <br /> # Select a single node by left-clicking it with the mouse.<br /> # Add or remove from your node selection by holding the CTRL key and left-clicking another node. If the new node was not selected it gets added to the current node selection. If the new node was already selected it will be removed from the current selection.<br /> # You can marquee select a (group of) nodes by left-clicking in empty space and dragging over the node(s) you want to select. You'll see a rectangular region extend from where you clicked and following the mouse cursor. When you let go of the left mouse button, any nodes contained in the selection rectangle will be selected.<br /> # Select a node and all of its children by holding the ALT key and left-clicking a node.<br /> <br /> == Copying Nodes ==<br /> You can copy and paste nodes into your dialogues.<br /> <br /> To copy dialog nodes, select the nodes you want to copy and press the CTRL + C key combination on your keyboard. The dialog nodes are now put on the clipboard and can be pasted in either the current dialogue or another instance of the dialogue editor.<br /> <br /> To paste your copied dialog nodes, simply go to the destination dialogue editor window and press the CTRL + V key combination on your keyboard. If the pasted nodes had parent and/or child nodes and those nodes are present in the destination dialogue editor, the newly pasted nodes will be connected to those too. <br /> <br /> == Removing Nodes ==<br /> Remove nodes from the dialogue by selecting them and pressing the DELETE key.<br /> <br /> == Moving Nodes ==<br /> To move nodes to a new location in the dialogue tree, select them first. Then left click and drag one of the selected nodes. The group of selected nodes will now follow the mouse cursor as you drag it around. Let go of the left mouse button to place the nodes on the new location. When you drop the nodes, they will snap to a location. You can show the grid by checking the 'Show grid' option in the 'View' menu.<br /> <br /> == Collapsing Nodes ==<br /> You can collapse dialog Nodes in the editor by double-clicking their title bar. That is the top part of a Node where the Logical Name is shown:<br /> <br/><br /> [[File:Dialog_TitleBar.png]]<br /> <br /> A collapsed Node only displays the Logical Name and not its contents:<br /> <br/><br /> [[File:Dialog_Collapsed.png]]<br /> <br /> == Changing Node Properties ==<br /> Every node type has a number of properties that can be changed from the node properties side bar:<br /> <br/><br /> [[File:Dialog_NodeProperties.png]]<br /> <br /> You can only edit the properties of one node at a time. So if you have multiple nodes selected you can not change their properties. Not every node type offers the same node properties. A more in-depth discussion is provided in [[#Node Properties and Node Types|Node Properties and Node Types]].<br /> <br /> To copy and paste properties from one node to another, you can right click the property and choose for 'Copy'. If you want a textual representation of a property (eg. for documentation), you can choose 'Copy display string to clipboard'.<br /> <br /> You can drag the Node Properties window to dock it somewhere else or move it to a second screen for easier editing.<br /> <br /> = Navigating the Dialogue Tree =<br /> <br /> As your dialogue grows not all nodes will fit on the screen anymore. When your view doesn't contain all the nodes in the dialogue tree anymore, the dialogue editor will show scrollbars to indicate where there's more nodes outside of the current view. Drag the scrollbars to pan the view. You can also right-click or middle-click the mouse and drag to move the dialogue view in a desired direction.<br /> <br /> If you want an overview of the dialogue tree, you can zoom the dialogue view by scrolling the mouse-wheel.<br /> <br /> If you want to center the view on a node, select the node and hit the '''HOME''' key on your keyboard.<br /> <br /> = Speakers =<br /> Every dialogue is written for a certain set of characters. These characters are the actors of the dialogue. Every dialogue keeps these actors in a list, called the Speakers. They indicate who says what in the dialogue. This Speaker list has a certain order. For example, say we have a dialogue between Bill and Ted. Bill would be speaker 1 (and be in the first slot) and Ted would be speaker 2 (and be in the second slot). Nodes refers to these slot to see who's saying the text contained in.<br /> <br /> In our dialogues players will always be the last Speakers in the list. That's because we can have dialogues where depending on the situation more than 1 player can be active in a dialogue. Since we don't want to disrupt the order of the other Speakers, we add players in the back.<br /> <br /> For Question nodes, the Speaker of the node also determines who has to select the question.<br /> <br /> == Editing Speakers ==<br /> At the top right of the Dialogue Designer window you can find the Speaker Editor:<br /> <br/><br /> [[File:Dialog_Speakers.png]]<br /> <br /> Click the ''Edit'' button to open up the Speaker Editor. The Speaker Editor will open and show the current Speakers assigned to the slots (if any):<br /> <br/><br /> [[File:Dialog_SpeakerEditor.png]]<br /> <br /> Click the ''Add'' button to add a Speaker Slot to the current dialogue:<br /> <br/><br /> [[File:Dialog_SpeakerAdd.png]]<br /> <br /> The slot with the grey background is the currently selected item. This is important if you want to change the order of the slots with the ''Move Up'' and ''Move Down'' buttons.<br /> <br /> To select a Speaker Slot, just click it with the left mouse button.<br /> <br /> The ''Delete'' button removes the currently selected slot from the list. When the removed slot is still used in the dialog, a messagebox will pop up asking you if you want to replace the speaker by another speaker. All occurrences of the removed speaker (in flags, speaker, animations...) will then be replaced by the selected speaker.<br /> <br /> Click the ''Edit'' button next to a slot to start assigning Speakers to that slot:<br /> <br/><br /> [[File:Dialog_AssignSpeaker.png]]<br /> <br /> You'll see 2 lists. All the available Speakers in the game and the active Speakers in the selected slot. A slot can have more than 1 speaker assigned to it. This is because some dialogues can be said by several NPCs (think flavour automated dialogues).<br /> <br /> To assign a Speaker to the current slot you have to move Speakers from the Available list to the Active List. You can do this in two ways:<br /> * Double-click a Speaker from the Available Speakers list<br /> * Select one or more Speakers from the Available Speakers list and click the ''>'' button. Use the ''CTRL'' key on your keyboard to add or remove Speakers to your selection.<br /> <br /> To remove Speakers from the current slot, you have to move them from the Active list to the Available Speakers list. You can do this in two ways:<br /> * Double-click a Speaker from the Active Speakers list<br /> * Select one or more Speakers from the Active Speakers list and hit the ''<'' button. Use the ''CTRL'' key on your keyboard to add or remove Speakers to your selection.<br /> <br /> You can use the ''Filter'' textbox to search for speakers in the list of ''Available Speakers''.<br /> <br /> Once you're done, click the ''OK'' button and you'll see your Speakers show up in your selected slot.<br /> <br/><br /> [[File:Dialog_SpeakersAssigned.png]]<br /> <br /> Click the ''OK'' button in the Speaker Editor to close it and keep your changes. The ''Cancel'' button will close the Speaker Editor without saving your changes.<br /> <br /> Once you're done assigning Speakers to your slots, they'll show up in the drop down list in the upper right:<br /> <br/><br /> [[File:Dialog_Speakerdrop.png]]<br /> <br /> == The Narrator Speaker ==<br /> Sometimes you want a node to be spoken by a narrator instead of any of the Speakers inside the dialogue. To handle that case there's a special Narrator Speaker provided. This Speaker can not be found in the Speaker List of the Dialogue and needs to be assigned manually to the Nodes you want to be said by the Narrator:<br /> <br/><br /> [[File:Narrator.png]]<br /> <br /> For more info on ''Assigning Speakers'' see [[#Assigning Speakers to Nodes|Assigning Speakers to Nodes]].<br /> <br /> '''NOTE''': this Speaker is not available for every node type. This is because it simply doesn't make sense for all nodes to have support for this. At the moment only Greeting and Answer nodes support the Narrator Speaker.<br /> <br /> The Narrator Speaker is there for voice recording reasons and as such can not be used to set or check Flags and/or Tags on!<br /> <br /> == Assigning Speakers to Nodes ==<br /> <br /> Not all nodes have a Speaker, only nodes that have text inside of them need one. In our case these are the Greeting, Answer and Question nodes. To assign a Speaker to them, select the node and in the properties panel look for the Speaker property:<br /> <br/><br /> [[File:Speakers.png]]<br /> <br /> Selecting the Speaker property in the grid will show a button that opens up a dropdown list with the current Speakers. Select the speaker from the dropdown list to assign it to that Node.<br /> <br/><br /> [[File:Dialog_SpeakerNodeDropdown.png]]<br /> <br /> By default, Answer and Greeting nodes will select the first Speaker slot as their Speaker. Questions default to the last Speaker Slot. This is in keeping with the fact that players will be added to the back of the Speaker list.<br /> <br /> == Addressed To Property ==<br /> This property indicates who the Speaker of the node is talking to. This is an optional property. If nothing is filled in, the game will select a default value. At the moment this property is only used for localization purposes.<br /> <br /> == Speaker Groups ==<br /> We've already mentioned that a Speaker Slot can contain more than 1 speaker. This is to support generic dialogues that can be said by more than 1 character. For example a generic "Hello" dialogue that's assigned to several citizens in a town. You would then have to assign every citizen as a Speaker in that "Hello" dialogue. Some times you don't know beforehand who's going to be able to say something or the list of speakers is just too long to manually assign them all. That's why the dialogue editor also supports Speaker Groups. Speaker Groups simply group a number of Speakers together so that you can assigned the group to a Speaker Slot instead of each speaker individually.<br /> <br /> === Creating Speaker Groups ===<br /> Creation and editing of Speaker Groups is done through the Speaker group Editor. This is a tool that's found in the ''Tools'' menu of the dialogue editor:<br /> <br/><br /> [[File:Dialog_ToolsSpeakerGroups.png]]<br /> <br /> Click it and the Speaker Group Editor will open.<br /> <br/><br /> [[File:SpeakerGroupEditorEmpty.png]]<br /> <br /> The Speaker Group Editor will scan the game for all characters and items to see in which groups they are. That way you can see exactly which characters are in which groups or in no groups at all. While it's looking through the characters, you'll see the icon animate in the top right:<br /> <br/><br /> [[File:Dialog_SpeakerRefreshing.png]]<br /> <br /> While it's refreshing the Speaker list you are free to edit Speaker Groups.<br /> * To add a Speaker Group click the ''Add'' button. This will create a new Group with a default name. You can change the name in the Speaker Group properties.<br /> * To remove a Speaker Group, select a Group from the list and click the ''Remove'' button.<br /> * Filtering is possible for a part of the name or the full uuid.<br /> <br /> ==== Speaker Group Properties ====<br /> When you select a Speaker Group from the list the right part of the editor will display an overview of that Speaker Group:<br /> <br/><br /> [[File:SpeakerGroupEditor.png]]<br /> <br /> This overview shows which Speakers are assigned to the Group, along with a number of properties of the group.<br /> <br /> ; UUID : Each Speaker Group has a unique identifier. This is used by the game so you don't have to update the Speaker Groups for your characters or items if you decide to rename a group. This is automatically generated for oyu and can not be modified.<br /> ; Name : This is a logical name for your Speaker Group. This is the name that will be shown in the Speaker list in the dialogue editor. As a convention we start Speaker Groups with the "GROUP_" prefix.<br /> ; Description : This is a text field that contains a description for this Speaker Group. Can be useful for voice recording purposes.<br /> ; Mod : This property shows in which game module this Group was defined. Groups that are unique to a certain game should be created in that game's module. Groups that are shared between games should be created in the Shared module.<br /> ; Overwrite speaker : If an override speaker is defined for a group, the speaker of that character will be used for the voice data. The uuid of the character should be filled in here. An override speaker is a speaker that will be used to voice all characters in this group when this group is assigned as speaker in a dialogue node (e.g. the God King voices most voidwoken in the main campaign).<br /> <br /> === Looking for a specific Speaker ===<br /> The Speaker Group Editor also provides you with an option to look for a certain Speaker. You can do this by pressing the CTRL-F key combination on your keyboard or by selecting the find option from the Edit menu:<br /> <br/><br /> [[File:Dialog_SpeakerFind.png]]<br /> <br /> The Find Speaker window will pop up:<br /> <br/><br /> [[File:Dialog_SpeakerSearch.png]]<br /> <br /> Enter text to search for in the Search For text box. The checkboxes in Search Locations determines where the editor will look for the text:<br /> ; Name : The editor looks in the name of the Speaker for a match<br /> ; UUID : The editor looks in the unique identifier of the Speaker for a match<br /> <br /> You can select both locations to search in both the UUID and the Name of Speakers. If you tick the Match Case check box, only Speakers are returned if they contain the text with a matching case.<br /> <br /> The results are displayed at the bottom of the screen. It contains 3 columns:<br /> ; Name : Name of the Speaker<br /> ; UUID : Unique identifier of the Speaker<br /> ; Groups : All the Speaker Groups this Speaker is assigned to<br /> <br /> {{warning|The editor only looks through the Speakers it has found so far. This means that he might not return all Speakers if the Refreshing icon is still animating!}}<br /> <br /> === Assigning Speakers to Speaker Groups ===<br /> Speaker Groups are assigned on the individual characters and items themselves. They can belong to more than 1 Speaker Group. To assign a Speaker Group to a character or item, select it in the editor and open up the proeprties panel ('''CTRL-B''' by default).<br /> <br /> Look for the ''Speaker Group'' property in the properties pane of the object:<br /> <br/><br /> [[File:Dialog_CharacterProperties.png]]<br /> <br /> Select the property and click the button to open up the Speaker Group Assignment Editor:<br /> <br/><br /> [[File:Dialog_SpeakerGroupAssign.png]]<br /> <br /> The available Speaker Groups are in the ''Available groups'' list. The currently assigned Speaker Groups are in the ''Assigned Speaker Groups'' list.<br /> <br /> The Speaker Group Assignment Editor also lists the Speaker Groups that were set on the Root Template for this object.<br /> <br /> To assign this object to certain Speaker Groups, you have to select groups and put them in the '''Assigned Speaker Groups'' list. There are two ways to do this:<br /> * Double-click a Group from the ''Available groups'' list<br /> * Select a Group from the ''Available groups'' list and click the ''Assign'' button.<br /> <br /> To remove this Object from a certain Speaker Group, you have to remove the Group from the Assigned Speaker Groups list. There's 2 ways to do this:<br /> * Double-click a Group in the ''Assigned Speaker Groups'' list<br /> * Select a Group in the ''Assigned Speaker Groups'' list and click the ''Remove'' button.<br /> <br /> Click the ''OK'' button to apply your changes and close the Speaker Group Assignment Editor. Click the ''Cancel'' button to close the Speaker Group Assignment Editor without applying your changes.<br /> <br /> = Adding Text to Nodes =<br /> To add text to a node or edit the existing text, double click on the node. This will open the 'Edit Tagged Texts' window.<br /> <br/><br /> [[File:EditText.png]]<br /> <br /> To add a tagged text, click the add button. This will add a new Tagged text form. The text for the node can be entered in the textbox.<br /> <br/><br /> [[File:EditText2.PNG]]<br /> <br /> A tagged text can have multiple text blocks. To add a new text block, click the ''Add'' button. This will add an extra textbox. To remove one, click the ''X'' button. One of the text blocks will be randomly chosen when the dialog plays.<br /> <br/><br /> [[File:EditText3.PNG]]<br /> <br /> To personalize the text, you can add multiple Tagged Text forms and define rules on which one to choose while playing the dialog. This way, you can show a different text depending on whether the players are dwarves or elves.<br /> <br/><br /> [[File:Edit_Text4.png]]<br /> <br /> The tagged texts are checked in the given order (see numbers on top, left to right, top to bottom). The first one that meets the conditions, is chosen. <br /> The first text block will be shown in the dialog node in the editor.<br /> <br /> == Defining Rules ==<br /> A rule will check if all/any/none... members of the speakergroup or a single speaker have/has the given tag(s). To add a rule, click the ''+'' button, to remove one, click the ''-'' button.<br /> <br /> === Show this when All/Any of the following rules are valid ===<br /> When choosing ''All'', all of the conditions needs to be met before that tagged text is chosen. When choosing ''Any'', only one condition needs to be met. It doesn't matter which one.<br /> <br /> === Conditions ===<br /> There are 5 options:<br /> ; Has all : will check if all members of the specified group have the given tag.<br /> ; Has any : will check if there is at least one member in the group who has the given tag.<br /> ; Has none : will check if there are no members in the group with the given tag.<br /> ; And all : will make a subgroup of rules. All rules in the subgroup should be met.<br /> ; And any : will make a subgroup of rules. Only one of the rules in the subgroup has to be met.<br /> <br /> === Speaker ===<br /> Choose a speaker or speaker group on which the rule should be checked.<br /> <br /> === Tags ===<br /> By clicking on the '...' button, the ''Add Tags'' window can be opened in which you can choose multiple tags.<br /> <br/><br /> [[File:AddTags.png]]<br /> <br /> On the ''Available Tags'' tab, you can see all the possible tags that can be chosen. The ''Current Tags'' tab shows all the tags that are used in the current node's tagged text block checks. The filter can be used to search for specific tags.<br /> <br /> == Example ==<br /> [[File:RulesComplicated.png]]<br /> <br /> In the above example, we have two subgroups: 2 and 2c. 2c is a subgroup in subgroup 2.<br /> <br /> The tagged text for this set of rules will be selected when:<br /> * 1 and 2 are met (because of ''Show this when ALL of the following rules are valid''.<br /> * 2 is met when any rule in 2 is met (because of the ''And Any of the following rules''). So when 2a, 2b OR 2c is met.<br /> * 2c is met when all of the rules in 2c are met (because of the ''And All of the following rules''). So when 2c' AND 2c<nowiki>''</nowiki> are met.<br /> <br /> = Node Properties and Node Types =<br /> In this section we'll cover the Node properties in detail. Not all Node Types will have the same properties, but all Text Nodes (nodes that display text in the dialogue) shared a set of common properties. We'll look at those first.<br /> <br /> == Base Text Node Properties ==<br /> Greeting, Answer and Question nodes are all Text Nodes. As such they all share a number of properties:<br /> <br/><br /> [[File:NodeProperties2.png]]<br /> <br /> === Addressed To ===<br /> In some languages, a sentence being said to a man is different than the same sentence being said to a woman.<br /> <br /> English: You are beautiful<br /> <br /> French: Tu es beau (to a man) vs Tu es belle (to a woman)<br /> <br /> To be able to choose the right version, we need to know to whom the sentence is addressed. This information is stored in the ''Addressed To'' property.<br /> <br /> If no ''Addressed To'' speaker is specified, it will be addressed to the first speaker (that is not the ''Speaker'' of the node). If a ''Look At'' value is set for this node, the speaker of that property is taken.<br /> <br /> === EndNode ===<br /> Checking this checkbox (and thus setting it to True), means that the dialogue will stop executing after this node has been shown. You'll see that the Node turns red to indicate it is an End Node now. You also can't connect nodes to an End Node.<br /> <br/><br /> [[File:Dialog_EndNode.png]]<br /> <br /> === Exclusive ===<br /> Normally a dialog selects a node to display out of the list of valid nodes at the point of execution. Out of all those valid nodes it selects a random node. When the dialog encounters one or more valid Exclusive nodes in that list, it stops considering all non-exclusive nodes. This means that the dialog will select a random node from the group of valid Exclusive nodes. This can be used to alter the flow of a dialog in case a certain condition is set and the dialog shouldn't take the normal path. For more info check [[#Controlling Dialogue Flow|Controlling Dialogue Flow]].<br /> <br /> === Logical Name ===<br /> This is a human-readable name that's useful to provide context for a dialog node. Can be useful for making the use of a node clear and for voice recordings. The logical name is displayed at the top of a node in the dialog overview.<br /> <br /> === Optional ===<br /> Optional nodes function as normal nodes unless the dialog doesn't encounter any valid nodes when looking for a node to show. If the dialog doesn't encounter any valid nodes, but it has a list of optional nodes, it'll select a random node out of the optional nodes and skip it. The selected optional Node will not be shown then, but the dialog will progress as if that Node was shown. Note that the nodes are '''skipped''', that means '''none''' of the actions of the nodes are performed (so no flags are set). For more info see [[#Controlling Dialogue Flow|Controlling Dialogue Flow]].<br /> <br /> === Shown Once ===<br /> When ''Shown Once'' is checked the node will only be shown once during a dialog instance. The node will be shown again when the dialog starts again.<br /> <br /> === Speaker ===<br /> Who says the text in this Node? For Question Nodes this also decides who has to click the question. Clicking this property allows you to chose a value from a dropdown list containing all the Speaker Slots defined in this dialogue.<br /> <br /> === Stub ===<br /> Indicates that this node is a work in progress (not used in practice).<br /> <br /> === Tags ===<br /> The ''tags'' property can be used to assign multiple tags to a dialog node. The '''SFX_ONLY''' tag can be used on dialog nodes that don't need to be voiced.<br /> <br /> === Texts in this Node ===<br /> List of all the texts contained in this node. More about the texts and how to create them in [[#Adding Text to Nodes|Adding Text to Nodes]].<br /> <br /> === UUID ===<br /> Unique identifier of this node. This is generated for you and can't be changed.<br /> <br /> === Transition Mode ===<br /> Indicates how the dialog progresses when it encounters this Node. It has 2 possible settings.<br /> <br /> ==== Wait for input ====<br /> This is the default setting. The dialog will display the node and then wait for a user to click ''continue'' (or ''end'' in the case of an End Node)<br /> <br /> ==== Wait X seconds ====<br /> The dialog will show the node and then wait X seconds before it shows the next node in the dialogue tree. X is a number that you can fill in when you select this transition mode:<br /> <br/><br /> [[File:Dialog_TransitionMode.png]]<br /> <br /> === Flags to Check ===<br /> Which flags is this Node checking? More about flags in [[#Controlling Dialogue Flow|Controlling Dialogue Flow]].<br /> <br /> === Flags to Set ===<br /> Which flags is this Node setting? More about Flags in [[#Controlling Dialogue Flow|Controlling Dialogue Flow]] and [[#Flags to Set property|Flags to Set property]].<br /> <br /> === Node Context ===<br /> What's the context for this Node? Use this to clarify a Node or for voice recording purposes, or as comments for yourself or others about this node (never shown to players).<br /> <br /> == Text Nodes ==<br /> <br /> === Greeting ===<br /> [[File:Dialog_Greeting.png]]<br /> <br /> These nodes indicate where a dialogue starts executing. They form the roots of the dialogue tree.<br /> <br /> === Question ===<br /> [[File:Question.png]]<br /> <br /> These Nodes are used to ask questions to other Speakers in the dialogue. When a dialogue encounters these nodes it'll present a list with all valid Question nodes to the Speaker that owns the Nodes.<br /> <br /> {{warning|You cannot have a mix of valid ''Answer Nodes'' and ''Question Nodes'' as children of a single Node. When that happens the game will warn you and ignore the ''Answer Nodes''.}}<br /> <br /> === Answer ===<br /> [[File:Dialog_Answer.png]]<br /> <br /> These nodes are simple text entries. Most commonly used as replies to player Questions.<br /> <br /> === Logic Nodes ===<br /> The Nodes in this section do not contain any text themselves and only exist to change the flow or to simplify the structure of a dialogue. As a result these Nodes do '''not''' have the base Text Node properties, but have their own (small) set of properties.<br /> <br /> ==== Jump Nodes ====<br /> Jump Nodes are Nodes that reference other Nodes. They are a way to re-use nodes or as a means to keep dialogue structure cleaner by cutting down on the number of child connections needed. A Jump Node is constructed by pointing it to another node in the dialogue.<br /> <br /> ===== Properties =====<br /> ; Jump To : This indicates which Node(s) a Jump node references. This Property can have 2 values:<br /> :; Start of Node : This Jump node references the pointed to Node. This is as if the pointed to Node and its children are inserted at the point of the Jump Node.<br /> :: {{warning|The pointed-to Node still needs to be valid before it can be shown (flag checks need to pass).}}<br /> :; End of Node : This Jump Node references the children of the pointed-to Node. This is as if the parent Node of this Jump Node has all children of the pointed-to Node connected to it.<br /> :: {{warning|The pointed-to Node does '''not''' need to be valid. The children of the pointed-to Node are still validated though.}}<br /> ; Target Node UUID : The UUID of the Node this Jump Node is pointing to. You can not change this. To see which Node this is, double click the Jump Node and the editor will center the view and select the pointed-to Node.<br /> ; UUID: The unique identifier of this Node. You can not change this.<br /> <br /> ===== Creating Jump Nodes =====<br /> # Select a Node that accepts children and select Jump Node from the Node Context menu.<br /> #:[[File:Dialog_JumpNode.png]]<br /> # Your cursor will now change into a targetting cross.<br /> # Select a node in the dialog to create a reference to that Node. <br /> #:[[File:Dialog_JumpCreated.png]]<br /> <br /> If you want to cancel the creation of a ''Jump Node'', you can press the '''ESCAPE''' key.<br /> <br /> Once your Node has been created you can set the ''Jump To''-property to change which node(s) it references.<br /> <br /> == DOS specific Nodes ==<br /> The Nodes in this section are not part of the Dialogue framework. they are Nodes that were created specifically for Divinity: Original Sin. These may or may not be available in other games.<br /> <br /> === Pop Nodes ===<br /> [[File:Dialog_Pop.png]]<br /> <br /> Pop Nodes are Nodes that were introduced to support the old Keyword dialogues. They function much like a ''Jump Node'' that always points to the End of a Node.<br /> <br /> ==== Properties ====<br /> ; Exclusive : Functions the same as the ''Exclusive'' property of Text Nodes. See [[#Exclusive|Exclusive Property]].<br /> ; Pop Count : How many levels the Node should go back. This a number that starts from 0. See [[#Pop Levels]] for more information.<br /> ; UUID : The unique identifier of this Node.<br /> <br /> ==== Pop Levels ====<br /> Every time a list of Quesiton Nodes is presented, a ''pop level'' is created. This is a point in the dialogue that Pop Nodes can refer to, to present a list of Questions to the player.<br /> <br /> The Pop Node then functions as a Jump Node that jumps back to the end of the Parent Node of the specified level of Question Nodes. To see how many levels to jump back to, you have to go back X+1 Question Nodes in the dialogue tree, starting from the Pop Node. X is the value you filled in for the Pop Count property. You can see which node a Pop Node it's targetting by double clicking the Pop Node. If the Pop Node can't Jump back to the specified pop level you'll get an error message in the editor when double clicking the Pop Node.<br /> <br /> === Dual Dialog Node ===<br /> [[File:Dialog_DualDialog.png]]<br /> <br /> Dual Dialog Nodes are Nodes that pause the current dialogue and ask the Game Scripting to start a certain sub-dialog. These sub-dialogs are typically decission dialogues between 1 or more players. When the sub dialogue ends, the current dialogue resumes again.<br /> <br /> ==== Properties ====<br /> ; Dual Dialog Name : This is the name (without file extension) of the sub dialog to start. Double clicking the Dual Dialog content, tries to open or switch to a dialog editor for the pointed-to sub dialog.<br /> ; Exclusive : Functions the same as the Exclusive property of Text Nodes. See [[#Exclusive|Exclusive Property]].<br /> ; Logical Name : Functions the same as the Logical Name property of Text Nodes. See [[#Logical Name|Logical Name Property]].<br /> ; Optional : Functions the same as the Optional property of Text Nodes. See [[#Optional|Optional Property]].<br /> ; Shown Once : Functions the same as the Shown Once property of Text Nodes. See [[#Shown Once|Shown Once Property]].<br /> ; UUID : The unique identifier of this Node.<br /> <br /> === Persuasion Nodes ===<br /> <br /> == Game specific Node Properties ==<br /> In addition to the built-in Node Properties, a game can also add custom properties to Nodes. These Properties are on the Advanced tab of the properties sidebar:<br /> <br/><br /> [[File:Dialog_GameProperties.png]]<br /> <br /> === DOS Node Properties ===<br /> Divinity Original Sin has a couple of Node options that are unique to this game. These are all applied to the Text Nodes (Greeting, Question, Answer).<br /> <br/><br /> [[File:GameNodeProperties.PNG]]<br /> <br /> ==== Sound ====<br /> ; Sound Event : This is the id of an additional sound that is started when the node is started (eg. evil music when an evil answer is chosen).<br /> ; Instruments : This is the id of a sound for a specific instrument. Depending on the instrument the player choose, the sound for the given instrument will be played. If there is a sound event set, the instrument sound will not be played.<br /> <br /> ==== Animation ====<br /> ; Emotional Expression : This determines which animation the Speaker of this Node will play. Can also be used as a hint to the voice actors. '''If an animation for the Speaker of this Node is set as well, the emotional expression will not be played'''.<br /> ; Look At : You can define per dialog Node what Speaker a certain Speaker needs to face when the Node starts. This is done by defining Look-At entries. You can add an entry by clicking the Add button. This will add an empty Look-At entry:<br /> :[[File:GameNodePropertiesAddLookat.png]]<br /> :<br /> :Pressing the Add button again will add more empty Look-At entries to this node. <br /> :The two dropdown boxes control which Speaker looks at which Speaker. The first one is the NPC that's going to face a certain Speaker. The second one is the target Speaker. '''You can only select Speakers that :were assigned to this dialog!'''<br /> :<br /> :You can delete a Look-At entry again by clicking the Delete button:<br /> :[[File:GameNodePropertiesDeleteLookat.png]]<br /> :To copy paste the look at property to another node in the dialog, click the 'Copy' button, select another node and click the 'Paste' buttons.<br /> ; Animations : For each speaker, an animation can be set that will be performed during that dialognode. To add an animation, click the add button.<br /> :[[File:GameNodePropertiesAddAnimation.png]]<br /> :Choose one of the speakers and fill in the name of an animation. <br /> :Copy-pasting and deleting an animation can be done the same way as for 'Look at'.<br /> :<br /> :If an animation for the speaker of the selected node AND an 'Emotional expression' (which is also for the speaker of the selected node) is set, only the animation will be played.<br /> <br /> ==== Game ====<br /> ; Camera Target : The camera is, by default, following the speaker in a dialog. Choose another speaker from the list to target the camera on another player during the dialog node.<br /> ; Extra node time : If a node needs to be shown longer than normal, that extra time can be set in the ''Extra node time'' property. This time will be added to the default node time (based on the amount of words), the length of the voice data or the ''Wait time'' set for nodes with the ''Wait for x seconds'' node transition mode.<br /> <br /> = Controlling Dialogue Flow =<br /> All the Nodes in a dialogue form a tree by connecting with their parents and children. The game then walks through the dialogue tree to figure out which Nodes to show to players and when. It does this by starting at the roots of the tree, selecting a root to show and from that root working itself through the branches towards the leaves that are connected to it. The [[#Greeting|Greeting Nodes]] form the roots of the tree, so this is where all dialogues will start. The leaves are the End Nodes in a dialogue, and this is where execution of a dialogue stops.<br /> <br /> == Node validation ==<br /> When a dialogue starts, the game looks through all of the roots of that dialogue and validates them. Validating a node means checking all the conditions that are put on the Node. Only Nodes that pass this test are considered for display. The game performs a similar test for the non-root Nodes that are connected to a root: only the valid nodes are considered for display.<br /> <br /> Validating a Node is a process that results in a boolean value. You can think of a boolean value as a truth value, something that is either '''true''' or '''false'''. So validating a node results in 2 possible truths: the node is either valid ('''true''') or invalid ('''false''').<br /> <br /> === Node Conditions ===<br /> While a game can have custom validation requirements on a Node, most of the conditions are put on Nodes through the [[#Flags to Check|Flags to Check]] property of Nodes. A Flag is also a boolean value. It can either be set ('''true''') or not set ('''false'''). By default, Flags start out as being not set and are thus considered to be '''false'''.<br /> <br /> The ''Flags to Check'' property is a list of flags that need to have a certain value (set or not set) if a Node is to be considered valid. Each entry of this list compares the boolean value of the specified Flag with a desired boolean value. If the boolean value of the Flag matches the desired boolean value, the games considers that entry to be '''true'''. If the two boolean values don't match it considers that entry to be '''false'''. The games calculates if a Node is valid or not, by combining all of the boolean values of the entries of that list. We'll see how we can combine boolean values in the next section.<br /> <br /> ==== Boolean Logic ====<br /> Boolean Logic describes how we can combine two boolean values to come up with a new boolean value that's the combination of the two input values. We call the way we combine the 2 input values an operator. It's something that operates on 2 input values to produce a new output value. There's several operators you can use to combine boolean values, but we'll stick to the ones used by the dialogue system in this section.<br /> <br /> ===== The AND operator =====<br /> The AND operator is used to enforce that the two input values passed to it are '''true'''. '''If and only if''' the two input values are '''true''' will the AND-operator return '''true''' as well. As soon as one (or both) of the inputs are '''false''' it will return '''false''' as well.<br /> <br /> To summarize:<br /> * '''true''' AND '''true''' gives us '''true'''<br /> * '''false''' AND '''true''' gives us '''false'''<br /> * '''true''' AND '''false''' gives us '''false'''<br /> * '''false''' AND '''false''' gives us '''false'''<br /> <br /> ===== The OR operator =====<br /> The OR-operator is more lenient than the AND operator. It returns '''true''' as soon as any of the two input values is '''true'''. That means it will only return '''false''' if both input values are '''false''' too.<br /> <br /> To summarize:<br /> * '''true''' OR '''true''' gives us '''true'''<br /> * '''false''' OR '''true''' gives us '''true'''<br /> * '''true''' OR '''false''' gives us '''true'''<br /> * '''false''' OR '''false''' gives us '''false'''<br /> <br /> ===== The NOT operator =====<br /> The NOT operator simply returns the inverse of whatever you put into it. That means that NOT '''true''' will result in '''false'''. Similarly NOT false will result in true.<br /> <br /> To summarize:<br /> * NOT '''true''' gives us '''false'''<br /> * NOT '''false''' gives us '''true'''<br /> <br /> ==== Validating a Node ====<br /> Now that we know how to combine boolean values, we can look at how the game checks the [[#Flags to Check]] property of Node. Like we already mentioned, this property is a list of Flags that need to be set ('''true''') or not set ('''false''') before this Node is considered valid (and thus, considered for display). It compares the boolean values of the flags with the desired boolean value and considers an entry true if they match. If they don't match it considers the entry '''false'''. The game then combines all of these boolean values using the AND operator. This means that a Node is only valid if that list only contains '''true''' values. As soon as that list of entries contains a '''false''', the node is considered invalid.<br /> <br /> ==== Adding Flag Checks ====<br /> To add a Flag check to a Node, select the Flags to Check property of the Node in the properties sidebar and click the edit button:<br /> <br/><br /> [[File:Dialog_AddNodeCheck.png]]<br /> <br /> You'll get the Flag Editor screen:<br /> <br/><br /> [[File:Dialog_FlagCategories.png]]<br /> <br /> Select the Flag Category you want to add a Flag to from the Flag Categories list. You will then be presented with an overview of this Flag Category:<br /> <br/><br /> [[File:Dialog_AddingFlags.png]]<br /> <br /> The top list box shows all available Flags of the selected type. This is a list of all the Flags used in the whole dialogue or a list of all defined Tags (see [[Tag_editor]] to define Tags) in the case of the Tags Flag type.<br /> <br /> The bottom list box, the ''Active flags'' list box, shows the Flags that are active on the currently selected Node.<br /> <br /> Type the name of the Flag you want to add in the ''Custom flag'' text field and click the Add button to add a new Flag. The new Flag will be automatically added to the Active flags list.<br /> <br /> To remove a Flag from the currently selected Node, move the Flag from the ''Active flags'' list to the top list box. You can do this by double clicking the Flag in the ''Active flags'' list box or by selecting it in the ''Active flags'' list and clicking the up arrow button.<br /> <br /> To add an already defined Flag to the currently selected Node move it from the top list box to the ''Active flags'' list. You can do this by double clicking the Flag in the top list or by selecting it in the top list and clicking the down arrow button.<br /> <br /> Hit the ''OK'' button when you're done adding flags and apply your changes. Or hit the ''Cancel'' button to discard your changes and close the Flag Editor.<br /> <br /> ==== Practical Examples ====<br /> Let's say we have a node that we want to show if a certain local flag (called ''localFlag'') hasn't been set and if a certain global flag (called ''globalFlag'') is set. More concrete this means that this node is valid if:<br /> * ''localFlag'''s value has to be false.<br /> *: AND<br /> * ''globalFlag'''s value has to be true.<br /> This translates into the following Flags to Check property:<br /> <br/><br /> [[File:Dialog_NodeChecks.png]]<br /> <br /> As you can see, a checked checkbox indicates that we want a desired value of '''true'''. An unchecked checkbox indicates that we want a desired value of '''false'''.<br /> <br /> When validating this Node the game performs these steps:<br /> # build a list of all Flag checks: we have 2. Checking if ''localFlag'' is not set and checking if ''globalFlag'' has been set.<br /> # Compares the value of ''localFlag'' with the desired value of '''false''' and puts the result in a list.<br /> # Compares the value of ''globalFlag'' with the desired value of '''true''' and puts the result in a list.<br /> # Goes over the list created in step 2 and 3 and combines the boolean values with the AND operator<br /> <br /> Let's see how this work with the concrete case where ''localFlag'' is not set and ''globalFlag'' is set:<br /> # build a list of all Flag checks: we have 2. Checking if ''localFlag'' is not set and checking if ''globalFlag'' has been set.<br /> # ''localFlag'' is not set, so has a value of '''false'''. This equals our desired value of '''false'''. So we put '''true''' in the list<br /> # ''globalFlag'' is set, so has a value of '''true'''. This equals our desired value of '''true'''. So we put '''true''' in the list<br /> # We go over the result list and combine our results with the AND operator:<br /> # '''true''' AND '''true''' gives us '''true'''<br /> <br /> We ended up with a result of '''true''', so this Node is considered valid.<br /> <br /> Let's change our Flags to Check property to the following:<br /> <br/><br /> [[File:Dialog_NodeChecks2.png]]<br /> <br /> And let's again use the case where ''localFlag'' is not set and ''globalFlag'' is set:<br /> # build a list of all Flag checks: we have 2. Checking if ''localFlag'' is set and checking if ''globalFlag'' has not been set.<br /> # ''localFlag'' is not set, so has a value of '''false'''. This does not equal our desired value of '''true'''. So we put '''false''' in the list<br /> # ''globalFlag'' is set, so has a value of '''true'''. This does not equal our desired value of '''false'''. So we put '''false''' in the list<br /> # We go over the result list and combine our results with the AND operator:<br /> # '''false''' AND '''false''' gives us '''false'''<br /> <br /> This means our Node is invalid.<br /> <br /> Now let's look at an example with more than 2 entries in our check list:<br /> <br/><br /> [[File:Dialog_NodeChecks3.png]]<br /> <br /> Let's assume that ''localFlag'' is set, ''otherLocalFlag'' is set and ''globalFlag'' is not set:<br /> <br /> # build a list of all Flag checks: we have 3. Checking if ''localFlag'' is set, checking of ''otherLocalFlag'' has not been set and checking if ''globalFlag'' has not been set.<br /> # ''localFlag'' is set, so has a value of ''''''true''''''. This equals our desired value of ''''''true''''''. So we put ''''''true'''''' in the list<br /> # ''otherLocalFlag'' is set, so has a value of ''''''true''''''. This does not equals our desired value of ''''''false''''''. So we put ''''''false'''''' in the list.<br /> # ''globalFlag'' is not set, so has a value of ''''''false''''''. This equals our desired value of ''''''false''''''. So we put ''''''true'''''' in the list<br /> # We go over the result list and combine our results with the AND operator:<br /> # ''''''true'''''' AND ''''''false'''''' AND ''''''true''''''<br /> # We combine from left to right:<br /> # (''''''true'''''' AND ''''''false'''''') AND ''''''true'''''' <br /> # which turns into:<br /> # ''''''false'''''' AND ''''''true''''''<br /> # which gives us: ''''''false''''''<br /> <br /> This Node is considered invalid for the flag values given in the example.<br /> <br /> ==== Visual Cue ====<br /> When a Text Node is checking Flags a little square is shown on the '''left''' of the Node. Hovering over this squares shows which Flags are being checked by that Node:<br /> <br/><br /> [[File:Dialog_FlagsToCheckHover.png]]<br /> <br /> The pop-up shows the type of the Flag that's being set and what value it's being set to in brackets. A value of '''True''' means we're checking if the flag is set. A value of '''False''' means we're checking if the flag is not set.<br /> <br /> === Node Selection ===<br /> So the dialogue now has a list of Nodes that can be potentially shown (either the roots of the dialogue or the branches and leaves flowing from those roots). It will then select a Node from this list to determine the next Node to show to players. It does this using the following process:<br /> <br /> # Collect all nodes that should be considered for display. This is all Root Nodes when the dialogue starts or all children of the previously shown Node<br /> # Validate all Nodes in this list:<br /> ##If an Optional Node and the Node is not valid: Keep in a list of Optional Nodes.<br /> ##If an Optional Node and the Node is valid: Keep in a list of Valid Nodes.<br /> ##if an Exclusive Node and the Node is valid: add to a list of Exclusive Nodes<br /> ##if a normal (not exclusive and not optional) Node and the Node is Valid: add to a list of Valid Nodes<br /> # Now select a Node to show from our lists:<br /> ##if we have Nodes in our Exclusive Nodes list: select a '''random''' Node from this list.<br /> ##'''ELSE'''<br /> ##if we have Nodes in our Valid Nodes list: select a '''random''' Node from this list<br /> ##'''ELSE'''<br /> ##if we have Nodes in our Optional Nodes list: select a '''random''' Node from this list<br /> <br /> After a Node has been selected for display, the game will execute the [[#Node_Actions|Actions]] attached to that Node.<br /> <br /> {{warning| For '''Greeting'''' Nodes, the size of the Exclusive Nodes list is limited to 1. This effectively means that the game will pick the first valid Exclusive Greeting Node to use as a starting point of the dialog. This can be used to simplify starting conditions of your dialogs by separating specific flows using Exclusive Greeting Nodes place at the top of your dialog.}}<br /> <br /> === Node Actions ===<br /> Some Nodes can have actions assigned to them that execute when the Node is selected for display. A game could add game specific actions to a Node, but the base Text Nodes (Greeting, Question, Answer) already come with a built-in action to set or un-set Flags.<br /> <br /> ==== Flags to Set property ====<br /> ''Flags to Set'' is a property that indicates which flags to set or un-set when this Node is selected as the next Node in a dialogue.<br /> <br /> ===== Adding and Removing Flags to Set =====<br /> It's very similar in function to the ''Flags To Check'' property:<br /> <br/><br /> [[File:Dialog_FlagsToSet.png]]<br /> <br /> Clicking the ''edit'' button when the property is selected will open up the same Flag Editor as seen in [[#Adding_Flag_Checks|Adding Flag Checks]].<br /> <br /> Setting a Flag is done by checking the checkbox in front of the Flag's name.<br /> <br /> Un-setting a Flag is done by unchecking the checkbox in front of the Flag's name.<br /> <br /> ==== Visual Cue ====<br /> When a Text Node is setting Flags a little square is shown on the '''right''' of the Node. Hovering over this squares shows which Flags are being set by that Node:<br /> <br/><br /> [[File:Dialog_FlagsToSetHover.png]]<br /> <br /> The pop-up shows the type of the Flag that's being set and what value it's being set to in brackets. A value of '''True''' means the flag is being set. A value of '''False''' means the flag is being un-set.<br /> <br /> == Types of Flags ==<br /> <br /> There are several types of Flags available in the dialogue editor. Each type of Flag is handled differently, so it's important to know when to use a certain type of flag.<br /> <br /> === Local Flags ===<br /> Local Flags are the simplest type of Flag and is the only built-in Flag type in the dialogue system. Local Flags are flags that can be set or unset and that are local to the context of the dialogue they're used in. That means that other dialogues or game scripts can not reference these Flags. The state of Local Flags is saved and is not reset between instances of dialogues. this means: if a dialogue sets a local flag, the next time you start the dialogue again the flag will still be set.<br /> <br /> '''Important''': Since those flags are local to a Dialogue, this means that if you assign a dialogue to multiple characters they all refer to the same Local Flags! If talking to one character sets a Local Flag, it will be set when talking to another character with the same dialogue!<br /> <br /> === Tag Flags ===<br /> Tag flags check/set tags on speakers. Tags can also be checked/set from script, and can be statically assigned to characters and items using the [[Sidebar|sidebar]].<br /> <br /> === Script Flags ===<br /> Script flags can only be checked. There is a script coupled to each Script flag. The script itself can be found under Tools > Edit script flags. See the [[#Script_Flag_Editor|Script Flag Editor]] for more details.<br /> <br /> === Global Flags ===<br /> Global Flags are simple Flags that can be accessed by scripts or other dialogues. They are not tied to any item, character or dialog.<br /> <br /> === Character Flags (DOS specific) ===<br /> A Character Flag is a Flag that's tied to a specific character (or item). They are often used to indicate that a certain character knows or did something. They can be used in scripts and other dialogues.<br /> <br /> Character Flags can be set and unset but they always take a Speaker as a parameter. The Flags will then be set and unset for the character that's currently in the specified Speaker Slot.<br /> <br /> === User Flags (DOS specific) ===<br /> A User in DOS is a (human) player in the game. Every User controls a number of characters in the game. Similarly every playable character is assigned to a specific User. The User Flag is a shortcut for (un)setting a Character Flag on every character that's currently controlled by a specific User.<br /> <br /> User Flags, like Character Flags, take a Speaker as a parameter. The User Flag will then take the User that controls the character in the specified Speaker Slot and set a Character Flag for every character currently controlled by that Speaker. Checking if a certain User Flag is set, means going over the User's characters and checking if any of them have the Character Flag set. To clarify: as soon as a single character has the Character Flag set, the User Flag will be considered set.<br /> <br /> === Party Flags (DOS specific) ===<br /> A party in DOS consists out of several characters. Those characters can be assigned to different Users. A Party Flag is a shortcut for (un)setting a Character Flag on all characters in a certain party.<br /> <br /> Party Flags also take a Speaker as parameter. The Party Flag will then take the party of the character in that Speaker Slot and (un)set the Character Flag on all characters currently belonging to that party. Checking if a Party Flag is set, means going over the party's characters and checking if any of them have the Character Flag set. To Clarify: as soon as a single character in the party has the Character Flag set the Party Flag will be considered set.<br /> <br /> == Script Flag Editor ==<br /> Adding, changing or removing a script flag can be done in the 'Edit script flags' window (Tools > Edit script flags).<br /> <br/><br /> [[File:EditScriptFlags.png]]<br /> <br /> A script flag has a uuid, a (unique) name, a description, the mod in which the script flag is defined and the filepath and the script itself. Script flags are saved in the dialogs folder under 'ScriptFlags'.<br /> <br /> The script itself consists of different conditions and a check at the end to define which combination of conditions should be true. Only the conditions mentioned below are supported at this time.<br /> <br /> === Syntax ===<br /> Script flags have the following syntax:<br /> CONDITION x<br /> [<br /> CONDITION y<br /> CONDITION z<br /> ]<br /> CHECK "<check string>"<br /> <br /> Where the CONDITIONs between square brackets are a list of CONDITIONS. You can have as many conditions as you want, but you need at least 1. <br /> Each CONDITION will be a script call that takes a number of parameters and produces a value that's either '''true''' or '''false'''. <br /> The "check string" that is used in the CHECK statement then defines a way to combine all of these returned values and produce a single '''true''' or '''false''' value. This value will be the value of the Script Flag. So if your CHECK string produces a '''false''' the Script Flag will be considered not set. Any Dialog Node that then checks for this flag to be '''true''' will be considered not valid. <br /> <br /> Let's look at the "check string" in a bit more detail. Every CONDITION you list in the Script section of a Script Flag gets a number. These numbers start from 1. So the first CONDITION will get 1, the second one gets 2 and so on. The "check string" refers to return values of CONDITIONs by using these numbers. The first CONDITION's return value, for example, is referred to as c1. The second CONDITION's return value is c2 and so on. All these return values are then combined following the [[#Boolean_Logic|Boolean Logic]] we outlined before. The Boolean operators supported by the Script Flags are:<br /> * | = OR<br /> * & = AND<br /> * ! = NOT<br /> <br /> So for example:<br /> {| class="wikitable"<br /> | '''CHECK "c1&c2"''' || Combine the return values of the first 2 CONDITIONs and combine them with the AND operator<br /> |-<br /> | '''CHECK "!c1&c2"''' || Use the NOT operator on the result of the first CONDITION and combine it with the result of the second CONDITION using the AND operator<br /> |-<br /> | '''CHECK "c1|c2"''' || Combine the return values of the first 2 CONDITIONS and combine them with the OR operator<br /> |}<br /> <br /> The second example uses the NOT operator '''only''' on the first CONDITION's result. What if we wanted to apply the NOT operator on the result of combining the return values of the first 2 CONDITIONs? We can use parentheses to group certain CONDITIONs and apply operators to that whole group:<br /> <br /> '''CHECK "c1&!(c2&c3)"'''<br /> <br /> This "check string" will combine the result of the first CONDITION with the '''inverse''' of the combination of the second and third CONDITION (combined using the AND operator here). Using parentheses combined with the boolean operators available gives you a lot of flexibility in creating complex conditions for Dialog Nodes.<br /> <br /> === Available Conditions ===<br /> <br /> ==== IsGlobalFlag ====<br /> CONDITION IsGlobalFlag(FlagName, Bool)<br /> <br /> Check if global flag has certain value<br /> <br /> ==== IsLocalFlag ====<br /> CONDITION IsLocalFlag(FlagName, Bool)<br /> <br /> Check if local flag has certain value<br /> <br /> ==== IsSpeakerFlag ====<br /> CONDITION IsSpeakerFlag(SpeakerIndex, FlagName, Bool)<br /> <br /> Check if speaker's character flag has certain value. If that speaker is not present, the result will always be '''false'''.<br /> <br /> ==== IsUserFlag ====<br /> CONDITION IsPartyFlag(SpeakerIndex, FlagName, Bool)<br /> <br /> Check if speaker's user flag has certain value. If that speaker is not present, the result will always be '''false'''.<br /> <br /> ==== IsSpeakerPresent ====<br /> CONDITION IsSpeakerPresent(SpeakerIndex, Bool)<br /> <br /> Check if a character at that speaker index is present in the dialog. E.g., you can have a dialog with 3 speakers, but pass NULL as the third speaker when starting it. In this case, this test will return '''false''' for the third speaker.<br /> <br /> ==== IsMagicPocketsGold ====<br /> CONDITION IsMagicPocketsGold(SpeakerIndex, CompareOp, CompareValue)<br /> <br /> Check amount of gold in magic pockets (= per-user) for condition. CompareOp is one of <, >, <=, >=, ==. Can also be used on NPCs.<br /> <br /> {{warning|CompareValue MUST be DialogVariable (starts with %).}}<br /> <br /> ==== HasItemTemplate ====<br /> CONDITION HasItemTemplate(SpeakerIndex, Template, CompareOp, CompareValue)<br /> <br /> Check amount items with specified root template in speaker's inventory for condition. CompareOp is one of <, >, <=, >=, ==. Can also be used on NPCs.<br /> <br /> {{warning|CompareValue MUST be DialogVariable (starts with %).}}<br /> <br /> ==== HasItemTemplateInMagicPockets ====<br /> CONDITION HasItemTemplateInMagicPockets(SpeakerIndex, Template, CompareOp, CompareValue, MoveAndReport)<br /> <br /> Check amount of items with specified root template in magic pockets (= per-user) for condition. CompareOp is one of <, >, <=, >=, ==. If MoveAndReport is '''true''', template items are moved from other characters to this speaker's inventory.<br /> <br /> {{warning|CompareValue MUST be DialogVariable (starts with %).}}<br /> <br /> ==== HasTalent ====<br /> CONDITION HasTalent(SpeakerIndex, TalentID)<br /> <br /> Check speaker has talent. TalentID is string.<br /> <br /> ==== PartyMemberWithTalentInRange ====<br /> CONDITION PartyMemberWithTalentInRange(SpeakerIndex, TalentID, Range)<br /> <br /> Check speaker's party members in a range to have talent. TalentID is string.<br /> <br /> ==== HasAbility ====<br /> CONDITION HasAbility(SpeakerIndex, AbilityID, Level)<br /> <br /> Check speaker has ability no lower then of certain level. AbilityID is string.<br /> <br /> ==== IsTagged ====<br /> CONDITION IsTagged(SpeakerIndex, Tag)<br /> <br /> Check whether speaker has the specified tag.<br /> <br /> == Dialog Variable Editor ==<br /> === Overview ===<br /> Each parameter of a Script Flag condition (FlagName, GroupName...) can be a Dialog Variable. A Dialog Variable starts with a % sign. While checking the flag, the variable is replaced by a default value or by a value set through script. All dialog variables are saved in the dialog folder under 'DialogVariables'.<br /> <br /> Variables have to be defined through the 'Dialog variables' (Tools > Edit dialog variables) window.<br /> <br/><br /> [[File:EditDialogVariables.png]]<br /> <br /> A variable has a uuid, a (unique) name, a description, a type, a default value, the mod in which the variable is declared and the filepath. The different types are<br /> * Int<br /> * Float<br /> * String<br /> * FixedString<br /> <br /> When you are writing a script and you use dialog variables that are not yet created, you will get a warning while saving. You can create the variable afterwards, but it is best to open the script and save it again afterwards. If the name of the variable is changed afterwards, the name in the script will be changed as well.<br /> <br /> An overview of all the dialog variables in the current dialog (the dialog variables used in the scripts of the scriptflags set in the current dialog) can be found under Tools > Current dialog nodes.<br /> <br /> === Using Dialog Variables from Script ===<br /> Dialog Variables can be set through Osiris script. To be able to do this there's a call supplied for every data type:<br /> call DialogSetVariableString((STRING)_Dialog, (STRING)_Variable, (STRING)_Value) <br /> call DialogSetVariableInt((STRING)_Dialog, (STRING)_Variable, (INTEGER)_Value)<br /> call DialogSetVariableFloat((STRING)_Dialog, (STRING)_Variable, (REAL)_Value) <br /> call DialogSetVariableFixedString((STRING)_Dialog, (STRING)_Variable, (STRING)_Value)<br /> call DialogSetVariableTranslatedString((STRING)_Dialog, (STRING)_Variable, (STRING)_StringHandleValue, (STRING)_ReferenceStringValue)<br /> <br /> Where:<br /> * '''_Dialog''' is the name of the dialog (without extension)<br /> * '''_Variable''' is of the form <variable name>_<uuid><br /> * '''_Value''' is the actual value of this parameter for the dialog '''_Dialog'''.<br /> * '''_StringHandleValue''' and '''_ReferenceStringValue''' can be obtained via the '''CharacterGetDisplayName''' and '''OtemTemplateGetDisplayString''' Osiris APIs<br /> <br /> If the data type of the _Value that you're passing doesn't match the data type of the variable you will get an assert and no value will be stored.<br /> <br /> === Using Dialog Variables in Dialog Text ===<br /> You can use use the values of dialog variables directly in the text of you dialog. To do so, copy the '''Name_UUID''' field of the dialog variable and place it your node text between square brackets. E.g.<br /> *Give [GEN_CheckMagicPocketGold_6057ad05-9492-4630-9f0a-be548b134c54] gold pieces*<br /> <br /> = Searching Through Dialogues =<br /> <br /> == Searching in an individual Dialogue ==<br /> The Dialogue Editor comes with a powerful Find tool that you can use to find back several pieces of information. You can access it from the ''Edit'' menu in the editor or by pressing the '''ctrl-f''' key combination.<br /> <br/><br /> [[File:DialogFindMenu.png]]<br /> <br /> When you open the Find window, you'll get an interface similar to the [[#Looking_for_a_specific_Speaker|Speaker Find]] option:<br /> <br/><br /> [[File:DialogSearch.png]]<br /> <br /> Type what you're looking for into the '''Search for''' textbox. Clicking the '''Find''' button to start looking through the current Dialogue. The Dialogue Editor will then look for the text in the locations you specified in [[#Search_Locations|Search Locations]] using the options you specified in [[#Search_Options|Search Options]]. The results and the number of results will be displayed at the bottom of the Find window. Double clicking a result line will select and center the Dialoge Editor on the Dialog Node where the result was found.<br /> <br /> === Search Locations ===<br /> The Search Locations determine where the Dialogue Editor will look for your search string. You can specify multiple locations at the same time.<br /> <br /> ==== Logical Name ====<br /> Look in the Logical Name property of the Dialogue Nodes.<br /> <br /> ==== UUID ====<br /> The UUID is the unique identifier of a Dialogue Node. Every Node comes with one and no two nodes will share the same UUID. The game will report any potential errors in Dialogue structure using this UUID.<br /> <br /> ==== Text ====<br /> Look in the text assigned to nodes<br /> <br /> ==== Flags ====<br /> Look in the Flags that are being Set and Checked on the Dialogue Nodes.<br /> <br /> ==== Tags ====<br /> Look at the Tags being checked and set on Dialogue Nodes as well as the Tags being checked in the Text Blocks of Dialogue Nodes.<br /> <br /> === Search Options ===<br /> These can be used to refine your search results.<br /> <br /> ==== Match Case ====<br /> Only returns results that have the same case as the search string.<br /> <br /> == Searching through files ==<br /> To search in files, you can open the 'Find in files' window through the edit menu (Edit > Find in files) or by pressing the '''ctrl-shift-f''' key combination. All search locations and options available in the 'Find Dialog Nodes' are available in the 'Find in Files' form as well.<br /> <br/><br /> [[File:FindInFiles.png]]<br /> <br /> Before you start searching, define the folder in which you want to search. If you want to search in subfolders of that folder as well, check the 'Search in subfolders'.<br /> <br /> = Testing Dialogues =<br /> To test a dialogue, open the dialogue in the dialogue editor and click the 'Play' button. This will open the 'Play window'. This will simulate the dialogue in game. It is possible to open the player without loading a level, however, dialogplayers, voices... can be more specific when a level is loaded.<br /> <br/><br /> [[File:PlayWindow.png]]<br /> <br /> To start, click the 'Play' button. The start node is chosen and the possible options are shown in the 'dialogue' tab. To review the history of the dialogue, click the 'History' tab.<br /> <br /> == Advanced play == <br /> You can start playing your dialogs in the editor with certain dialog flags already set. This could be helpful to check what dialogs look like after completing a quest for an NPC, for a specific player eg. <br /> <br /> In this window you can select a set of dialog flags and tags to set on the speakers.<br /> <br /> To do so, open the 'Advanced play' (File > Play advanced). This option is not available when the dialog player is playing.<br /> <br/><br /> [[File:AdvancedPlay.png]]<br /> <br /> On the left, you can see a list of available sets. The flags and tags set in the selected set are visible at the right.<br /> To create a new set, click the Create button. This will open the 'Create Flag set' window.<br /> <br/><br /> [[File:CreateFlagSetWindow.png]]<br /> <br /> Flags can be assigned to the left by double clicking on the flag or using the up and down arrows to move a flag from 'Available flags' to 'Assigned flags'. This way, you can make a node valid when playing the dialog in the dialog player.<br /> <br /> The following node for example checks if the speaker 'Magister' doesn't have the Character flag 'TUT_ShakeCamera' and has the Character flag 'TUT_CollaringPriest_Kill'. By setting those flags in the 'Create Flag set' window, that node becomes a valid node.<br /> <br/><br /> [[File:FlagsToCheck.png]]<br /> <br /> You can do the same for tags. Following text is only chosen when speaker 2 has the tag 'RED PRINCE'. By assigning the tag 'RED PRINCE' in the 'Create flag set' window, this text will be valid when playing the dialog in the dialogplayer.<br /> <br/><br /> [[File:TaggedText.png]]<br /> <br /> = Templates =<br /> <br /> == Using a template ==<br /> If a certain combination of nodes is used multiple times, you can convert it to a template. A new dialog can be created from a template (File > New > From Template), but you can add a template to an existing dialog as well (''right-click in the grey area'' > Insert Template...).<br /> <br/><br /> [[File:InsertTemplate.png]]<br /> <br /> A template can have different parameters. Before inserting the template, you need to fill in a value for each parameter. Those parameters can be custom flags (see [[#Adding_Flag_Checks|Adding Flag Checks]]) or tags.<br /> <br /> == Creating a template ==<br /> To create a template, create a dialog as described previously. Save it as a template (File > Save > Save as template). Select all flags and tags that you want to turn into parameters and give those a proper name.<br /> <br/><br /> [[File:CreateDialogTemplate.png]]<br /> <br /> Provide a template name and path. If you don't want the text of the nodes to be exported as well, uncheck the 'Export Text' checkbox.<br /> <br/><br /> [[File:CreateDialogTemplate2.png]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/TriggerRegisterForPlayers&diff=5357 Osiris/API/TriggerRegisterForPlayers 2018-01-08T16:15:15Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''TriggerRegisterForPlayers'''(''(TRIGGERGUID)'''''_Trigger''')<br /> ===== Description =====<br /> Registers the '''_Trigger''' for all current player characters, to that that whenever one of them enters or leaves the '''_Trigger''', a [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] resp. [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] event will be thrown for this trigger/character combination.<br /> ===== Return Values =====<br /> * None<br /> ===== Notes =====<br /> * [[Triggers#Event_Trigger|Event]] triggers are automatically registered for all characters by the engine and can not be unregistered.<br /> * [[Osiris/Shared/ProcTriggerRegisterForPlayers|ProcTriggerRegisterForPlayers]] ensures that the '''_Trigger''' is also registerd for characters who become players at a later point (i.e. characters recruited into the party). Use this procedure rather than the '''TriggerRegisterForPlayers''' call directly.<br /> ===== See Also =====<br /> * [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]]<br /> * [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]]<br /> * [[Osiris/API/TriggerRegisterForCharacter|TriggerRegisterForCharacter]]<br /> * [[Osiris/API/TriggerUnregisterForCharacter|TriggerUnregisterForCharacter]]<br /> * [[Osiris/API/TriggerUnregisterForPlayers|TriggerUnregisterForPlayers]]<br /> * [[Osiris/API/TriggerLaunchIterator|TriggerLaunchIterator]]<br /> * Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]]<br /> <br /> [[Category:Osiris Calls|TriggerRegisterForPlayers]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/Shared/ProcTriggerRegisterForPlayers&diff=5356 Osiris/Shared/ProcTriggerRegisterForPlayers 2018-01-08T16:12:32Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * PROC '''ProcTriggerRegisterForPlayers'''(''(TRIGGERGUID)'''''_Trigger''') ===== Description ===== This procedure registers the '''_Trigger'''..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * PROC '''ProcTriggerRegisterForPlayers'''(''(TRIGGERGUID)'''''_Trigger''')<br /> ===== Description =====<br /> This procedure registers the '''_Trigger''' for all players, so that they throw [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] events. Unlike [[Osiris/API/TriggerRegisterForPlayers|TriggerRegisterForPlayers]], it also registers the trigger for characters that later become players. It also allows registering of triggers in other levels.<br /> ===== Return Values =====<br /> * /<br /> ===== Notes =====<br /> * This is almost always preferable to using [[Osiris/API/TriggerRegisterForPlayers|TriggerRegisterForPlayers]].<br /> ===== See Also =====<br /> * /<br /> <br /> [[Category:Osiris Shared Mod Helpers|ProcTriggerRegisterForPlayers]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/Shared/ProcOneShotTriggerEntered&diff=5355 Osiris/Shared/ProcOneShotTriggerEntered 2018-01-08T16:05:40Z

<p>LarIlya: </p> <hr /> <div>#REDIRECT [[Osiris/Shared/DB_OneShotPlayerTrigger]]<br /> <br /> [[Category:Osiris Shared Mod Helpers|ProcOneShotTriggerEntered]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/Shared/DB_OneShotPlayerTrigger&diff=5354 Osiris/Shared/DB OneShotPlayerTrigger 2018-01-08T16:05:18Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * '''DB OneShotPlayerTrigger'''(''(TRIGGERGUID)'''''_Trigger''')<br /> * '''ProcOneShotTriggerEntered'''(''(CHARACTERGUID)'''''_Player''',''(TRIGGERGUID)'''''_Trigger''')<br /> ===== Description =====<br /> Adding a trigger to the database [[Osiris/Shared/ProcTriggerRegisterForPlayers|registers]] the '''_Trigger''' for all players and ensures the trigger only fires once, calling the [[Osiris/Shared/ProcOneShotTriggerEntered|ProcOneShotTriggerEntered]] procedure when this happens, with the entering '''_Player''' and the '''_Trigger''' as parameters.<br /> ===== Notes =====<br /> * Simply unregistering the trigger when it is first triggered is not safe: if the party teleports somewhere together, multiple events may be thrown simultaneously.<br /> ===== See Also =====<br /> * [[Osiris/Shared/ProcTriggerRegisterForPlayers|ProcTriggerRegisterForPlayers]]<br /> <br /> <br /> [[Category:Osiris Shared Mod Helpers|DB OneShotPlayerTrigger]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/Shared/ProcOneShotTriggerEntered&diff=5353 Osiris/Shared/ProcOneShotTriggerEntered 2018-01-08T16:04:41Z

<p>LarIlya: Redirected page to Osiris/Shared/DB OneShotPlayerTrigger</p> <hr /> <div>#REDIRECT [[Osiris/Shared/DB_OneShotPlayerTrigger]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/Shared/ProcOneShotTriggerEntered&diff=5352 Osiris/Shared/ProcOneShotTriggerEntered 2018-01-08T16:04:27Z

<p>LarIlya: Redirected page to DB OneShotPlayerTrigger</p> <hr /> <div>#REDIRECT [[DB_OneShotPlayerTrigger]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/Shared/DB_OneShotPlayerTrigger&diff=5351 Osiris/Shared/DB OneShotPlayerTrigger 2018-01-08T16:04:01Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * '''DB OneShotPlayerTrigger'''(''(TRIGGERGUID)'''''_Trigger''') * '''ProcOneShotTriggerEntered'''(''(CHARACTERGUID)'''''_Player''',''(TRIGGERGU..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * '''DB OneShotPlayerTrigger'''(''(TRIGGERGUID)'''''_Trigger''')<br /> * '''ProcOneShotTriggerEntered'''(''(CHARACTERGUID)'''''_Player''',''(TRIGGERGUID)'''''_Trigger''')<br /> ===== Description =====<br /> Adding a trigger to the database [[Osiris/Shared/ProcTriggerRegisterForPlayers|registers]] the '''_Trigger''' for all players and ensures the trigger only fires once, calling the [[Osiris/Shared/ProcOneShotTriggerEntered|ProcOneShotTriggerEntered]] procedure when this happens, with the entering '''_Player''' and the '''_Trigger''' as parameters.<br /> ===== Notes =====<br /> * Simply unregistering the trigger when it is first triggered is not safe: if the party teleports somewhere together, multiple events may be thrown simultaneously.<br /> ===== See Also =====<br /> * [[Osiris/Shared/ProcTriggerRegisterForPlayers|ProcTriggerRegisterForPlayers]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGiveReward&diff=5350 Osiris/API/CharacterGiveReward 2018-01-08T14:47:01Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterGiveReward'''(''(CHARACTERGUID)'''''_Player''', ''(STRING)'''''_Treasure''', ''(INTEGER)'''''_Identified''')<br /> ===== Description =====<br /> Generates treasure from the '''_Treasure''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Player''''s inventory. The level used for the treasure generation is always that of the '''_Player'''. If '''_Identified''' is 1, the items generated will all be identified. If '''_Identified''' is 0, they will not be.<br /> ===== Notes =====<br /> * Unlike [[Osiris/API/GenerateTreasure|GenerateTreasure]], the level will be that of the '''_Player''', not that of the highest member of their party.<br /> ===== See Also =====<br /> *[[Osiris/API/GenerateTreasure|GenerateTreasure]]<br /> *[[Osiris/API/CharacterGiveQuestReward|CharacterGiveQuestReward]]<br /> *[[Treasure_Tables|Treasure Tables]]<br /> <br /> [[Category:Osiris Calls|CharacterGiveReward]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/GenerateTreasure&diff=5349 Osiris/API/GenerateTreasure 2018-01-08T14:42:10Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''GenerateTreasure'''(''(ITEMGUID)'''''_Item''', ''(STRING)'''''_TreasureID''', ''(INTEGER)'''''_Level''', ''(CHARACTERGUID)'''''_Character''')<br /> ===== Description =====<br /> Generates treasure from the '''_TreasureID''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Item''''s inventory.<br /> *If the '''_Level''' is greater than or equal to 0, it will be used to generate treasure.<br /> *If the '''_Level''' is less than 0, if the item is set (in the sidebar) to ''Use Party Level For Treasure'', the highest level in the '''_Character''' 's party is used.<br /> *If the '''_Level''' is less than 0, and ''Use Party Level For Treasure'' is false, the item's ''Treasure Level'' setting is used.<br /> *If the ''Treasure Level'' setting is also less than 0, the level of the nearest character is used.<br /> ===== Notes =====<br /> */<br /> ===== See Also =====<br /> *[[Osiris/API/CharacterGiveReward|CharacterGiveReward]]<br /> *[[Osiris/API/CharacterGiveQuestReward|CharacterGiveQuestReward]]<br /> *[[Treasure_Tables|Treasure Table]]<br /> <br /> [[Category:Osiris Calls|GenerateTreasure]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGiveQuestReward&diff=5348 Osiris/API/CharacterGiveQuestReward 2018-01-08T14:41:49Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * call '''CharacterGiveQuestReward'''(''(CHARACTERGUID)'''''_Player''', ''(STRING)'''''_Quest''', ''(STRING)'''''_RewardState''') ===== Descript..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterGiveQuestReward'''(''(CHARACTERGUID)'''''_Player''', ''(STRING)'''''_Quest''', ''(STRING)'''''_RewardState''')<br /> ===== Description =====<br /> Gives the '''_Player''' character (if they are a player) the reward under the '''_RewardState''' state of the '''_Quest''' supplied. The ''RewardTreasureTables'' field is used for the static part of the treasure (i.e. what the player always gets). The player can also select an amount of items given ''RewardTreasureOptionalCount'' from those generated by the treasure table under ''RewardOptionalTreasureTables''. The level used for the generation of both table is given by ''RewardTreasureLevel''.<br /> ===== Notes =====<br /> * The items are always identified.<br /> * The treasure is not affected by the player's level, only that specified in the journal.<br /> ===== See Also =====<br /> *[[Osiris/API/CharacterGiveReward|CharacterGiveReward]]<br /> *[[Osiris/API/GenerateTreasure|GenerateTreasure]]<br /> *[[Treasure_Tables|Treasure Tables]]<br /> *[[Journal_editor|Journal editor]], where the rewards are defined.<br /> <br /> [[Category:Osiris Calls|CharacterGiveQuestReward]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/GenerateTreasure&diff=5347 Osiris/API/GenerateTreasure 2018-01-08T14:07:08Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''GenerateTreasure'''(''(ITEMGUID)'''''_Item''', ''(STRING)'''''_TreasureID''', ''(INTEGER)'''''_Level''', ''(CHARACTERGUID)'''''_Character''')<br /> ===== Description =====<br /> Generates treasure from the '''_TreasureID''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Item''''s inventory.<br /> *If the '''_Level''' is greater than or equal to 0, it will be used to generate treasure.<br /> *If the '''_Level''' is less than 0, if the item is set (in the sidebar) to ''Use Party Level For Treasure'', the highest level in the '''_Character''' 's party is used.<br /> *If the '''_Level''' is less than 0, and ''Use Party Level For Treasure'' is false, the item's ''Treasure Level'' setting is used.<br /> *If the ''Treasure Level'' setting is also less than 0, the level of the nearest character is used.<br /> ===== Notes =====<br /> */<br /> ===== See Also =====<br /> *[[Osiris/API/CharacterGiveReward|CharacterGiveReward]]<br /> *[[Treasure_Tables|Treasure Table]]<br /> <br /> [[Category:Osiris Calls|GenerateTreasure]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGiveReward&diff=5346 Osiris/API/CharacterGiveReward 2018-01-08T14:07:05Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * call '''CharacterGiveReward'''(''(CHARACTERGUID)'''''_Player''', ''(STRING)'''''_Treasure''', ''(INTEGER)'''''_Identified''') ===== Descriptio..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterGiveReward'''(''(CHARACTERGUID)'''''_Player''', ''(STRING)'''''_Treasure''', ''(INTEGER)'''''_Identified''')<br /> ===== Description =====<br /> Generates treasure from the '''_Treasure''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Player''''s inventory. The level used for the treasure generation is always that of the '''_Player'''. If '''_Identified''' is 1, the items generated will all be identified. If '''_Identified''' is 0, they will not be.<br /> ===== Notes =====<br /> * Unlike [[Osiris/API/GenerateTreasure|GenerateTreasure]], the level will be that of the '''_Player''', not that of the highest member of their party.<br /> ===== See Also =====<br /> *[[Osiris/API/GenerateTreasure|GenerateTreasure]]<br /> *[[Treasure_Tables|Treasure Tables]]<br /> <br /> [[Category:Osiris Calls|GenerateTreasure]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/GenerateTreasure&diff=5345 Osiris/API/GenerateTreasure 2018-01-08T11:31:39Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''GenerateTreasure'''(''(ITEMGUID)'''''_Item''', ''(STRING)'''''_TreasureID''', ''(INTEGER)'''''_Level''', ''(CHARACTERGUID)'''''_Character''')<br /> ===== Description =====<br /> Generates treasure from the '''_TreasureID''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Item''''s inventory.<br /> *If the '''_Level''' is greater than or equal to 0, it will be used to generate treasure.<br /> *If the '''_Level''' is less than 0, if the item is set (in the sidebar) to ''Use Party Level For Treasure'', the highest level in the '''_Character''' 's party is used.<br /> *If the '''_Level''' is less than 0, and ''Use Party Level For Treasure'' is false, the item's ''Treasure Level'' setting is used.<br /> *If the ''Treasure Level'' setting is also less than 0, the level of the nearest character is used.<br /> ===== Notes =====<br /> */<br /> ===== See Also =====<br /> *[[Treasure_Tables|Treasure Table]]<br /> <br /> [[Category:Osiris Calls|GenerateTreasure]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/GenerateTreasure&diff=5344 Osiris/API/GenerateTreasure 2018-01-08T11:31:04Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * call '''GenerateTreasure'''(''(ITEMGUID)'''''_Item''', ''(STRING)'''''_TreasureID''', ''(INTEGER)'''''_Level''', ''(CHARACTERGUID)'''''_Charac..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''GenerateTreasure'''(''(ITEMGUID)'''''_Item''', ''(STRING)'''''_TreasureID''', ''(INTEGER)'''''_Level''', ''(CHARACTERGUID)'''''_Character''')<br /> ===== Description =====<br /> Generates treasure from the '''_TreasureID''' [[Treasure_Tables|treasure table]] and puts the item(s) generated in the '''_Item''''s inventory.<br /> *If the '''_Level''' is greater than or equal to 0, it will be used to generate treasure.<br /> *If the '''_Level''' is less than 0, if the item is set (in the sidebar) to ''Use Party Level For Treasure'', the highest level in the '''_Character''' 's party is used.<br /> *If the '''_Level''' is less than 0, and ''Use Party Level For Treasure'' is false, the item's ''Treasure Level'' setting is used.<br /> *If the ''Treasure Level'' setting is also less than 0, the level of the nearest character is used.<br /> ===== Notes =====<br /> */<br /> ===== See Also =====<br /> *[[Treasure_Tables|Treasure Table]]<br /> <br /> [[Category:Osiris Calls|AddToParty]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/StartVoiceBark&diff=5343 Osiris/API/StartVoiceBark 2018-01-07T23:20:33Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''StartVoiceBark'''(''(STRING)'''''_Bark''', ''(CHARACTERGUID)'''''_Source''')<br /> ===== Description =====<br /> Starts a [[Voice_Bark_editor|Voicebark]] named '''_Bark''' on the '''_Source''' character, selecting an automatic dialogue based on that character's nearby party members.<br /> ===== Notes =====<br /> * See the [[Voice_Bark_editor|Voicebark editor]] for the specifics on how the voicebark selects the AD that will be played.<br /> * In addition to the regular events for starting an automated dialogue, a [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]] will be sent if the voicebark succeeds in selecting a fitting dialogue, and [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] otherwise.<br /> ===== See Also =====<br /> * [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]]<br /> * [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]]<br /> * [[Voice_Bark_editor|Voicebark]]<br /> <br /> [[Category:Osiris Calls|StartVoiceBark]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/StartVoiceBark&diff=5329 Osiris/API/StartVoiceBark 2018-01-05T11:33:07Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''StartVoiceBark'''(''(STRING)'''''_Bark''', ''(CHARACTERGUID)'''''_Source''')<br /> ===== Description =====<br /> Starts a [[Voice_Bark_editor|Voicebark]] named '''_Bark''' on the '''_Source''' character, selecting an automatic dialogue based on that character's nearby party members.<br /> ===== Notes =====<br /> * See the Voicebark editor for the specific on how the voicebark selects the AD that will be played.<br /> * In addition to the regular for starting a dialogue, a [[Osiris/API/VoicebarkStarted|VoicebarkStarted]] will be sent if the voicebark succeeds in selecting a fitting dialogue, and [[Osiris/API/VoicebarkFailed|VoicebarkFailed]] otherwise.<br /> ===== See Also =====<br /> * [[Osiris/API/VoicebarkStarted|VoicebarkStarted]]<br /> * [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]]<br /> * [[Voice_Bark_editor|Voicebark]]<br /> <br /> [[Category:Osiris Calls|StartVoiceBark]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/VoiceBarkFailed&diff=5328 Osiris/API/VoiceBarkFailed 2018-01-05T11:32:48Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * event '''VoiceBarkFailed'''(''(STRING)'''''_Bark''')<br /> ===== Description =====<br /> * Thrown when a [[Voice_Bark_editor|Voicebark]] fails to find characters and an AD for the voicebark called '''_Bark'''.<br /> ===== Parameters =====<br /> * '''_Bark''': Name of the voicebark.<br /> ===== Notes =====<br /> -<br /> ===== See Also =====<br /> * [[Osiris/API/StartVoiceBark|StartVoiceBark]]<br /> * [[Osiris/API/VoicebarkStarted|VoiceBarkStarted]]<br /> * [[Voice_Bark_editor|Voice_Bark_editor]] on general Voicebark logic.<br /> <br /> [[Category:Osiris Events|VoiceBarkFailed]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/VoiceBarkFailed&diff=5327 Osiris/API/VoiceBarkFailed 2018-01-05T11:32:38Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * event '''VoiceBarkFailed'''(''(STRING)'''''_Bark''') ===== Description ===== * Thrown when a Voicebark fails to find cha..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * event '''VoiceBarkFailed'''(''(STRING)'''''_Bark''')<br /> ===== Description =====<br /> * Thrown when a [[Voice_Bark_editor|Voicebark]] fails to find characters and an AD for the voicebark called '''_Bark'''.<br /> ===== Parameters =====<br /> * '''_Bark''': Name of the voicebark.<br /> ===== Notes =====<br /> -<br /> ===== See Also =====<br /> * [[Osiris/API/StartVoiceBark|StartVoiceBark]]<br /> * [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]]<br /> * [[Voice_Bark_editor|Voice_Bark_editor]] on general Voicebark logic.<br /> <br /> [[Category:Osiris Events|VoiceBarkFailed]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/VoiceBarkStarted&diff=5326 Osiris/API/VoiceBarkStarted 2018-01-05T11:31:48Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * event '''VoicebarkStarted'''(''(STRING)'''''_Bark''', ''(INTEGER)'''''_ID''') ===== Description ===== * Thrown when a Voice_Bark_editor|Voic..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * event '''VoicebarkStarted'''(''(STRING)'''''_Bark''', ''(INTEGER)'''''_ID''')<br /> ===== Description =====<br /> * Thrown when a [[Voice_Bark_editor|Voicebark]] succeeds in finding characters and an AD for the voicebark called '''_Bark'''.<br /> ===== Parameters =====<br /> * '''_Bark''': Name of the voicebark.<br /> * '''_ID''': Identifier of the dialogue started by the voicebark.<br /> ===== Notes =====<br /> -<br /> ===== See Also =====<br /> * [[Osiris/API/StartVoiceBark|StartVoiceBark]]<br /> * [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]]<br /> * [[Voice_Bark_editor|Voice_Bark_editor]] on general Voicebark logic.<br /> <br /> [[Category:Osiris Events|VoicebarkStarted]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/StartVoiceBark&diff=5325 Osiris/API/StartVoiceBark 2018-01-05T11:22:29Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''StartVoiceBark'''(''(STRING)'''''_Bark''', ''(CHARACTERGUID)'''''_Source''')<br /> ===== Description =====<br /> Starts a [[Voice_Bark_editor|Voicebark]] named '''_Bark''' on the '''_Source''' character, selecting an automatic dialogue based on that character's nearby party members.<br /> ===== Notes =====<br /> * See the Voicebark editor for the specific on how the voicebark selects the AD that will be played.<br /> * In addition to the regular for starting a dialogue, a [[Osiris/API/VoicebarkStarted|VoicebarkStarted]] will be sent if the voicebark succeeds in selecting a fitting dialogue, and [[Osiris/API/VoicebarkFailed|VoicebarkFailed]] otherwise.<br /> ===== See Also =====<br /> * [[Osiris/API/VoicebarkStarted|VoicebarkStarted]]<br /> * [[Osiris/API/VoicebarkFailed|VoicebarkFailed]]<br /> * [[Voice_Bark_editor|Voicebark]]<br /> <br /> [[Category:Osiris Calls|StartVoiceBark]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/StartVoiceBark&diff=5323 Osiris/API/StartVoiceBark 2018-01-05T11:21:24Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * call '''StartVoiceBark'''(''(STRING)'''''_Bark''', ''(CHARACTERGUID)'''''_Source''') ===== Description ===== Starts a Voice_Bark_editor|Voic..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''StartVoiceBark'''(''(STRING)'''''_Bark''', ''(CHARACTERGUID)'''''_Source''')<br /> ===== Description =====<br /> Starts a [[Voice_Bark_editor|Voicebark]] named '''_Bark''' on the '''_Source''' character, selecting an automatic dialogue based on that character's nearby party members.<br /> ===== Notes =====<br /> * See the Voicebark editor for the specific on how the voicebark selects the AD that will be played.<br /> * In addition to the regular for starting a dialogue, a [[Osiris/API/VoicebarkStarted|VoicebarkStarted]] will be sent if the voicebark succeeds in selecting a fitting dialogue, and [[Osiris/API/VoicebarkFailed|VoicebarkFailed]] otherwise.<br /> ===== See Also =====<br /> * [[Osiris/API/VoicebarkStarted|VoicebarkStarted]]<br /> * [[Osiris/API/VoicebarkFailed|VoicebarkFailed]]<br /> <br /> [[Category:Osiris Calls|StartVoiceBark]]</div>

LarIlya https://docs.larian.game/index.php?title=Editors&diff=5322 Editors 2018-01-05T11:09:25Z

<p>LarIlya: </p> <hr /> <div>[[File:AllSparkEditor_Icon.png|32px]] <big><b>[[AllSpark effect editor]] (Work in Progress)</b></big><br /> <br /><br /><br /> [[File:AlignmentEditor_Icon.png|32px]] <big><b>[[Alignment editor]] (Coming Soon)</b></big><br /> <br /><br /><br /> [[File:MaterialEditor_Icon.png|32px]] <big><b>[[Material editor]]</b></big><br /> <br /><br /><br /> [[File:DialogEditor_Icon.png|32px]] <big><b>[[Dialog editor]]</b></big><br /> <br /><br /><br /> [[File:JournalEditor_Icon.png|32px]] <big><b>[[Journal editor]]</b></big><br /> <br /><br /><br /> [[File:ScriptEditor_Icon.png|32px]] <big><b>[[Script editor]]</b></big><br /> <br /><br /><br /> [[File:StatsEditor_Icon.png|32px]] <big><b>[[Stats editor]] (Work In Progress)</b></big><br /> <br /><br /><br /> [[File:StoryEditor_Icon.png|32px]] <big><b>[[Story editor]] (Work In Progress)</b></big><br /> <br /><br /><br /> [[File:TagEditor_Icon.png|32px]] <big><b>[[Tag editor]]</b></big><br /> <br /><br /><br /> [[File:TextureAtlasEditor_Icon.png|32px]] <big><b>[[Texture atlas editor]] (Coming Soon)</b></big><br /> <br /><br /><br /> [[File:TranslatedStringKeyEditor_Icon.png|32px]] <big><b>[[Translated string key editor]]</b></big><br /> <br /><br /><br /> [[File:VoiceBarkEditor_Icon.png|32px]] <big><b>[[Voice_Bark_editor]]</b></big><br /> <br /><br /></div>

LarIlya https://docs.larian.game/index.php?title=Voice_Bark_editor&diff=5320 Voice Bark editor 2018-01-05T11:05:53Z

<p>LarIlya: LarIlya moved page Community: Voice Bark editor to Voice Bark editor: It's a Larian guide</p> <hr /> <div>== The voicebark editor ==<br /> Voicebarks are a system to play an automated dialog for party members, selected based on their tags. This means that in itself, a voicebark is not a dialogue. Rather, it is a set of rules by which an AD can be selected for the player characters to speak.<br /><br /> <br /><br /> [[File:VBEditor.png|1400px]]<br /> <br /><br /> When a voicebark is played from a character (typically, with the [[Osiris/API/StartVoiceBark|StartVoiceBark]] Story call or [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|behaviour script]] call), the system selects the first (topmost) AD for which it can find appropriate speakers, and plays that AD with those speakers. Note that, if their companions have tags which are preferred over that character's own, the character from whom the voicebark originates (the 'target character') will not be part of the selected AD. To be considered, speakers need to be:<br /> * Player characters<br /> * In the same party as the target character<br /> * Within 10 meters of the target character<br /> * Not summons or party followers<br /> * Not already in a dialog<br /> * Not a ghost<br /> * Not charmed<br /> * Alive<br /> * Visible and not sneaking<br /> * On-stage<br /> No AD is started if the requested Voicebark does not exist, if the target character is not a player or does not exist, or if no set of fitting characters is found. Story will get a [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] event. Otherwise, a [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]] event is sent, along with the usual events that accompany the start of an AD.</div>

LarIlya https://docs.larian.game/index.php?title=Voice_Bark_editor&diff=5319 Voice Bark editor 2018-01-05T11:04:56Z

<p>LarIlya: Created page with "== The voicebark editor == Voicebarks are a system to play an automated dialog for party members, selected based on their tags. This means that in itself, a voicebark is not a..."</p> <hr /> <div>== The voicebark editor ==<br /> Voicebarks are a system to play an automated dialog for party members, selected based on their tags. This means that in itself, a voicebark is not a dialogue. Rather, it is a set of rules by which an AD can be selected for the player characters to speak.<br /><br /> <br /><br /> [[File:VBEditor.png|1400px]]<br /> <br /><br /> When a voicebark is played from a character (typically, with the [[Osiris/API/StartVoiceBark|StartVoiceBark]] Story call or [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|behaviour script]] call), the system selects the first (topmost) AD for which it can find appropriate speakers, and plays that AD with those speakers. Note that, if their companions have tags which are preferred over that character's own, the character from whom the voicebark originates (the 'target character') will not be part of the selected AD. To be considered, speakers need to be:<br /> * Player characters<br /> * In the same party as the target character<br /> * Within 10 meters of the target character<br /> * Not summons or party followers<br /> * Not already in a dialog<br /> * Not a ghost<br /> * Not charmed<br /> * Alive<br /> * Visible and not sneaking<br /> * On-stage<br /> No AD is started if the requested Voicebark does not exist, if the target character is not a player or does not exist, or if no set of fitting characters is found. Story will get a [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] event. Otherwise, a [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]] event is sent, along with the usual events that accompany the start of an AD.</div>

LarIlya https://docs.larian.game/index.php?title=File:VBEditor.png&diff=5318 File:VBEditor.png 2018-01-05T10:27:02Z

<p>LarIlya: Schematic of the voicebark editor's fields.</p> <hr /> <div>Schematic of the voicebark editor's fields.</div>

LarIlya https://docs.larian.game/index.php?title=Treasure_Tables&diff=5310 Treasure Tables 2017-12-22T17:13:39Z

<p>LarIlya: </p> <hr /> <div>== Description ==<br /> The D:OS 2 treasure system is constructed around '''Treasure Tables''', which are sets of objects (or categories of objects), defined by their stats entries, and the probability to drop these objects. Treasure tables can be nested, so that using one table, you select randomly from several tables. This system is used both for rewards from e.g. killed enemies, and to generate the treasure vendors have for sale.<br /> <br /> == Treasure Table Columns ==<br /> === Name ===<br /> This column contains the unique ID of the treasure entry that we will use in Glasses in the “Treasure” and “TradeTreasure” fields (for character properties) and the “Inventory” field (for containers). We will also use it to reference other treasure entries. If the name of a table starts with "ST_", it is intended to be used as a subtable to other treasure tables.<br /> === MinLevelDiff and MaxLevelDiff ===<br /> Each treasure container has a level. This defines the items the treasure will look for. Most items can drop between level 1 and 30 so this is usually not necessary. However, when filled in, it can make a treasure look for and drop items that are lower or higher than its level. For example, if a Treasure Table has “MinLevelDiff = -4” and “MaxLevelDiff = 3”, and a player of Level 10 rolls this table, then items of Levels 6-13 are eligible for drop.<br /> === IgnoreLevelDiff ===<br /> A treasure table will always try to choose items that are appropriate for the level of its container. Filling in Yes here disables this behaviour, so that the treasure table drops items irrelevant of the level at which they were intended to be dropped.<br /> === UseTreasureGroups ===<br /> Treasure groups are a system of global balancing of the categories that drop. There is a TreasureGroups table in the Stats editor that you'll need to take a look at for this. There are currently three treasure groups - skillbooks, armour types, and weapon types. In the case of skillbooks, the goal is to make sure that an equal amount of skillbooks of all ability schools are dropped with treasure. As you will see in the TreasureGroups table, all skillbooks types have a weight of 1. This means that the treasure system will do its best to make sure that all skillbook types will drop once before re-starting the cycle. So, if you begin a game and use the console to generate some ST_Skillbook tables, you'll get a skillbook of each ability school once. The same thing happens for armour types and weapon types. The treasure group system is opt-in. In the “UseTreasureGroups” column, you need to set the flag to 1 in order to include your table within the system.<br /> === StartLevel & EndLevel ===<br /> These fields allow you to disable and enable specific entries in the treasure table depending on level. Specifically, if the container's level is below '''StartLevel''' or above '''EndLevel''', that entry will be excluded.<br /> === DropCount ===<br /> This entry tells the system how many items to choose from the ObjectCategory entry on the same line, and all lines below it with empty '''DropCount''' entries. This is a list of possibilities separated by a semicolon. The possibilities are formed as x,y where x is the amount of items that should be picked and y is the chance. <br /> * A negative integer like “-N” means that the Treasure Table uses exactly N instances of the ObjectCategory. This is known as a forced drop, and will ignore level restrictions to get N items if necessary.<br /> * A string of non-negative integers like “n_1,p_1;n_2,p_2;...;n_k,p_k” means that the ObjectCategory can be used n_1, n_2, ... or n_k times. Here, the number n_i will be used with probability p_i/(p_1+p_2+...+p_k). For example, “4,1;5,1;6,2” for “T_ST_ArmorMagic” means that the Treasure Table “ST_ArmorMagic” will be used 4 times with a probability of 1/4, 5 times with a probability of 1/4 and 6 times with a probability of 2/4. The probabilities are decreased when they are successfully rolled. In the example above, if the table rolls 4, then DropCount becomes 4,0;5,1;6,2 for the next roll, meaning that 4 has probability 0, 5 has 1/3 and 6 has 2/3. When all probabilities are zero, they are reset to default values. This way we safeguard against situations where a table with DropCount 0,98;1,2 will drop 1 item five times in a row due to sheer randomness.<br /> === ObjectCategory ===<br /> This column defines what is actually dropped by the table. This can be one of several things:<br /> # A reference to a '''single Item entry''' by its Stats entry. For this, we use the IDs of items from other stat tables: Object, Weapon, Armor, Potion. To use it, we need to prefix it with “I_”, e.g. for “POTION_Minor_Healing_Potion” it will be “I_POTION_Minor_Healing_Potion”.<br /> # A reference to '''another entry from the Treasure Table'''. This reference copies the contents of that entry to the current entry. To use it, we need to prefix the reference with “T_” (e.g. for “WarriorTrader” it will be “T_WarriorTrader”).<br /> # A reference to an '''object category''' from the Object, Weapon, Armor, or Potion tables (the “ObjectCategory” column there). The probability that a particular item drops from the chosen category is determined by the item’s Priority, which is also set within those tables. Priorities act as weights in their category: for example if Weapon file has 3 stat entries with ObjectCategory Dagger, and first two have Priority 1, while third has Priority 3, then first two have 1/5 chance to drop while the third item has 3/5 chance to drop. Unlike Dropcounts, Priorities do not change during the game in any way.<br /> === Frequency ===<br /> A Frequency entry determines the chance of an ObjectCategory being selected in its group (i.e. among all of the '''ObjectCategory''' entries using the same '''DropCount''' entry.<br /> === Item Rarities from Common to Divine ===<br /> Item rarity represents the probability of adding a rarity modifier to an item, which is a measure of how good, rare, and 'special' it is for its level. They work similarly to frequencies and are also counted and saved.<br /><br /> If ObjectCategory entry is a table (starts with “T_”), then the corresponding Item Rarity will override the rarity of the table. To prevent override, simply leave all rarity counters empty.<br /> === Comment ===<br /> A field to leave comments on the purpose & correct use of a table.<br /> <br /> == Examples ==<br /> '''Example 1'''<br /> Below are a few examples to demonstrate the use of the treasure tables:<br /> {| class="wikitable"<br /> |-<br /> ! Name !! MinLevelDiff !! MaxLevelDiff !! StartLevel !! EndLevel !! DropCount !! ObjectCategory !! Frequency<br /> |-<br /> | || || || || || 10,1 || Ingredient || 1<br /> |-<br /> | || || || || || 0,3;1,1;2,1 || Sword || 1<br /> |-<br /> | || || || || || -1 || Dagger || 1<br /> |-<br /> | || || || || || 0,1;1,1;2,1;3,1;4,1 || Painting || 3<br /> |-<br /> | || || || || || || Precious || 1<br /> |-<br /> | || || || || || || T_ST_Dogs || 1<br /> |-<br /> | || || || || || 0,1 || Food || 1<br /> |}<br /> On the initial roll, the above table:<br /> * Will always spawn 10 items of the Ingredient category (x,y is 10,1: amount is 10, chance is 1 out of 1 because that’s the only possibility)<br /> * Has 3 out of 5 chance to drop nothing (0,3 and total chance is 3+1+1)<br /> :Has 1 out of 5 chance to drop 1 item of the Sword category (1,1 and total chance is 3+1+1)<br /> :Has 1 out of 5 chance to drop 2 item of the Sword category (2,1 and total chance is 3+1+1)<br /> * Will be forced to spawn something of the Dagger category, ignoring level restrictions if necessary.<br /> * Has 1 out of 5 chance to drop nothing (0,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop something from Smurf OR Bear OR T_ST_Dogs (1,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop two things from Smurf OR Bear OR T_ST_Dogs (2,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop three things from Smurf OR Bear OR T_ST_Dogs (3,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop four things from Smurf OR Bear OR T_ST_Dogs (4,1 and total chance is 1+1+1+1+1)<br /> * In the last case, the subtable ST_Dogs will go over its own possibilities if it is selected. If the subtable ST_Dogs itself has a DropCount entry that says 5,1, and it gets selected once, it will drop 5 items.<br /> * Will ''never'' drop any Food.<br /> * The tables has a greater chance of dropping Paintings than it does of dropping something Precious or something from the ST_Dogs table. It will actually be chosen 3 out of 5 times, because is '''Frequency''' is 3 and the total of '''Frequencies''' for its entire group (i.e. the Painting, Precious and T_ST_Dogs entries) is 3+1+1=5.<br /> After the initial roll, the selected DropCounts will be removed. If the table drops 2 Swords this time, it won't do so again until it has dropped 1 Sword once and no Swords thrice.<br /> <br /><br /><br /> '''Example 2'''<br /> {| class="wikitable"<br /> |-<br /> ! DropCount !! ObjectCategory !! Frequency !! Common !! Uncommon !! Rare !! Epic !! Legendary<br /> |-<br /> | 5,1 || T_ST_WeaponNormal || 1 || 3 || 1 || 1 || || <br /> |-<br /> | 3,1 || T_ST_WeaponNormal || 1 || 2 || || || || 1<br /> |-<br /> | 2,1 || T_ST_RingAmuletBeltNormal || 1 || || || 1 || 1 || <br /> |-<br /> | 1,1 || Trader Gold || 1 || || || || ||<br /> |}<br /> The above table will:<br /> * Roll on the ST_WeaponNormal table five times. The resulting items have a 3/5 chance to be Common, 1/5 chance to be Uncommon, and a 1/5 chance to be Epic.<br /> * Roll on the ST_ArmorNormal table three times. The resulting items have a 2/3 chance to be Common, and 1/3 chance to be Epic.<br /> * Roll on the ST_RingAmuletBeltNormal table twice times. The resulting items have a 1/2 chance to be Rare, and a 1/2 chance to be Epic.<br /> * Create 1 object of the Trader Gold category.<br /> <br><br /> '''Example 3'''<br /> {| class="wikitable"<br /> |-<br /> ! Name !! MinLevelDiff !! MaxLevelDiff !! IgnoreLevelDiff !! UseTreasureGroups !! StartLevel !! EndLevel !! DropCount || ObjectCategory<br /> |-<br /> | Animals_Owl || || || || || 1 || 12 || 1,1 || I_Loot_Feather_A<br /> |-<br /> | || || || || || 1 || 12 || 1,1 || I_Loot_Essence_Air_A<br /> |-<br /> | || || || || || 13 || || 1,1 || I_Loot_Feather_A_Fancy<br /> |-<br /> | || || || || || 13 || || 1,1 || I_Loot_Essence_Air_Step2_A<br /> |}<br /> Looking at this table, we can see that the following will happen if a character kills an owl:<br /> * If they are level 1 to 12, they will get 1 Feather, provided Loot_Feather_A is not restricted from dropping at their level.<br /> * If they are level 1 to 12, they will get 1 Air Essence, provided Loot_Essence_Air_A is not restricted from dropping at their level.<br /> * If they are level 13 or above, they will get 1 Fancy Feather, provided Loot_Feather_A_Fancy is not restricted from dropping at their level.<br /> * If they are level 13 or above, they will get 1 Step 2 Air Essence (i.e. a higher-tier Air Essence), provided Loot_Essence_Air_Step2_A is not restricted from dropping at their level.<br /> == On Well-Balanced Treasure ==<br /> There are a few practices that will ensure a more even spread of your treasure:<br /> * Avoid using large numbers for Frequency and DropCount. If you have a dropcount of 0,50;1,50, then on average the player has a 1/2 chance of getting something, but they may have to wait until the 51st time they search a container with that treasure table until they actually do. In fact, they may even find something 50 times in a row, then nothing 100 times in a row (with the Dropcount resetting halfway through), then something 50 times in a row again. If the Dropcount is 0,1;1,1 they won't have to wait more than 2 tries between finding something.<br /> * Try to use existing subtables to take advantage of the fact the game keeps track of the DropCount within them. Three separate tables, each of which drops Diamonds and Eyeballs independently, may wind up each dropping an Eyeball, whereas if they use one shared Eyeball/Diamond subtable, the player will get a balanced amount of Diamonds and Eyeballs between them.</div>

LarIlya https://docs.larian.game/index.php?title=Stats_Editor&diff=5309 Stats Editor 2017-12-22T16:22:58Z

<p>LarIlya: </p> <hr /> <div>You can create or modify skills and stats for weapons, armor, objects, characters, and statuses with the Stats editor.<br /> <br /> * [[skill_creation|Skill Creation]].<br /> * [[Treasure_Tables]].<br /> * [https://docs.larian.game/Community:_Stats_editor Community guides/tutorials] related to the stats editor.</div>

LarIlya https://docs.larian.game/index.php?title=Treasure_Tables&diff=5308 Treasure Tables 2017-12-22T16:22:34Z

<p>LarIlya: Created page with "== Description == The D:OS 2 treasure system is constructed around '''Treasure Tables''', which are sets of objects (or categories of objects), defined by their stats entries,..."</p> <hr /> <div>== Description ==<br /> The D:OS 2 treasure system is constructed around '''Treasure Tables''', which are sets of objects (or categories of objects), defined by their stats entries, and the probability to drop these objects. Treasure tables can be nested, so that using one table, you select randomly from several tables. This system is used both for rewards from e.g. killed enemies, and to generate the treasure vendors have for sale.<br /> <br /> == Treasure Table Columns ==<br /> === Name ===<br /> This column contains the unique ID of the treasure entry that we will use in Glasses in the “Treasure” and “TradeTreasure” fields (for character properties) and the “Inventory” field (for containers). We will also use it to reference other treasure entries. If the name of a table starts with "ST_", it is intended to be used as a subtable to other treasure tables.<br /> === MinLevelDiff and MaxLevelDiff ===<br /> Each treasure container has a level. This defines the items the treasure will look for. Most items can drop between level 1 and 30 so this is usually not necessary. However, when filled in, it can make a treasure look for and drop items that are lower or higher than its level. For example, if a Treasure Table has “MinLevelDiff = -4” and “MaxLevelDiff = 3”, and a player of Level 10 rolls this table, then items of Levels 6-13 are eligible for drop.<br /> === IgnoreLevelDiff ===<br /> A treasure table will always try to choose items that are appropriate for the level of its container. Filling in Yes here disables this behaviour, so that the treasure table drops items irrelevant of the level at which they were intended to be dropped.<br /> === UseTreasureGroups ===<br /> Treasure groups are a system of global balancing of the categories that drop. There is a TreasureGroups table in the Stats editor that you'll need to take a look at for this. There are currently three treasure groups - skillbooks, armour types, and weapon types. In the case of skillbooks, the goal is to make sure that an equal amount of skillbooks of all ability schools are dropped with treasure. As you will see in the TreasureGroups table, all skillbooks types have a weight of 1. This means that the treasure system will do its best to make sure that all skillbook types will drop once before re-starting the cycle. So, if you begin a game and use the console to generate some ST_Skillbook tables, you'll get a skillbook of each ability school once. The same thing happens for armour types and weapon types. The treasure group system is opt-in. In the “UseTreasureGroups” column, you need to set the flag to 1 in order to include your table within the system.<br /> === StartLevel & EndLevel ===<br /> These fields allow you to disable and enable specific entries in the treasure table depending on level. Specifically, if the container's level is below '''StartLevel''' or above '''EndLevel''', that entry will be excluded.<br /> === DropCount ===<br /> This entry tells the system how many items to choose from the ObjectCategory entry on the same line, and all lines below it with empty '''DropCount''' entries. This is a list of possibilities separated by a semicolon. The possibilities are formed as x,y where x is the amount of items that should be picked and y is the chance. <br /> * A negative integer like “-N” means that the Treasure Table uses exactly N instances of the ObjectCategory. This is known as a forced drop, and will ignore level restrictions to get N items if necessary.<br /> * A string of non-negative integers like “n_1,p_1;n_2,p_2;...;n_k,p_k” means that the ObjectCategory can be used n_1, n_2, ... or n_k times. Here, the number n_i will be used with probability p_i/(p_1+p_2+...+p_k). For example, “4,1;5,1;6,2” for “T_ST_ArmorMagic” means that the Treasure Table “ST_ArmorMagic” will be used 4 times with a probability of 1/4, 5 times with a probability of 1/4 and 6 times with a probability of 2/4. The probabilities are decreased when they are successfully rolled. In the example above, if the table rolls 4, then DropCount becomes 4,0;5,1;6,2 for the next roll, meaning that 4 has probability 0, 5 has 1/3 and 6 has 2/3. When all probabilities are zero, they are reset to default values. This way we safeguard against situations where a table with DropCount 0,98;1,2 will drop 1 item five times in a row due to sheer randomness.<br /> === ObjectCategory ===<br /> This column defines what is actually dropped by the table. This can be one of several things:<br /> # A reference to a '''single Item entry''' by its Stats entry. For this, we use the IDs of items from other stat tables: Object, Weapon, Armor, Potion. To use it, we need to prefix it with “I_”, e.g. for “POTION_Minor_Healing_Potion” it will be “I_POTION_Minor_Healing_Potion”.<br /> # A reference to '''another entry from the Treasure Table'''. This reference copies the contents of that entry to the current entry. To use it, we need to prefix the reference with “T_” (e.g. for “WarriorTrader” it will be “T_WarriorTrader”).<br /> # A reference to an '''object category''' from the Object, Weapon, Armor, or Potion tables (the “ObjectCategory” column there). The probability that a particular item drops from the chosen category is determined by the item’s Priority, which is also set within those tables. Priorities act as weights in their category: for example if Weapon file has 3 stat entries with ObjectCategory Dagger, and first two have Priority 1, while third has Priority 3, then first two have 1/5 chance to drop while the third item has 3/5 chance to drop. Unlike Dropcounts, Priorities do not change during the game in any way.<br /> === Frequency ===<br /> A Frequency entry determines the chance of an ObjectCategory being selected in its group (i.e. among all of the '''ObjectCategory''' entries using the same '''DropCount''' entry.<br /> === Item Rarities from Common to Divine ===<br /> Item rarity represents the probability of adding a rarity modifier to an item, which is a measure of how good, rare, and 'special' it is for its level. They work similarly to frequencies and are also counted and saved.<br /><br /> If ObjectCategory entry is a table (starts with “T_”), then the corresponding Item Rarity will override the rarity of the table. To prevent override, simply leave all rarity counters empty.<br /> === Comment ===<br /> A field to leave comments on the purpose & correct use of a table.<br /> <br /> == Examples ==<br /> '''Example 1'''<br /> Below are a few examples to demonstrate the use of the treasure tables:<br /> {| class="wikitable"<br /> |-<br /> ! Name !! MinLevelDiff !! MaxLevelDiff !! StartLevel !! EndLevel !! DropCount !! ObjectCategory !! Frequency<br /> |-<br /> | || || || || || 10,1 || Ingredient || 1<br /> |-<br /> | || || || || || 0,3;1,1;2,1 || Sword || 1<br /> |-<br /> | || || || || || -1 || Dagger || 1<br /> |-<br /> | || || || || || 0,1;1,1;2,1;3,1;4,1 || Painting || 3<br /> |-<br /> | || || || || || || Precious || 1<br /> |-<br /> | || || || || || || T_ST_Dogs || 1<br /> |-<br /> | || || || || || 0,1 || Food || 1<br /> |}<br /> On the initial roll, the above table:<br /> * Will always spawn 10 items of the Ingredient category (x,y is 10,1: amount is 10, chance is 1 out of 1 because that’s the only possibility)<br /> * Has 3 out of 5 chance to drop nothing (0,3 and total chance is 3+1+1)<br /> :Has 1 out of 5 chance to drop 1 item of the Sword category (1,1 and total chance is 3+1+1)<br /> :Has 1 out of 5 chance to drop 2 item of the Sword category (2,1 and total chance is 3+1+1)<br /> * Will be forced to spawn something of the Dagger category, ignoring level restrictions if necessary.<br /> * Has 1 out of 5 chance to drop nothing (0,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop something from Smurf OR Bear OR T_ST_Dogs (1,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop two things from Smurf OR Bear OR T_ST_Dogs (2,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop three things from Smurf OR Bear OR T_ST_Dogs (3,1 and total chance is 1+1+1+1+1)<br /> :Has 1 out of 5 chance to drop four things from Smurf OR Bear OR T_ST_Dogs (4,1 and total chance is 1+1+1+1+1)<br /> * In the last case, the subtable ST_Dogs will go over its own possibilities if it is selected. If the subtable ST_Dogs itself has a DropCount entry that says 5,1, and it gets selected once, it will drop 5 items.<br /> * Will ''never'' drop any Food.<br /> * The tables has a greater chance of dropping Paintings than it does of dropping something Precious or something from the ST_Dogs table. It will actually be chosen 3 out of 5 times, because is '''Frequency''' is 3 and the total of '''Frequencies''' for its entire group (i.e. the Painting, Precious and T_ST_Dogs entries) is 3+1+1=5.<br /> After the initial roll, the selected DropCounts will be removed. If the table drops 2 Swords this time, it won't do so again until it has dropped 1 Sword once and no Swords thrice.<br /> <br /><br /><br /> '''Example 2'''<br /> {| class="wikitable"<br /> |-<br /> ! DropCount !! ObjectCategory !! Frequency !! Common !! Uncommon !! Rare !! Epic !! Legendary<br /> |-<br /> | 5,1 || T_ST_WeaponNormal || 1 || 3 || 1 || || || <br /> |-<br /> | 3,1 || T_ST_WeaponNormal || 1 || 2 || || || || 1<br /> |-<br /> | 2,1 || T_ST_RingAmuletBeltNormal || 1 || || || 1 || 1 || <br /> |-<br /> | 1,1 || Trader Gold || 1 || || || || ||<br /> |}<br /> The above table will:<br /> * Roll on the ST_WeaponNormal table five times. The resulting items have a 3/5 chance to be Common, 1/5 chance to be Uncommon, and a 1/5 chance to be Epic.<br /> * Roll on the ST_ArmorNormal table three times. The resulting items have a 2/3 chance to be Common, and 1/3 chance to be Epic.<br /> * Roll on the ST_RingAmuletBeltNormal table twice times. The resulting items have a 1/2 chance to be Rare, and a 1/2 chance to be Epic.<br /> <br><br /> '''Example 3'''<br /> {| class="wikitable"<br /> |-<br /> ! Name !! MinLevelDiff !! MaxLevelDiff !! IgnoreLevelDiff !! UseTreasureGroups !! StartLevel !! EndLevel !! DropCount || ObjectCategory<br /> |-<br /> | Animals_Owl || || || || || 1 || 12 || 1,1 || I_Loot_Feather_A<br /> |-<br /> | || || || || || 1 || 12 || 1,1 || I_Loot_Essence_Air_A<br /> |-<br /> | || || || || || 13 || || 1,1 || I_Loot_Feather_A_Fancy<br /> |-<br /> | || || || || || 13 || || 1,1 || I_Loot_Essence_Air_Step2_A<br /> |}<br /> Looking at this table, we can see that the following will happen if a character kills an owl:<br /> * If they are level 1 to 12, they will get 1 Feather, provided Loot_Feather_A is not restricted from dropping at their level.<br /> * If they are level 1 to 12, they will get 1 Air Essence, provided Loot_Essence_Air_A is not restricted from dropping at their level.<br /> * If they are level 13 or above, they will get 1 Fancy Feather, provided Loot_Feather_A_Fancy is not restricted from dropping at their level.<br /> * If they are level 13 or above, they will get 1 Step 2 Air Essence (i.e. a higher-tier Air Essence), provided Loot_Essence_Air_Step2_A is not restricted from dropping at their level.<br /> == On Well-Balanced Treasure ==<br /> There are a few practices that will ensure a more even spread of your treasure:<br /> * Avoid using large numbers for Frequency and DropCount. If you have a dropcount of 0,50;1,50, then on average the player has a 1/2 chance of getting something, but they may have to wait until the 51st time they search a container with that treasure table until they actually do. In fact, they may even find something 50 times in a row, then nothing 100 times in a row (with the Dropcount resetting halfway through), then something 50 times in a row again. If the Dropcount is 0,1;1,1 they won't have to wait more than 2 tries between finding something.<br /> * Try to use existing subtables to take advantage of the fact the game keeps track of the DropCount within them. Three separate tables, each of which drops Diamonds and Eyeballs independently, may wind up each dropping an Eyeball, whereas if they use one shared Eyeball/Diamond subtable, the player will get a balanced amount of Diamonds and Eyeballs between them.</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/JumpToTurn&diff=5306 Osiris/API/JumpToTurn 2017-12-21T14:44:17Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''JumpToTurn'''(''(GUIDSTRING)'''''_Target''')<br /> ===== Description =====<br /> Switches the current combat turn to '''_Target''', so that it can act immediately.<br /> ===== Notes =====<br /> * '''_Target''' must be in a combat.<br /> * '''_Target''''s combat information needs to have been fully initialised before this API can be used. See [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] for more information.<br /> * The turn of the character currently active in combat is terminated when this call is used.<br /> ===== See Also =====<br /> * [[Osiris/API/CombatStarted|CombatStarted]]<br /> * [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]]<br /> * [[Osiris/API/ObjectTurnStarted|ObjectTurnStarted]]<br /> * [[Osiris/API/ObjectTurnEnded|ObjectTurnEnded]]<br /> * Helper [[Osiris/Shared/DB_CombatCharacters|DB_CombatCharacters]]<br /> <br /> [[Category:Osiris Calls|JumpToTurn]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGetEquippedShield&diff=5305 Osiris/API/CharacterGetEquippedShield 2017-12-21T14:36:48Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * query '''CharacterGetEquippedShield'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') ===== De..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * query '''CharacterGetEquippedShield'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''')<br /> ===== Description =====<br /> Returns in '''_ItemGUID''' the weapon wielded by '''_Character''' in their left hand.<br /> ===== Return Values =====<br /> * '''Success/Failure''': Fails if '''_Character''' does not exist, or if the character has no item in their left hand.<br /> * '''_ItemGuid''': The weapon equipped by '''_Character''' in their off (left) hand.<br /> ===== Notes =====<br /> * This is equivalent to [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]] for the '''Shield''' slot.<br /> ===== See Also =====<br /> * [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]]<br /> * [[Osiris/API/CharacterUnequipItem|CharacterEquipItem]]<br /> * [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]]<br /> * [[Osiris/API/CharacterGetEquippedWeapon|CharacterGetEquippedWeapon]]<br /> <br /> [[Category:Osiris Queries|CharacterGetEquippedShield]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGetEquippedWeapon&diff=5304 Osiris/API/CharacterGetEquippedWeapon 2017-12-21T14:36:13Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * query '''CharacterGetEquippedWeapon'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''')<br /> ===== Description =====<br /> Returns in '''_ItemGUID''' the weapon wielded by '''_Character''' in their right hand.<br /> ===== Return Values =====<br /> * '''Success/Failure''': Fails if '''_Character''' does not exist, or if the character is not wielding a weapon in their right hand.<br /> * '''_ItemGuid''': The weapon equipped by '''_Character''' in their main (right) hand.<br /> ===== Notes =====<br /> * This is equivalent to [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]] for the '''Weapon''' slot.<br /> ===== See Also =====<br /> * [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]]<br /> * [[Osiris/API/CharacterUnequipItem|CharacterEquipItem]]<br /> * [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]]<br /> * [[Osiris/API/CharacterGetEquippedShield|CharacterGetEquippedShield]]<br /> <br /> [[Category:Osiris Queries|CharacterGetEquippedWeapon]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGetEquippedWeapon&diff=5303 Osiris/API/CharacterGetEquippedWeapon 2017-12-21T14:35:18Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * query '''CharacterGetEquippedWeapon'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''')<br /> ===== Description =====<br /> Returns in '''_ItemGUID''' the item equipped by '''_Character''' in slot '''_Slotname''', if any.<br /> ===== Return Values =====<br /> * '''Success/Failure''': Fails if '''_Character''' does not exist, or if the character is not wielding a weapon in their right hand.<br /> * '''_ItemGuid''': The weapon equipped by '''_Character''' in their main (right) hand.<br /> ===== Notes =====<br /> * This is equivalent to [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]] for the '''Weapon''' slot.<br /> ===== See Also =====<br /> * [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]]<br /> * [[Osiris/API/CharacterUnequipItem|CharacterEquipItem]]<br /> * [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]]<br /> * [[Osiris/API/CharacterGetEquippedShield|CharacterGetEquippedShield]]<br /> <br /> [[Category:Osiris Queries|CharacterGetEquippedWeapon]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGetEquippedWeapon&diff=5302 Osiris/API/CharacterGetEquippedWeapon 2017-12-21T14:35:01Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * query '''CharacterGetEquippedWeapon'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') ===== De..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * query '''CharacterGetEquippedWeapon'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''')<br /> ===== Description =====<br /> Returns in '''_ItemGUID''' the item equipped by '''_Character''' in slot '''_Slotname''', if any.<br /> ===== Return Values =====<br /> * '''Success/Failure''': Fails if '''_Character''' does not exist, or if no item is equipped in '''_Slotname'''.<br /> * '''_ItemGuid''': The weapon equipped by '''_Character''' in their main (right) hand.<br /> ===== Notes =====<br /> * This is equivalent to [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]] for the '''Weapon''' slot.<br /> ===== See Also =====<br /> * [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]]<br /> * [[Osiris/API/CharacterUnequipItem|CharacterEquipItem]]<br /> * [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]]<br /> * [[Osiris/API/CharacterGetEquippedShield|CharacterGetEquippedShield]]<br /> <br /> [[Category:Osiris Queries|CharacterGetEquippedWeapon]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterUnequipItem&diff=5301 Osiris/API/CharacterUnequipItem 2017-12-21T14:25:09Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * call '''CharacterUnequipItem'''(''(CHARACTERGUID)'''''_Character''', ''(ITEMGUID)'''''Item''') ===== Description ===== Makes the '''_Character..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterUnequipItem'''(''(CHARACTERGUID)'''''_Character''', ''(ITEMGUID)'''''Item''')<br /> ===== Description =====<br /> Makes the '''_Character''' unequip '''_Item''', if the '''_Character''' has it equipped.<br /> ===== Notes =====<br /> * /<br /> ===== See Also =====<br /> *[[Osiris/API/CharacterEquipItem|CharacterEquipItem]]<br /> *[[Osiris/API/CharacterGetEquippedWeapon|CharacterGetEquippedWeapon]]<br /> *[[Osiris/API/CharacterGetEquippedShield|CharacterGetEquippedShield]]<br /> *[[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]]<br /> <br /> [[Category:Osiris Calls|CharacterUnequipItem]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterEquipItem&diff=5300 Osiris/API/CharacterEquipItem 2017-12-21T14:23:52Z

<p>LarIlya: Created page with "===== Full Definition(s) ===== * call '''CharacterEquipItem'''(''(CHARACTERGUID)'''''_Character''', ''(ITEMGUID)'''''Item''') ===== Description ===== Makes the '''_Character''..."</p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterEquipItem'''(''(CHARACTERGUID)'''''_Character''', ''(ITEMGUID)'''''Item''')<br /> ===== Description =====<br /> Makes the '''_Character''' equip '''_Item''', if the '''_Character''' meets the prerequisites for equipping it.<br /> ===== Notes =====<br /> * /<br /> ===== See Also =====<br /> *[[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]]<br /> *[[Osiris/API/CharacterGetEquippedWeapon|CharacterGetEquippedWeapon]]<br /> *[[Osiris/API/CharacterGetEquippedShield|CharacterGetEquippedShield]]<br /> *[[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]]<br /> <br /> [[Category:Osiris Calls|CharacterEquipItem]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterGetEquippedItem&diff=5299 Osiris/API/CharacterGetEquippedItem 2017-12-21T14:23:31Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * query '''CharacterGetEquippedItem'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [in]'''(STRING)'''''_Slotname''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''')<br /> ===== Description =====<br /> Returns in '''_ItemGUID''' the item equipped by '''_Character''' in slot '''_Slotname''', if any.<br /> ===== Return Values =====<br /> * '''Success/Failure''': Fails if '''_Character''' does not exist, or if no item is equipped in '''_Slotname'''.<br /> * '''_ItemGuid''': The item equipped by '''_Character''' in '''_Slotname'''.<br /> ===== Notes =====<br /> * The valid values for '''_Slotname''' are: '''Helmet''', '''Amulet''', '''Breast''', '''Belt''', '''Gloves''', '''Leggings''', '''Boots''', '''Weapon''', '''Shield''', '''Ring''', '''Ring2'''.<br /> ===== See Also =====<br /> * [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]]<br /> * [[Osiris/API/CharacterUnequipItem|CharacterEquipItem]]<br /> * [[Osiris/API/CharacterGetEquippedWeapon|CharacterGetEquippedWeapon]]<br /> * [[Osiris/API/CharacterGetEquippedShield|CharacterGetEquippedShield]]<br /> <br /> [[Category:Osiris Queries|CharacterGetEquippedItem]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterMoveToPosition&diff=5298 Osiris/API/CharacterMoveToPosition 2017-12-21T14:17:32Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterMoveToPosition'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_X''', ''(REAL)'''''_Y''', ''(REAL)'''''_Z''',''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''')<br /> ===== Description =====<br /> Makes the character walk (if '''_Running''' is '''0''') or run (if '''_Running''' is '''1''') to ('''_X''', '''_Y''', '''_Z'''). Once the character arrives there, the [[Osiris/API/StoryEvent|event]] '''_Event''' will be sent to '''_Character'''. If the '''_Character''' is in combat, they will move out of turn and ignoring remaining AP. If the destination is blocked, the call will fallback to a teleport to the destination or the nearest available position.<br /> ===== Notes =====<br /> * In practice, the '''_Y''' coordinate will be ignored and the character will snap to the floor at the destination location. If the destination location is not valid on the [[AI_grid|AI grid]], the game will find a nearby valid location on the AI grid and move the character there.<br /> * '''_Character''' will not participate in combats while it is moving.<br /> * If a player starts a conversation with '''_Character''', '''_Character''' will not stop and just keep moving.<br /> * Use '''ProcCharacterMoveTo''' to avoid the problems mentioned above and several others, except for not participating in combat.<br /> * Use '''ProcStateManagerCharacterMoveTo''' if you also want the character to join combats it encounters on its way.<br /> * Use '''[[Osiris/API/CharacterLookFromTrigger|CharacterLookFromTrigger]]''' or '''[[Osiris/API/CharacterLookAt|CharacterLookAt]]''' if the character needs to look in a specific direction upon arrival.<br /> ===== See Also =====<br /> * [[Osiris/API/StoryEvent|StoryEvent]]<br /> * [[Osiris/API/CharacterMoveTo|CharacterMoveTo]]<br /> * [[Osiris/API/TeleportTo|TeleportTo]]<br /> * [[Osiris/API/TeleportTo|TeleportToPosition]]<br /> * Helper [[Osiris/Shared/ProcCharacterMoveTo|ProcCharacterMoveTo]]<br /> * Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]]<br /> <br /> [[Category:Osiris Calls|CharacterMoveToPosition]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterMoveToPosition&diff=5297 Osiris/API/CharacterMoveToPosition 2017-12-21T14:16:21Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterMoveToPosition'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_X''', ''(REAL)'''''_Y''', ''(REAL)'''''_Z''',''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''')<br /> ===== Description =====<br /> Makes the character walk (if '''_Running''' is '''0''') or run (if '''_Running''' is '''1''') to ('''_X''', '''_Y''', '''_Z'''). Once the character arrives there, the [[Osiris/API/StoryEvent|event]] '''_Event''' will be sent to '''_Character'''. If the '''_Character''' is in combat, they will move out of turn and ignoring remaining AP. If the destination is blocked, the call will fallback to a teleport to the destination or the nearest available position.<br /> ===== Notes =====<br /> * In practice, the '''_Y''' coordinate will be ignored and the character will snap to the floor at the destination location. If the destination location is not valid on the [[AI_grid|AI grid]], the game will find a nearby valid location on the AI grid and move the character there.<br /> * '''_Character''' will not participate in combats while it is moving.<br /> * If a player starts a conversation with '''_Character''', '''_Character''' will not stop and just keep moving.<br /> * Use '''ProcCharacterMoveTo''' to avoid the problems mentioned above and several others, except for not participating in combat.<br /> * Use '''ProcStateManagerCharacterMoveTo''' if you also want the character to join combats it encounters on its way.<br /> ===== See Also =====<br /> * [[Osiris/API/StoryEvent|StoryEvent]]<br /> * [[Osiris/API/CharacterMoveTo|CharacterMoveTo]]<br /> * [[Osiris/API/TeleportTo|TeleportTo]]<br /> * [[Osiris/API/TeleportTo|TeleportToPosition]]<br /> * Helper [[Osiris/Shared/ProcCharacterMoveTo|ProcCharacterMoveTo]]<br /> * Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]]<br /> <br /> [[Category:Osiris Calls|CharacterMoveToPosition]]</div>

LarIlya https://docs.larian.game/index.php?title=Osiris/API/CharacterMoveTo&diff=5296 Osiris/API/CharacterMoveTo 2017-12-21T14:14:26Z

<p>LarIlya: </p> <hr /> <div>===== Full Definition(s) =====<br /> * call '''CharacterMoveTo'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''', ''(INTEGER)'''''_IncreaseSpeed''')<br /> ===== Description =====<br /> Causes '''_Character''' to start moving to '''_Target''', either walking or running depending on whether '''_Running''' is '''0''' or '''1'''. Once '''_Character''' has arrived at its destination, the event '''_Event''' will be raised for '''_Character'''. If '''_IncreaseSpeed''' is '''1''', '''_Character''' will starting moving increasingly faster the longer it has been moving.<br /> ===== Notes =====<br /> * If '''_Target''' is unreachable, '''_Character''' may teleport there.<br /> * '''_Character''' will not participate in combats while it is moving.<br /> * If a player starts a conversation with '''_Character''', '''_Character''' will not stop and just keep moving.<br /> * Use '''ProcCharacterMoveTo''' to avoid the problems mentioned above and several others, except for not participating in combat.<br /> * Use '''ProcStateManagerCharacterMoveTo''' if you also want the character to join combats it encounters on its way.<br /> * Use '''[[Osiris/API/CharacterLookFromTrigger|CharacterLookFromTrigger]]''' or '''[[Osiris/API/CharacterLookAt|CharacterLookAt]]''' if the character needs to look in a specific direction upon arrival.<br /> ===== See Also =====<br /> * [[Osiris/API/StoryEvent|StoryEvent]]<br /> * [[Osiris/API/CharacterMoveToPosition|CharacterMoveToPosition]]<br /> * [[Osiris/API/CharacterLookFromTrigger|CharacterLookFromTrigger]]<br /> * Helper [[Osiris/Shared/ProcCharacterMoveTo|ProcCharacterMoveTo]]<br /> * Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]]<br /> <br /> [[Category:Osiris Calls|CharacterMoveTo]]</div>

LarIlya