Category:Osiris APIs - Revision history

Tinkerer at 13:57, 25 November 2017

2017-11-25T13:57:39Z

← Older revision		Revision as of 13:57, 25 November 2017
Line 2:		Line 2:
	Osiris core APIs come in three categories:		Osiris core APIs come in three categories:
	* Events are Osiris' way to inform you that something happened, often to a particular object		* Events are Osiris' way to inform you that something happened, often to a particular object
	* Queries allow you to request information about an object or the game state, ~~and occasionally~~ also change the game state and ~~returning~~ the result of the change (e.g. creating a new item)		* Queries allow you to request information about an object or the game state. Occasionally, they also change the game state and return the result of the change (e.g. creating a new item)
	* Calls instruct Osiris to change an object or the game state. Calls never directly return results in any way.		* Calls instruct Osiris to change an object or the game state. Calls never directly return results in any way.

Tinkerer: Mention story.div

2017-10-13T06:08:46Z

Mention story.div

← Older revision		Revision as of 06:08, 13 October 2017
Line 17:		Line 17:
	# In the Story editor, press ctrl-shift-f and enter the name of the API. You will get a list of all locations in our scripting where this call is used		# In the Story editor, press ctrl-shift-f and enter the name of the API. You will get a list of all locations in our scripting where this call is used
	# If you are still unsure and the API is not documented yet here, ask on the [http://larian.com/forums/ubbthreads.php?ubb=postlist&Board=77&page=1 Scripting Forum].		# If you are still unsure and the API is not documented yet here, ask on the [http://larian.com/forums/ubbthreads.php?ubb=postlist&Board=77&page=1 Scripting Forum].

			Once you have built the story for this mod, you can also find it in ".\Data\Mods\<mod name>\Story\RawFiles\story.div". You can open this file in any text editor, so you can search it while you have another mod open in the editor that may not depend on Divinity Origins

	[[Category:Osiris]]		[[Category:Osiris]]

Tinkerer: Tips for discovering available APIs and figuring out what they do

2017-10-13T06:04:35Z

Tips for discovering available APIs and figuring out what they do

← Older revision		Revision as of 06:04, 13 October 2017
Line 1:		Line 1:
	=== ~~Osiris APIs~~ ===		=== Overview ===
	Osiris core APIs come in three categories:		Osiris core APIs come in three categories:
	* Events are Osiris' way to inform you that something happened, often to a particular object		* Events are Osiris' way to inform you that something happened, often to a particular object
Line 6:		Line 6:

	Additionally, this page also links to a number of useful helper routines and databases from the Shared mod.		Additionally, this page also links to a number of useful helper routines and databases from the Shared mod.

			=== List of All APIs ===
			The Osiris API documentation is a work in progress, as there are hundreds of them. However, you can always have a look at the declarations of all Osiris APIs in the [[Story_editor\|Story editor]] to see what is available:
			# [[Story_editor#Story_editor#Building_the_story\|Generate definitions]]
			# Choose File -> Open Story Header. You can also find this file in ".\Data\Mods\<mod name>\Story\RawFiles\story_header.div"

			In many cases, the usage of an API is fairly straightforward. If you are unsure about it,
			# Create an [[Working_with_projects#Project_Type:_Adventure_or_Add-on.3F\|Adventure Add-on]] that targets story and that depends on DivinityOrigins
			# [[Story_editor#Story_editor#Building_the_story\|Build story]] for that mod
			# In the Story editor, press ctrl-shift-f and enter the name of the API. You will get a list of all locations in our scripting where this call is used
			# If you are still unsure and the API is not documented yet here, ask on the [http://larian.com/forums/ubbthreads.php?ubb=postlist&Board=77&page=1 Scripting Forum].

	[[Category:Osiris]]		[[Category:Osiris]]

Kevin: Protected "Category:Osiris APIs" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

2017-10-02T11:34:21Z

Protected "Category:Osiris APIs" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

← Older revision	Revision as of 11:34, 2 October 2017
(No difference)

Tinkerer: Added Osiris category

2017-09-16T21:30:38Z

Added Osiris category

← Older revision		Revision as of 21:30, 16 September 2017
Line 6:		Line 6:

	Additionally, this page also links to a number of useful helper routines and databases from the Shared mod.		Additionally, this page also links to a number of useful helper routines and databases from the Shared mod.

			[[Category:Osiris]]

Tinkerer at 10:56, 10 September 2017

2017-09-10T10:56:46Z

← Older revision		Revision as of 10:56, 10 September 2017
Line 4:		Line 4:
	* Queries allow you to request information about an object or the game state, and occasionally also change the game state and returning the result of the change (e.g. creating a new item)		* Queries allow you to request information about an object or the game state, and occasionally also change the game state and returning the result of the change (e.g. creating a new item)
	* Calls instruct Osiris to change an object or the game state. Calls never directly return results in any way.		* Calls instruct Osiris to change an object or the game state. Calls never directly return results in any way.

			Additionally, this page also links to a number of useful helper routines and databases from the Shared mod.

Tinkerer: Created page with "=== Osiris APIs === Osiris core APIs come in three categories: * Events are Osiris' way to inform you that something happened, often to a particular object * Queries allow you..."

2017-08-25T19:51:40Z

Created page with "=== Osiris APIs === Osiris core APIs come in three categories: * Events are Osiris' way to inform you that something happened, often to a particular object * Queries allow you..."

New page

=== Osiris APIs ===
Osiris core APIs come in three categories:
* Events are Osiris' way to inform you that something happened, often to a particular object
* Queries allow you to request information about an object or the game state, and occasionally also change the game state and returning the result of the change (e.g. creating a new item)
* Calls instruct Osiris to change an object or the game state. Calls never directly return results in any way.