Divinity Engine Wiki - User contributions [en]

Osiris/Shared/ProcGetClosestAvailableCharacterTo

2018-01-29T17:27:32Z

LarSeb: Reverted edits by Greever (talk) to last revision by Tinkerer

===== Full Definition(s) =====
* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''', ''(INTEGER)'''''_SightCheck''')
* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''', ''(INTEGER)'''''_SightCheck''', ''(INTEGER)'''''_PartyCheck''', ''(CHARACTERGUID)'''''_Player''')
* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''', ''(INTEGER)'''''_SightCheck''', ''(INTEGER)'''''_PartyCheck''', ''(CHARACTERGUID)'''''_Player''', ''(CHARACTERGUID)'''''_ExceptPlayer''')

===== Description =====
The first invocation is equivalent to calling the second one with '''_PartyCheck == 0''' and '''_Player == NULL'''.

The second invocation is equivalent to calling the third one with '''_ExceptPlayer === NULL''' .

Gets the closest '''player''' character to '''_Obj''' that is available to start a dialog with '''_Obj'''. Set '''_SightCheck''' to 1 if that character must be able to see '''_Obj'''. If '''_PartyCheck''' is 1, you must also and pass a valid parameter for '''_Player''', and the found player character (if any) will be guaranteed to be in the same party as '''_Player'''. If '''_ExceptPlayer''' is not NULL, then this routine will consider '''_ExceptPlayer''' to be unavailable even if they pass the other checks.

===== Return Values =====
* '''DB_ClosestAvailablePlayer'''(''(CHARACTERGUID)'''''_Char''''',(CHARACTERGUID)'''''_Obj'''): closest player that can start a dialog with '''_Obj''' (conforming to all requested conditions), if any.
* '''DB_ClosestAvailablePlayer_NoAvailablePlayer'''(''(CHARACTERGUID)'''''_Obj'''): Set if no player character is available that conforms to the requested conditions.

===== Notes =====
* /

===== See Also =====
* [[Osiris/API/GetClosestAlivePlayer|GetClosestAlivePlayer]]

[[Category:Osiris Shared Mod Helpers|GetClosestAvailableCharacterTo]]

Setup: Maya Exporter

2017-11-10T14:45:54Z

LarSeb:

The files should be present in the editor data ''~DivinityEngineDataPath~\Data\Editor\Tools\Maya\'' 
These scripts were written for Maya 2015 on Windows. 
 
All the files you need you'll find in ''~DivinityEngineDataPath~\Data\Editor\Tools\Maya\''

To have the granny plugin working in Maya 2015 copy ''larian_maya2015_x64.mll '' to your maya plugin folder ''~Maya2015InstallFolder~\Maya2015\bin\plug-ins'' 
To have the scripts working in Maya 2015 copy the ''userSetup.py'' and ''LarianStudiosModTools'' folder into ''~YourDocuments~''\maya\scripts 
 
When starting up Maya the userSetup.py should automaticly create a Larian_Mod_Tools shelf for you with the relevant scripts saved into buttons. 
 
Once you have launched Maya with this userSetup for the first time use the modify path script (ModP Button on the shelf) to set up your divinity engine data path for the exporter. This info will be saved in you maya scripts folder. 
 
 
{| class="wikitable"
|
===For advanced users===
If you already have a python userSetup file taking care of several preferences you can add this method and add a call to it during your start up sequence:
 
 
<nowiki>

def scriptRun():
mainPath = os.environ['MAYA_APP_DIR']+ "/scripts/LarianStudiosModTools/" #Best guess for maya path install
#Load toolbar creation script
setupScript = imp.load_source('secondary', mainPath+"LarianToolbarSetup.py")
setupScript.run() </nowiki>
 
Then you only need to copy the ''LarianStudiosModTools'' folder

|}

Setup: Maya Exporter

2017-11-10T14:45:38Z

LarSeb:

The files should be present in the editor data (insert path approximate here) 
These scripts were written for Maya 2015 on Windows. 
 
All the files you need you'll find in ''~DivinityEngineDataPath~\Data\Editor\Tools\Maya\''

To have the granny plugin working in Maya 2015 copy ''larian_maya2015_x64.mll '' to your maya plugin folder ''~Maya2015InstallFolder~\Maya2015\bin\plug-ins'' 
To have the scripts working in Maya 2015 copy the ''userSetup.py'' and ''LarianStudiosModTools'' folder into ''~YourDocuments~''\maya\scripts 
 
When starting up Maya the userSetup.py should automaticly create a Larian_Mod_Tools shelf for you with the relevant scripts saved into buttons. 
 
Once you have launched Maya with this userSetup for the first time use the modify path script (ModP Button on the shelf) to set up your divinity engine data path for the exporter. This info will be saved in you maya scripts folder. 
 
 
{| class="wikitable"
|
===For advanced users===
If you already have a python userSetup file taking care of several preferences you can add this method and add a call to it during your start up sequence:
 
 
<nowiki>

def scriptRun():
mainPath = os.environ['MAYA_APP_DIR']+ "/scripts/LarianStudiosModTools/" #Best guess for maya path install
#Load toolbar creation script
setupScript = imp.load_source('secondary', mainPath+"LarianToolbarSetup.py")
setupScript.run() </nowiki>
 
Then you only need to copy the ''LarianStudiosModTools'' folder

|}

Setting up the editor

2017-11-10T14:45:18Z

LarSeb:

Game Master Mode

2017-09-18T14:49:54Z

LarSeb:

[[File:GM_Banner.jpg|center]]
 
== How to ==
* [[Creating Campaign| '''Create''' a campaign from scratch or '''play''' a campaign]]
* [[Publish Campaign| '''Publish''' a campaign]]

== Game Master Panels ==
* [[Game Menu| '''Game Menu''', where the game options are like saving and going back to the main menu]]
* [[Overview| '''Overview Map''', where the Game Master create the world map and see everything]]
* [[Scenes| '''Scenes''', where the Game Master create all the locations the players will travel]]
* [[Stickies| '''Stickies''', the notes for the Game Master]]
* [[Vignettes| '''Vignettes''', the storytelling part]]
* [[Monster Items| '''(Coming Soon) Monsters & Items''', all the usable entities for the Game Master]]
* [[Encounter| '''(Coming Soon) Encounter Manager''', where the Game Master setup the encounters]]
* [[Item Generator| '''(Coming Soon) Item Generator''', where the Game Master create custom equipment]]
* [[Mood| '''(Coming Soon) Mood Panel''', where the Game Master set the ambiance of a scene]]
* [[Surface| '''(Coming Soon) Surface Panel''', used by the Game Master to paint surfaces in a scene]]
* [[Start Point| '''(Coming Soon) Start Point''', used by the Game Master to place a spawning location in a scene for the players]]
* [[GM Inventory| '''(Coming Soon) Game Master Inventory''', where the Game Master can put entities he want to use quickly]]
* [[GM Skils| '''(Coming Soon) Game Master Skills''', all the skills in the game to be given to something by the Game Master]]
* [[Roll| '''(Coming Soon) Dice Roll''', where the Game Master will be able to ask dice rolls from the player or him/herself]]
* [[Possess| '''(Coming Soon) Possess Panel''', where the Game Master takes control or manage an entity]]
* [[Manage| '''(Coming Soon) Manage Panel''', where the Game Master can change everything on an entity]]
* [[Manage Status| '''(Coming Soon) Status Panel''', where the Game Master can add or remove status on an entity]]

== Tutorial Videos ==
<youtube>ZSh7hOZl9hg</youtube>

Setup: Editor Steam

2017-09-18T09:23:59Z

LarSeb:

==1. Enable DLC==
The editor needs some extra data. For this you need to enable a free DLC for DOS2 on steam called 'Divinity Engine 2 Data'. 
Go to your steam library, right click Divinity: Original Sin 2 and select properties.

[[File:Dlcdivinityenginedata.png]]

==2. Install toolset==
Open your library and go to the tools section. There you will find 'The Divinity Engine 2'.

[[File:Toolsdivinityengine2.png]]

==3. Initial setup==
On starting up the divinity engine 2, it will ask for a game data path. Set this to your Divinity: Original Sin 2 'Data' folder. 
It looks approximately like this for steam: 'C:\Program Files (x86)\Steam\steamapps\common\Divinity Original Sin 2\Data'.

[[File:Initialsetup.png]]

Setting up the editor

2017-09-18T08:26:45Z

LarSeb:

Setup: Maya Exporter

2017-09-18T08:26:24Z

LarSeb: LarSeb moved page Setup: Max Exporter to Setup: Maya Exporter without leaving a redirect

==Coming soon==

The files should be present in the editor data (insert path approximate here) 
These scripts were written for Maya 2015 on Windows. 
 
To have the scripts working in Maya 2015 copy the ''userSetup.py'' and ''LarianStudiosModTools'' folder into ''~YourDocuments~''\maya\scripts 
 
When starting up Maya the userSetup.py should automaticly create a Larian_Mod_Tools shelf for you with the relevant scripts saved into buttons. 
 
Once you have launched Maya with this userSetup for the first time use the modify path script (ModP Button on ther shelf) to set up your divinity engine data path for the exporter. This info will be saved in you maya scripts folder. 
 
 
{| class="wikitable"
|
===For advanced users===
If you already have a python userSetup file taking care of several preferences you can add this method and add a call to it during your start up sequence:
 
 
<nowiki>

def scriptRun():
mainPath = os.environ['MAYA_APP_DIR']+ "/scripts/LarianStudiosModTools/" #Best guess for maya path install
#Load toolbar creation script
setupScript = imp.load_source('secondary', mainPath+"LarianToolbarSetup.py")
setupScript.run() </nowiki>
 
Then you only need to copy the ''LarianStudiosModTools'' folder

|}

Command list

2017-09-16T08:14:31Z

LarSeb:

== Info ==

[[ReCon]] can be attached to the game or editor to send console commands.

{| class="wikitable"
|-
|'''Some commands will only be applied on the object that is currently selected (i.e. with CTRL SHIFT Click).'''
Ctrl + shift + click an object to select it or command 
select %name% - needed for some commands
|-
|}

== List ==

==== Combat ====

* killcombat - kills all enemies in current combat
* peace on/off - turn peace mod on off
* god - turn god mode on/of
* resurrect - resurrects currently selected character
* nocooldowns - removes cooldowns
* infiniteAp - your actions will cost 0 AP
* infiniteMemory - You will have over 9000 memory
* think on/off - enables/disables AI char/item scripts except player
* setHPPercentage <percentage> - e.g setHPPercentage 20, sets the HP of a (selected) character to 20%
* charm %character or item name% -> makes the current select character charmed by character/item in parameter
* setCanFight %true/false%- enables / disables the CanFight option for the selected entity (it will still join combat, just not get a turn)
* setCanJoinCombat %true/false% - enables / disables the CanJoinCombat option for the selected entity
* setAlignment %alignmentID% - Changes the alignment of the selected entity
* nearlyKill - Sets the HP of the current selected character to 1.
* killArmor - Sets the magic and physical armor of the selected character to 0.

==== Party setup ====

* spawnitem GLO_QA_Debug_Item: spawns a Debug book to start in Act 2 with a Party setup - easiest way to start Act 2
* levelup %amount% - levels up entire party by %amount% levels
* unlockall - unlocks all skills
* maxout - gives level 27 and maxes out stats
* gold %amount% - gives both players half of %amount% in gold
* givetreasure %table_name%
* addExp %amount% - gives the selected character %amount% xp
* magemana - Adds the maximum amount of source points for this character
* givetreasure CheatBooks and then the respective element will yield all the skillbooks of that element: eg. CheatBooksAir, CheatBooksEarth, CheatBooksNecromancy...

==== Generics ====

* raiseTension: increase tension ingame
* ResetCrimes: removes all performed Crimes and clears your criminal records, this will lower the tension again

==== General ====

* setWalkSpeedMultiplier %multiplier% - Multiplies your walk and run speed by value (4 seems to be a nice value)
* loadlevel <levelname> - e.g. loadlevel Cyseal: loads level
* oe <command> - send an Osirs TextEventSet event with <command> as the parameter
* teleport <target> - e.g teleport Zandalor: teleport to certain character, object, trigger on current level
* teleportToMe %name% - teleports a character to currently selected character
* goto x y - e.g. goto 12 174: teleport to x y coordinates on current level
* rps win - win a CIR confrontation
* rps lose - lose a CIR confrontation
* shroud %on/off% - turn shroud (a.k.a. fog of war) on/off
* reloadScripts - reloads scripts
* reloadStory - reloads osiris
* statusapply <status> <duration> - e.g. statusapply FROZEN 5 - apply status to selected for 5 turns. Duration -1 sets a permanent status.
* statusremove <status>
* autoidentify %on/off% - let's you see all magic items
* think %on/off% - Disables the AI for all NPCs
* give <objectname> - Moves an item from somewhere in the game (local item, quest item, global item) to your inventory.
* create <statname> - Creates an instance of a stats object in your inventory (notice there is a huge difference between give and create!!!1)
* setOffstage <characterName|itemName|characterUUID|itemUUID> - removes (raises OFFSTAGE flag) for specified character or item
* charAmbientLight <on|off> - enables or disables ambient light for currently selected player's character

==== Dungeon master ====

* addDungeonMaster
* removeDungeonMaster

==== System ====

* usecontroller
* usekeyboard

==== Screen capture ====

* SetCaptureScale %amount% - Set scale for screenshot and video capture resolution (game resolution * amount)
* SetVideoCaptureFPS %amount% - Set target FPS to capture screenshots for the video capture mode (amount x screenshots per ingame sec.)

==== Debugging ====

* fps %amount% - set the client's fps to a specified amount
* show projectiles <optional> - show debugging info for projectiles - optional: client (client only); server (server only); %time% (display time)
* hide projectiles - hide debugging info for projectiles
* show crimes <optional> - show debugging information for crimes - optional: %index% (index of the crime, provides detailed information)
* hide crimes - hide debugging information for crimes

Game Master Mode

2017-09-15T21:31:22Z

LarSeb:

Game Master Mode

2017-09-15T17:45:16Z

LarSeb:

Setting up the editor

2017-09-15T16:55:35Z

LarSeb:

[[File:LarianLogo_Icon.png|32px]] <big>[[Setup: Editor Steam | Editor Setup (Steam)]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Setup: Max Exporter | 3Ds Max Exporter (Coming soon)]]</big>

Setting up the editor

2017-09-15T16:55:21Z

LarSeb:

Setup: Maya Exporter

2017-09-15T16:55:03Z

LarSeb:

Setup: Editor Steam

2017-09-15T16:43:02Z

LarSeb:

==1. Enable DLC==
The editor needs some extra data. For this you need to enable a DLC for DOS2 on steam called 'Divinity Engine 2 Data'. 
Go to your steam library, right click Divinity: Original Sin 2 and select properties.

[[File:Dlcdivinityenginedata.png]]

==2. Install toolset==
Open your library and go to the tools section. There you will find 'The Divinity Engine 2'.

[[File:Toolsdivinityengine2.png]]

==3. Initial setup==
On starting up the divinity engine 2, it will ask for a game data path. Set this to your Divinity: Original Sin 2 'Data' folder. 
It looks approximately like this for steam: 'C:\Program Files (x86)\Steam\steamapps\common\Divinity Original Sin 2\Data'.

[[File:Initialsetup.png]]

Setup: Editor Steam

2017-09-15T16:34:21Z

LarSeb:

==1. Enable DLC==
The editor needs some extra data. For this you need to enable a DLC for DOS2 on steam called 'Divinity Engine 2 Data'.

[[File:Dlcdivinityenginedata.png]]

==2. Install toolset==
Open your library and go to the tools section. There you will find 'The Divinity Engine 2'.

[[File:Toolsdivinityengine2.png]]

==3. Initial setup==
On starting up the divinity engine 2, it will ask for a game data path. Set this to your Divinity: Original Sin 2 'Data' folder. 
It looks approximately like this for steam: 'C:\Program Files (x86)\Steam\steamapps\common\Divinity Original Sin 2\Data'.

[[File:Initialsetup.png]]

Setup: Editor Steam

2017-09-15T16:32:46Z

LarSeb:

==1. Enable DLC==
The editor needs some extra data. For this you need to enable a DLC for DOS2 on steam called 'Divinity Engine 2 Data'.

[[File:Dlcdivinityenginedata.png]]

==2. Install toolset==
Open your library and go to the tools section. There you will find 'The Divinity Engine 2'.

[[File:Toolsdivinityengine2.png]]

==3. initial setup==
On starting up the divinity engine 2, it will ask for a game data path. Set this to your Divinity: Original Sin 2 'Data' folder. 
It looks approximately like this for steam: 'C:\Program Files (x86)\Steam\steamapps\common\Divinity Original Sin 2\Data'.

[[File:Initialsetup.png]]

Setup: Editor Steam

2017-09-15T16:32:31Z

LarSeb:

===1. Enable DLC===
The editor needs some extra data. For this you need to enable a DLC for DOS2 on steam called 'Divinity Engine 2 Data'.

[[File:Dlcdivinityenginedata.png]]

===2. Install toolset===
Open your library and go to the tools section. There you will find 'The Divinity Engine 2'.

[[File:Toolsdivinityengine2.png]]

===3. initial setup===
On starting up the divinity engine 2, it will ask for a game data path. Set this to your Divinity: Original Sin 2 'Data' folder. 
It looks approximately like this for steam: 'C:\Program Files (x86)\Steam\steamapps\common\Divinity Original Sin 2\Data'.

[[File:Initialsetup.png]]

Setup: Editor Steam

2017-09-15T16:32:23Z

LarSeb:

===1. Enable DLC===
The editor needs some extra data. For this you need to enable a DLC for DOS2 on steam called 'Divinity Engine 2 Data'.

[[File:Dlcdivinityenginedata.png]]

===2. Install toolset===
Open your library and go to the tools section. There you will find 'The Divinity Engine 2'.

[[File:Toolsdivinityengine2.png]]

===3. initial setup==
On starting up the divinity engine 2, it will ask for a game data path. Set this to your Divinity: Original Sin 2 'Data' folder. 
It looks approximately like this for steam: 'C:\Program Files (x86)\Steam\steamapps\common\Divinity Original Sin 2\Data'.

[[File:Initialsetup.png]]

File:Initialsetup.png

2017-09-15T16:28:20Z

LarSeb:

Setup: Editor Steam

2017-09-15T16:26:23Z

LarSeb: Created page with "===1. Enable DLC=== The editor needs some extra data. For this you need to enable a DLC for DOS2 on steam called 'Divinity Engine 2 Data'. File:Dlcdivinityenginedata.png..."

File:Toolsdivinityengine2.png

2017-09-15T16:23:30Z

LarSeb:

File:Dlcdivinityenginedata.png

2017-09-15T16:20:47Z

LarSeb:

Setup: Maya Exporter

2017-09-15T16:15:01Z

LarSeb: Created page with "==Setting up the Maya 2015 export tools== The files should be present in the editor data (insert path approximate here) These scripts were written for Maya 2015 on Wind..."

==Setting up the Maya 2015 export tools==

The files should be present in the editor data (insert path approximate here) 
These scripts were written for Maya 2015 on Windows. 
 
To have the scripts working in Maya 2015 copy the ''userSetup.py'' and ''LarianStudiosModTools'' folder into ''~YourDocuments~''\maya\scripts 
 
When starting up Maya the userSetup.py should automaticly create a Larian_Mod_Tools shelf for you with the relevant scripts saved into buttons. 
 
Once you have launched Maya with this userSetup for the first time use the modify path script (ModP Button on ther shelf) to set up your divinity engine data path for the exporter. This info will be saved in you maya scripts folder. 
 
 
{| class="wikitable"
|
===For advanced users===
If you already have a python userSetup file taking care of several preferences you can add this method and add a call to it during your start up sequence:
 
 
<nowiki>

def scriptRun():
mainPath = os.environ['MAYA_APP_DIR']+ "/scripts/LarianStudiosModTools/" #Best guess for maya path install
#Load toolbar creation script
setupScript = imp.load_source('secondary', mainPath+"LarianToolbarSetup.py")
setupScript.run() </nowiki>
 
Then you only need to copy the ''LarianStudiosModTools'' folder

|}

Setting up the editor

2017-09-15T16:14:47Z

LarSeb:

Setting up the editor

2017-09-15T16:12:53Z

LarSeb:

[[File:LarianLogo_Icon.png|32px]] <big>[[Setup: Editor Steam | Editor Setup (Steam)]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Character | Character]]</big>

Main Page

2017-09-13T20:57:46Z

LarSeb:

<gallery mode=packed heights=550px>
File:DivinityEngine-thumbnail.png|link=The Divinity Engine 2|The Divinity Engine 2
File:GameMaster-thumbnail.png|link=Game Master Mode|Game Master Mode
</gallery>

MediaWiki:Sidebar

2017-09-07T14:07:53Z

LarSeb:

MediaWiki:Sidebar

2017-08-29T18:03:09Z

LarSeb:

Community guides

2017-08-28T08:54:07Z

LarSeb:

* [[Skill creation]]

Game Master Mode

2017-08-25T13:30:05Z

LarSeb: Protected "Game Master Mode" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

[[File:GM_Banner.jpg|center]]
 
== How to ==
* [[Creating Campaign| Create a campaign from scratch]]
* [[Play Campaign| Play a campaign]]
* [[Publish Campaign| Publish a campaign]]

== Game Master Panels ==
* [[Overview| '''Overview Map''', where the Game Master create the world map]]
* [[Scenes| '''Scenes''', where the Game Master create all the places the players will travel]]
* [[Stickies| '''Stickies''', the notes for the Game Master]]
* [[Vignettes| '''Vignettes''', the storytelling part]]
* [[Monster Items| '''Monsters & Items''', all the usable entities for the Game Master]]
* [[Encounter| '''Encounter Manager''', where the Game Master setup the encounters]]
* [[Item Generator| '''Item Generator''', where the Game Master create custom equipment]]
* [[Mood| '''Mood Panel''', where the Game Master set the ambiance of a scene]]
* [[Surface| '''Surface Panel''', used by the Game Master to paint surfaces in a scene]]
* [[Start Point| '''Start Point''', used by the Game Master to place a spawning location in a scene for the players]]
* [[GM Inventory| '''Game Master Inventory''', where the Game Master can put entities he want to use quickly]]
* [[GM Skils| '''Game Master Skills''', all the skills in the game to be given to something by the Game Master]]
* [[Roll| '''Dice Roll''', where the Game Master will be able to ask dice rolls from the player or him/herself]]
* [[Pocess| '''Pocess Panel''', where the Game Master take control or manage an entity]]
* [[Manage| '''Manage Panel''', where the Game Master can change everything on an entity]]
* [[Manage Status| '''Status Panel''', where the Game Master can add or remove status on an entity]]

Community guides

2017-08-25T13:29:56Z

LarSeb: Created page with "PLACEHOLDER"

PLACEHOLDER

Larian guides

2017-08-25T13:29:30Z

LarSeb: Protected "Larian guides" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

<div>
<gallery mode=packed-overlay heights=250px style="max-width:80%;margin:auto">
File:StartGuide-thumbnail.png|link=Setting up the editor|Setting up the editor for the first time.
File:ProjectGuide-thumbnail.png|link=Working with projects|On creating/loading and publishing a project that suits my needs.
File:LevelGuide-thumbnail.png|link=Working with levels|On the different ways to create/load a level.
File:MyFirstCreation-thumbnail.png|link=My first...|How do I create my first... ?
File:Modding-thumbnail.png|link=Modding...|How do I modify an existing... ?
File:FAQ.png|link=Frequently Asked Questions|Frequently Asked Questions.
</gallery>
</div>

 
 
 

[[David list WIP]]

The Divinity Engine 2

2017-08-25T13:29:12Z

LarSeb: Protected "The Divinity Engine 2" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

[[File:dos2banner.jpg|center]]
 

<gallery mode=packed heights=490px>
File:TechnicalDocs.png|link=Technical documentation|Technical Documentation
File:LarianGuides.png|link=Larian guides|Larian Guides
File:CommunityGuides.png|link=Community guides|Community Guides
</gallery>

Credits for tarot card fan art go to the lovely [http://drathe.deviantart.com/ Drathe]

 
 
= Technical Documentation =
[[Technical documentation|Click here to go to the technical documentation.]]

= Larian Guides =
[[Larian guides|Click here to go to the Larian guides.]]

= Community Guides =
[[Community guides|Click here to go to the community guides.]]

= !EDITING WIKI GUIDELINES: PLEASE READ! =
[[Editing guidelines]]

Technical documentation

2017-08-24T19:22:33Z

LarSeb: Protected "Technical documentation" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

== Systems ==
* [[Templates explanation|Root and local templates, how do they work?]]
* [[AI grid|AI grid: surfaces, walkables, ...]]
* [[Scripting|Scripting]]
* [[Osiris|Osiris: story scripting]]
* [[Modding internals|Modding: internal system]]
* [[Light probes]]
* [[Entity types]]
* [[Decals]]
* [[Triggers]]

== Panels ==
* [[Root template panel]]
* [[Content browser]]
* [[World outliner]]
* [[Sidebar]]
* [[AI grid panel]]
* [[Project settings window]]
* [[Publish project window]]
* [[Combat group panel]]
* [[Terrain panel]]
* [[Decal painter panel]]
* [[Instance painter panel]]
* [[Atmosphere panel]]
* [[Work atmosphere panel]]

== Editors ==
* [[Material editor]]
* [[Stats editor]]
* [[Story editor]]
* [[Script editor]]
* [[Journal editor]]
* [[Translated string key editor]]

== Misc ==
* [[Editor preferences]]
* [[Project browser]]
* [[Level browser]]
* [[Main toolbar]]
* [[Osiris API Tips]]
* [[Sandbox]]
* [[AI bound editor]]
* [[Script debugger]]

== Console ==
* [[Command list]]
* [[ReCon|ReCon: remote console]]

Category:Osiris Queries

2017-08-08T13:55:21Z

LarSeb: Created page with "test"

test

Technical documentation

2017-08-07T12:35:10Z

LarSeb:

== Systems ==
* [[Templates explanation|Root and local templates, how do they work?]]
* [[AI grid|AI grid: surfaces, walkables, ...]]
* [[Scripting|Scripting]]
* [[Osiris|Osiris: story scripting]]
* [[Modding internals|Modding: internal system]]
* [[Light probes]]
* [[Entity types]]
* [[Decals]]

== Panels ==
* [[Root template panel]]
* [[Content browser]]
* [[World outliner]]
* [[Sidebar]]
* [[AI grid panel]]
* [[Project settings window]]
* [[Publish project window]]
* [[Combat Group Panel]]
* [[Terrain panel]]
* [[Decal painter panel]]
* [[Instance Painter Panel]]

== Editors ==
* [[Material editor]]
* [[Stats editor]]
* [[Story editor]]
* [[Script editor]]
* [[Journal editor]]
* [[Translated string key editor]]

== Misc ==
* [[Editor preferences]]
* [[Project browser]]
* [[Level browser]]
* [[Main toolbar]]
* [[Osiris API Tips]]
* [[Sandbox]]
* [[AI Bound Editor]]
* [[Script debugger]]

== Console ==
* [[Command list]]
* [[ReCon|ReCon: remote console]]

David list WIP

2017-08-07T07:06:38Z

LarSeb: Created page with "== Step 1: New Project - What type of project do I need? == * Campaign|Campaign: You want to create an entire story, with levels and fights and dialogues, and a lot of scrip..."

== Step 1: New Project - What type of project do I need? ==
* [[Campaign|Campaign: You want to create an entire story, with levels and fights and dialogues, and a lot of scripting.]]
* [[Add-on|Add-on: You want to modify non-story parts of the existing campaign or another mod.]]
* [[Story mod|Story mod: You want to change or add to the Divinity Original Sin 2 story code.]]
== Step 2: Load or Create Level ==
* [[Choose Level|Choose Level: Load an existing level in your project or in the campaign]]
* [[Create New Level|Create New Level: A fresh start.]]
* [[Sandbox|But I don't want to create or change a level: choose Sandbox. Choose sandbox if you want to work on treasure, stats, textures, models...]]
== Step 3: Now how do I... ==
* [[MOD THE MAIN CAMPAIGN]]
* [[Modding visuals]]
* [[Change icons of statuses, skills, NPCs...]]
* [[Add player icons to select from]]
* [[Change 3D models]]
* [[Change a texture]]
* [[Change the atmosphere (lighting etc)]]
* [[Change animations]]
* [[Change existing materials, or create and assign new materials]]
* [[Change visual fx]]
* [[Change Balancing]]
* [[Change enemy and NPC stats and gear]]
* [[Change enemy behaviour and known skills]]
* [[Change base stats of player characters]]
* [[Change presets and create new presets ("classes")]]
* [[Change player weapon and armour stats]]
* [[Change some exposed combat and gameplay variables]]
* [[Change the gold value of things]]
* [[Change what food and potions do]]
* [[Change crafting ingredients and results]]
* [[Change treasure settings of containers and characters]]
* [[Change trade inventories of characters]]
* [[Change magical properties of magic modifiers on generated items]]
* [[Change settings of magic generation of items]]
* [[Change some talent settings]]
* [[Change skill properties (e.g. damage, action points...)]]
* [[Change skill, crafting and item requirements; and talent requirements]]
* [[Change how statuses act and react]]
* [[Change some exposed surface settings]]
* [[Translate the game]]
* [[By using a loca kit, not the modding tool.]]
* [[Make one of those fancy camera-flies-through-the-level movies?]]
* [[Use splines!]]
* [[Change interactivity]]
* [[Change what items you can pick up and move]]
* [[Change what item tooltips are shown in the world]]
* [[Change how items behave when you destroy them]]
* [[Change, add, remove use actions on items]]
* [[Change text]]
* [[Add hints to the loading screen]]
* [[Change character names, item names and item descriptions]]
* [[Change contents of books]]
* [[Change dialogs]]
* [[Change journal entries]]
* [[Redecorate existing levels]]
* [[Move items and characters around]]
* [[Change the terrain]]
* [[Add books to the game]]
* [[Add keys to existing chests]]
* [[Add chests and containers to the game]]
* [[Add decorational items to the game]]
* [[Add weapons and armour to the game]]
* [[Change terrain]]
* [[Modify scripting]]
* [[Change story code]]
* [[Change behaviour script code]]
* [[ADD STUFF TO THE MAIN CAMPAIGN]]
== FAQ: Why can I not... ==
* [[Add talents to the game?]]
* [[Talents are coded in C++. They usually override or change the gameplay rules in such a unique way, that it's not viable to create reusable templates and make them data driven.]]
* [[Change all sounds in the game?]]
* [[We use Wwise and sounds have to be added and processed in Wwise.]]
* [[Mod the UI?]]

{| class="wikitable" style="width: 50%;"
| tables
| are
|-
| style="width: 30%;"|
hard
| yes
|-
| FAQ
|}

Larian guides

2017-08-07T07:06:21Z

LarSeb:

<div>
<gallery mode=packed-overlay heights=250px style="max-width:79%;margin:auto">
File:StartGuide-thumbnail.png|link=Setting up the editor|Setting up the editor for the first time.
File:ProjectGuide-thumbnail.png|link=Working with projects|On creating/loading and publishing a project that suits my needs.
File:LevelGuide-thumbnail.png|link=Working with levels|On the different ways to create/load a level.
File:FAQ.png|link=Frequently Asked Questions|Frequently Asked Questions.
</gallery>
</div>

 
 
 

[[David list WIP]]

Technical documentation

2017-08-02T15:01:18Z

LarSeb:

== Systems ==
* [[Templates explanation|Root and local templates, how do they work?]]
* [[AI grid|AI grid: surfaces, walkables, ...]]
* [[Scripting|Scripting]]
* [[Osiris|Osiris: story scripting]]
* [[Modding internals|Modding: internal system]]
* [[Light probes]]
* [[Entity types]]

== Panels ==
* [[Root template panel]]
* [[World outliner]]
* [[Sidebar]]
* [[AI grid panel]]
* [[Project settings window]]
* [[Publish project window]]
* [[Combat Group Panel]]
* [[Terrain panel]]

== Editors ==
* [[Material editor]]
* [[Stats editor]]
* [[Story editor]]
* [[Script editor]]
* [[Translated string key editor]]

== Misc ==
* [[Editor preferences]]
* [[Project browser]]
* [[Level browser]]
* [[Main toolbar]]
* [[Osiris API Tips]]
* [[Sandbox]]
* [[AI Bound Editor]]

== Console ==
* [[Command list]]
* [[ReCon|ReCon: remote console]]

Technical documentation

2017-08-02T14:48:27Z

LarSeb:

== Systems ==
* [[Templates explanation|Root and local templates, how do they work?]]
* [[AI grid|AI grid: surfaces, walkables, ...]]
* [[Scripting|Scripting]]
* [[Osiris|Osiris: story scripting]]
* [[Modding internals|Modding: internal system]]
* [[Light probes]]

== Panels ==
* [[Root template panel]]
* [[World outliner]]
* [[Sidebar]]
* [[AI grid panel]]
* [[Project settings window]]
* [[Publish project window]]
* [[Combat Group Panel]]
* [[Terrain panel]]

== Editors ==
* [[Material editor]]
* [[Stats editor]]
* [[Story editor]]
* [[Script editor]]
* [[Translated string key editor]]

== Misc ==
* [[Editor preferences]]
* [[Project browser]]
* [[Level browser]]
* [[Main toolbar]]
* [[Osiris API Tips]]
* [[Sandbox]]
* [[AI Bound Editor]]

== Console ==
* [[Command list]]
* [[ReCon|ReCon: remote console]]

Templates explanation

2017-08-01T12:59:47Z

LarSeb:

= Root template =
Root templates are the '''building blocks''' of our game. A root template can be an item, a character, a trigger, etc.

A root template '''describes''' a game object. It contains the '''data''' of a thing necessary to put that thing in the game.
 (For instance: its visual, the physics, the AI bounds, name, stats, scripts, etc. All these properties describe and make up the game object.)

A root template is set up so that it defines the default visual and default behaviour of the game object. This means that a root template '''contains important gameplay''' information.

For our interactive, reactive, systemic game to work correctly, we need roots and they must be carefully set up.

[[File:Rootsarmy.jpg|frame|Army Men game has 2 roots: ArmyMan and Tank. Thanks art team!|none]]

= Local instances/templates =
You never really place a root in the game. You place a '''reference''' to the root in the game. 
Roots really exist on another plane outside of the game.

The game merely contains '''links''' to the root. When you drag a root into the game, it creates a local instance (also called local template) of the root at that spot. You could say local instances are '''children''' of their parent (the root).

[[File:Localsarmy.jpg|frame|Army Men game has 2 local instances in-game that refer to the root ArmyMan.|none]]

A local instance can live without data. It '''just refers''' to the root and it will get its data there. 
However, if the root is deleted, the link is broken and the local instance will no longer be able to show anything. (This is why you get errors if roots are deleted and they’re used by local instances.)

= Inheritance =
If you are an artist, think of a root template as a '''magical mold''' or a magical pattern: when you update the mold, everything you ever made with it updates too! 
If you are a programmer, think of a root template as a '''class'''.

Every time a root template is updated, all its '''local instances inherit the updates automatically'''.

{| class="wikitable"
|-
| '''“Green?! NO! All ArmyMan must be red!” The Root ArmyMan was updated with the colour RED. All its instances in the game everywhere inherit the colour automatically.''' 
'''(NOTE: This is just an example of a property. Colour works differently in our game.)'''
|-
|}

Whew. What a relief. I thought we would have to update all local instances everywhere in the entire game. Thank you root system!

[[File:Colorsarmy.jpg|frame|none]]
{| class="wikitable"
|-
|Examples: 
* If an artist finally gives the root an icon, all the local instances in the game inherit the root. This means that you can close 248 bugs about “vase has no icon” by updating 1 root, and it means that you just gave 3400 vases an icon with 1 click.
* If a designer finally creates an item combo for the root, you can perform the item combo with all local instances of that root. By updating 1 root, you can close 134 bugs about “cup plus barrel gives no mug of beer”, and it means that you just gave 4200 mugs the ability to become a mug of beer.
* If a writer finally finds the time to write a kickass description for this special bottle of wine, and she writes it on the root template, she can close the 124 tickets about the 879 bottles in the game not having a description. If we would not have roots and their magical inheritance, we would have to copy paste that description 879 times.
All hail roots.
|-
|}

= Consistency and player expectations =
By using roots, we also ensure consistent behaviour of the items in our world.
{| class="wikitable"
|-
|Examples: 
* Every barrel of oil explodes because every barrel of oil in our game gets that piece of information from its root template.
* You can drink every bottle of wine in the game, because its root refers to wine stats and has the consume action.
|-
|}

The '''player''' of our game has certain '''expectations'''.
Things '''do''' what they look like they do in real life:
* you can read a book,
* you can drink wine,
* you can eat bread,
* you can cook meat,
* you can climb stairs,
* you can open a cupboard,
* you can open a door,
* you can open that hatch,
* you can open a can of whoop ass,
* you can wear a helmet,
* you can put on shoes,
* you can use that weapon on the wall,
* that shield is not just decoration,
* you can wield that broom as a weapon,
* you can look in that mirror,
* you can cook something in the oven,
* you can lie in a bed,
* you can sit on a chair,
* you can climb a ladder,
* ...

* You can '''move''' everything that is not too heavy and not nailed down.
* You can '''pick up''' anything that looks like it can fit in a backpack. (Exceptions: barrels, crates, chests, baskets, a lot of weapons and armour.)
* You can '''interact''' with things that you expect to be interactive and see an animation (turn on a lamp, pull a lever) or hear a funny remark (click on a gravestone) or you can do an item combo with it (an anvil, an oven).

To live up to these expectations, we '''set up the roots correctly''', and as a result, all its instances inherit the settings and everything works as it should. If one item in the game behaves differently, it is experienced as a bug and it’s not the way this game was designed.

= What is wrong =
If you turn off or change this expected, standard behaviour on a local instance, that is wrong in 99% of the cases: it is no longer consistent with the other items of this type and confuses the player. It’s a bug, it’s an inconsistency.

What is even worse is to set up such behaviour on a local instance. Doing this is wrong in 99% of the cases: it then only works on that local and not on the rest of its brothers and sisters. This is not consistent and you are not using the power of the root system.

{| class="wikitable"
|-
|'''“Green?! NO! All ArmyMan must be red!” The WRONG way to do this is to go over every local instance and override their colours. This is wrong because:'''
* You forgot a couple in that other level. You introduced bugs.
* The other guy who is using ArmyMan did not get the memo and is not doing it to his locals. Bugs.
* All future instances of ArmyMan will still be green because its root is still green.
* The player will then start seeing green and red army men and will be confused. Bugs.
* Any updates on the colour of the root will not be inherited because the colour was overridden and some other poor sod will have to find out why fixing the root doesn’t update all instances in the game.
* All this could have been avoided by updating the root.
|-
|}
[[File:Wrongarmy.jpg|frame|none]]

{| class="wikitable"
|-
|[[File:Warningred.png|left|30px]]If you find yourself constantly overriding the same things on all the locals of one root, you are probably doing it wrong and you should just ''fix'' the root and not try to fix all instances one by one.
|-
|}

= Overrides on local instances =
A designer or an artist building the world '''can''' override properties of game objects. Because '''sometimes''', there are '''exceptions''' and then overriding a property is a powerful tool.

[[File:Ingamearmy.jpg|frame|none|“This very specific ArmyMan01 must always be green no matter what colour ArmyMan Root has. ArmyMan01 is really special.” In this case, we can override the colour property with green. The rest of the properties are still automatically inherited.]]

But one must always be careful, because overriding properties can be a cause of bugs too.

{| class="wikitable"
|-
|
Examples: 
When is it a good idea to override properties on a local? For instance, you want a certain painting to react differently to a click than usual, because it is part of a quest: you can talk to this particular painting! 
Or this hand placed weapon belonged to the duke and has a special name and needs unique stats. Or, this chest is locked with a key. This particular door is possessed and you have to talk to it instead of open it. 
This water well is not just a water well, if you do the right things to it, it becomes a wishing well! And so forth.
|-
|}

Sometimes, overrides on local instances are perfectly possible and encouraged. But as soon as you are changing systemics, think about what you’re doing. 
And as soon as you find yourself doing the same thing over and over again to the same locals, think about what you’re doing.

= Overrides mean: no more updates from root =
However, as a designer or artist, you must know that '''a property of a local that gets an override no longer inherits from its root'''. 
This is only logical, because it is an override. Even if the root is updated, the local instance’s property is still overridden.

[[File:Purplearmy.jpg|frame|none|“Red is out, we should make our ArmyMan purple in the entire game. For Prince!” We set the root’s colour property with purple. However, all instances that have an override on colour do not inherit this, and that may be fine if that’s what you wanted.]]

= Perfectly normal overrides =
There are cases in which it can be perfectly normal to use the override functionality. 
The following properties can be overridden '''in the following cases''':

* '''DisplayName:''' if you want to give this particular local a specific name.
** Pitfall: if you find yourself selecting and renaming an entire group of similar item locals or character locals, you probably want to:
*:: a) fix the root’s name
*:: b) create a new root
** ...because you are probably creating a certain new type that warrants a root
* '''Alignment:''' for specifying for instance more regional alignments to NPCs
* '''IsBoss:''' for specifying that this particular local is a boss character
* '''IsInspector:''' if you want to turn specific items or characters that are usually not inspectors into an inspector
** A trap item should have this on root level, or you will find yourself turning this on constantly for all trap locals
** Other than traps, this may be necessary on some locals in some circumstances
* '''ActivationGroupId:''' If you want to group locals to start together (this is never set on root because it is so local-specific)
* '''Amount:''' if you want to put an item in the world and make it a stack
** e.g. gold or arrows
** it also works on potato but the visual doesn’t change
* '''Description:''' if you want to give this particular local a specific description.
** Pitfall: example. You see a healing potion in the game. It has no description. You click on the local instance of the potion and you fill in the description. This is '''wrong'''. You are only making a description for that one particular healing potion. If you want all healing potions in the game to have that description, you must fix the root. If you fill in a description in the root, all healing potions in the game will have the description. Use this field only to override an existing root description for a particular and specific local.
** Pitfall: example. You see a painting in the game. It has no description. You click on seven local instances of the painting and you fill in the description. This is '''wrong'''. Someone somewhere else uses the same painting root. This will not have the description you filled in because you didn’t fill it in on the root. Someone else fills in a proper description on the root. Your seven instances will not inherit it because you made the error of filling in a description on the local instances.
* '''Icon:''' if you have a really specific icon for this particular local version (e.g. because it is a special NPC or a unique item)
* '''Treasure / Inventory:''' if you want to give this particular instance of the item or character a specific treasure table
** Pitfall: if you find yourself doing this to the local because the root has no treasure filled in, are you sure the root doesn’t need a default treasure?
* '''Trade Treasure :''' if you want to give this particular copy of the character a specific trade table
* '''Items:''' usually not set on a root, this enables you to put things in an item or in a character’s pockets
* '''LevelOverride:''' can be set to a specific level, zero to take level of stats, or -1 to take level trigger
* '''LockLevel:''' to change lockpicking requirements for this specific container
* '''Stats:''' to change to more specific stats (more common override for characters and weapons and armour, most other items only get an override for special cases like quest objects; remember that item combos might not work if you change stats)
* '''StoryItem:''' check this flag if this is a story item
* '''TreasureLevel:''' set to a specific level to force a level, zero to get from area, -1 to get from level trigger
* '''UsePartyLevelForTreasureLevel:''' check this box if you want the party level to determine the level of treasure this particular container generates
* '''OnUseActions:''' for story scripting purposes, this can trigger extra uses, but its default uses should be taken into account carefully; the designer should take into account that the default scripts on the root may often change or get fixed and that an override will then not be inherited as soon as this part is changed, so use with caution and don’t forget about player expectation
* '''Scale:''' don’t exaggerate with scaling. This means: don’t turn a ten foot statue into a six inch figurine. And don’t scale a needle up to a sword.
* '''Tags:''' sometimes, a local’s tags can change
* '''VisualSet:''' data can be changed
* '''Equipment:''' a local can wear different weapons than its root
* '''IsHardcoreOnly:''' a local can be added for HC only
* '''Skills:''' a local can have different skills than its root

= The parable of the 3 designers =
3 designers each made a farm. 
When inspecting, the lead designer says to all 3 of them: “I want to see a rooster here among the chickens.”

* Designer 1 clicks one local chicken, changes the name to “Rooster” and calls it a day.
* Designer 2 clicks a local chicken, changes the name to “Cock”, sets the treasure to Empty, sets the stats to FTJ_Magister_Soldier cause he thinks it should be stronger than a chicken, and requests an icon and a visual for a cock.
* Designer 3 opens his Roots panel, right-clicks the root ANIMAL_Chicken and selects “Create new from selected…” and gives it the name “ANIMAL_Rooster”. He gives the root a displayname, sets the treasure to Empty, and puts one instance of the root ANIMAL_Rooster near his chickens and requests an icon and a visual for a rooster.

There are now 3 different roosters in the game.

The third designer’s root gets filled in by art, sound designers made it cock-a-doodle, and someone makes a treasure for the rooster and specific stats. 
The combat designer changes the behaviour of the root of the rooster: it doesn’t flee but has powerful attacks with its claws and beak.

Everyone’s forgotten about the local overrides. Designer 1’s rooster is still laying eggs if you kill it and is now just a white chicken called “Rooster”.

Designer 2’s rooster never got the icon or the visual, cause the art department thinks they filled his request by completing the root. 
Designer 2’s “cock” is also being mistranslated by a lot of loca companies and it’s taken hours to figure out where the dirty word is coming from cause the root has the name “Rooster”.

The game is now illegal in Australia.

= Why changing locals is not “a quick hack” =
The argument is often made that to quickly fix something or hack something, or get something ready quick, you “do it to the local”.

This is wrong in a lot of cases.

First and foremost, creating a new root for your specific item is only 2 clicks away.

Second of all, if you are trying to fix a local while you should have fixed the root, 
you went through more trouble loading the level and finding the local, than fixing the root, which would have been the correct solution.

Third, by “hacking the local”, you are
* Creating unexpected behaviour
* Creating inconsistent behaviour
* Possibly removing expected behaviour
* Possibly no longer inheriting future updates and fixes to the root
* Not updating the other locals that may need the same treatment you are giving this local (you should be doing it in the root)
* Possibly creating a standalone version of something that is now untraceable (needs an icon but it’s hiding away between thousands of other tiny local items)
* Causing bugs that are hard to find and fix because “the root works”
* Causing skeletons that drop out of the closet at the end of the project and wasting time that could have been spent on polish instead of fixing “quick” hacks

= Real life examples of what people did wrong and why it was wrong =
=== The jar story ===
You get a ticket about the name of a jar being wrong. There is nothing special about the jar. It is not a quest item or puzzle item.

{| class="wikitable"
|-
| '''Correct''' || '''Wrong'''
|-
| You look for the root template of the jar and you fix the name of the root. || You go to the location of the jar in the ticket. You fix the name of the local.
|-
| '''Why correct?''' || '''Why wrong?'''
|-
|
You just fixed not just this one jar, but all 473 jars in one go. 
Future jars will also have the correct name
||
You fixed only 1 instance of the jar. There are 472 other jars.
You could fix all 472 other jars if you have a lot of time. But you don’t.
Even if you did fix all 472 jars, 23 of them are checked out by someone else and 34 are being added at this moment and 78 will be added between now and next year. How will you fix those?
When the name of the root gets fixed or updated, your jar name remains in the game and you have made a unique jar. 
It will not stack with other jars. It will stand out and the player will think it is special.
|}

{| class="wikitable"
|-
|
“I was told to unstub the name of these jars.” Yes. But not these particular jars, you are taking it too literally. 
You were told to unstub all jars of this type in the entire game. So you do it in the root.
|}

=== The book story ===
You have a library full of books. You think there are too many books there, and too many of them don’t have actual content.

{| class="wikitable"
|-
| '''Correct''' || '''Wrong'''
|-
|
You leave the books be and use a generic BookID 
(e.g. “You cannot read this.” or “Pages are ripped from this book so it doesn’t make a lot of sense anymore.”)
Also correct: you remove some books (careful not to touch story items) and use BookRows instead.
||
You delete their onUse action.
And you don’t want to waste the player’s time, so you turn off the flags “CanMove” and “CanPickup”. 
You think they’re only decoration.
|-
| '''Why correct?''' || '''Why wrong?'''
|-
| You are keeping the game consistent.
||
Killing player expectation: you should never make a moveable item non-moveable.
Killing player expectation: you should never make an interactable item non-interactable.
|}

=== The small statuette story ===
Your job is to decorate the museum. 
You think you’re short on decoration items so you decide to start using those big statues that are all over the game.

{| class="wikitable"
|-
| '''Correct''' || '''Wrong'''
|-
|
You select the root of a statue, right click it, you choose “Create new from selected…” and you make a new root. 
You give it the same name but append _Tiny
You set the Scaling of the new root to 5%.
Yet grab your new root and put it on a shelf.
You tell a lead you made a new root and that it needs checking (stats, flags, visual, AI bounds…).
||
You grab a statue and put it on a shelf, you resize it to 5% and check it in thinking “I’m done, I am so smart.”
|-
| '''Why correct?''' || '''Why wrong?'''
|-
|
All people responsible will now update your root. 
Doing so will result in all current and future instances of the little statue to be correct.
They will all get stats, moveable and pickupable flags, AI bounds, and a visual made for that small size.
||
The statue can not be moved or picked up. There is no specific root for this statue, so nobody will ever know. 
You could start overriding this local, but then you are creating a very specific statue. 
If someone else is doing the same thing in another spot in the game, you are both creating inconsistency. 
By doing it to a local, you are hiding the problem.
If the root of this statue would get a certain update (for instance, all these statues are now a waypoint shrine), 
your statue will inherit behaviour it was not intended to inherit.
|}

=== The story about you don’t want to break other people’s stuff ===
You notice that a book cannot be picked up. 
You are afraid to change the root because you think that other people may have used this book and you don’t want to break their stuff.

{| class="wikitable"
|-
| '''Correct''' || '''Wrong'''
|-
|
You '''fix''' the root because you must be able to pick up all books in this game.
You tell everyone about what root you fixed and tell them to check if their stuff still works.
If they complain, they are using the book incorrectly and should not hack their local back again to not be moveable.
||
You don’t do anything and make your own locals pickupable.
|-
| '''Why correct?''' || '''Why wrong?'''
|-
|
Player expectation, rules of the game.
||
Not following player expectation, not according to the rules of the game.
|}

Templates explanation

2017-08-01T12:57:56Z

LarSeb:

Templates explanation

2017-08-01T12:44:20Z

LarSeb:

File:Purplearmy.jpg

2017-08-01T12:26:33Z

LarSeb:

Templates explanation

2017-08-01T12:23:07Z

LarSeb:

Editing guidelines

2017-07-31T13:49:22Z

LarSeb:

== General ==
If you are not familiar with MediaWiki please take a look at the help pages or google to find more info. 
If you are unsure on how to explain something, you can always take a look at other documentation of game engines/editors for inspiration.

== HTML ==
You can use html codes to properly format your pages and text. Please restrict this only to the layout. 
Do not start adding custom colors/themes etc. Users can switch to different themes on the wiki themselves and the content should therefore not specify colors.

== Consistency ==
Try to keep the wiki as consistent as possible. Look at other pages first before editing/adding your own. We don't want 50 different styles of writing and layouts.

== Pages ==
When creating pages please keep the page name as simple and clear an possible, especially when creating pages directly from links. 
Avoid long and unnecessary complex page names.
<nowiki>BAD:
* [[Change skill, crafting and item requirements; and talent requirements]]
-> http://docs.larian.game/index.php/Change_skill,_crafting_and_item_requirements;_and_talent_requirements

GOOD:
* [[Stats requirements|Change skill, crafting and item requirements; and talent requirements]]
-> http://docs.larian.game/index.php/Stats_requirements</nowiki>

If you see pages with full sentences as names feel free to delete these and move the contents to a better suited page name.

== Handy links ==
==== MediaWiki editing ====
* https://www.mediawiki.org/wiki/Help:Editing
==== Other engines ====
* https://developer.valvesoftware.com/wiki/Category:Modding
* https://docs.unrealengine.com/latest/INT/Engine/Basics/Projects/Browser/index.html
* https://docs.unity3d.com/Manual/UsingTheInspector.html
==== Tools ====
* http://getgreenshot.org/

Technical documentation

2017-07-31T13:48:07Z

LarSeb:

== Systems ==
* [[Templates explanation|Root and local templates, how do they work?]]
* [[AI grid|AI grid: surfaces, walkables, ...]]
* [[Scripting|Scripting]]
* [[Osiris|Osiris: story scripting]]
* [[Modding internals]]

== Panels ==
* [[Root template panel]]
* [[World outliner]]
* [[Sidebar]]
* [[AI grid panel]]

== Editors ==
* [[Material editor]]
* [[Stats editor]]
* [[Story editor]]
* [[Script editor]]

== Misc ==
* [[Project browser]]
* [[Main toolbar]]
* [[Osiris API Tips]]

== Console ==
* [[Command list]]
* [[ReCon|ReCon: remote console]]

Root template panel

2017-07-31T13:44:48Z

LarSeb:

[[File:Roottemplatepanel-overview.png]]

== Description ==
The root template panel provides an overview of all the root templates in the loaded active mod and it's loaded dependencies. 
You can use this panel to create new root templates. You can also use existing ones and create local template instances of them in a level.

{| class="wikitable"
|-
|More info on how templates work can be found here: [[Templates explanation]]
|-
|}

== Toolbar ==
[[File:Roottemplatepanel-toolbar.png]]

#Save/load
#Create new
#Track selection
#Show/hide only current project entries
#Sidebar
#Text filter
#Type filter
#Help button

== Filters ==
[[File:Roottemplatepanel-filters.png]]

Entries can be dragged in to a filter folder to organize them and provide a better overview of the root templates. 
New filters can be created via the context menu.

== Entries ==
[[File:Roottemplatepanel-entries.png]]

This simply shows all the entries according to the active filters. 
Blue entries are the ones that reside in the current (active) mod.

Root template panel

2017-07-31T13:42:33Z

LarSeb: