Osiris/API/GameStarted - Revision history

Tinkerer: Clarify that RegionStarted fires before GameStarted

2018-03-04T16:29:13Z

Clarify that RegionStarted fires before GameStarted

← Older revision		Revision as of 16:29, 4 March 2018
Line 9:		Line 9:
	* The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.		* The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.
	* An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)		* An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)
	* See [[Osiris/API/RegionStarted\|RegionStarted]] for an event that is thrown when the level is ready on the server side.		* See [[Osiris/API/RegionStarted\|RegionStarted]] for an event that is thrown when the level is ready on the server side (this happens before it is ready on the client side).
	* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal tied to this region instead).		* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal tied to this region instead).
	===== See Also =====		===== See Also =====

Tinkerer at 14:39, 14 January 2018

2018-01-14T14:39:22Z

← Older revision		Revision as of 14:39, 14 January 2018
Line 12:		Line 12:
	* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal tied to this region instead).		* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal tied to this region instead).
	===== See Also =====		===== See Also =====
			* [[Osiris/API/GameEventSet\|GameEventSet]]
			* [[Osiris/API/GameModeStarted\|GameModeStarted]]
	* [[Osiris/API/RegionStarted\|RegionStarted]]		* [[Osiris/API/RegionStarted\|RegionStarted]]

	[[Category:Osiris Events\|GameStarted]]		[[Category:Osiris Events\|GameStarted]]

Tinkerer at 14:13, 19 December 2017

2017-12-19T14:13:37Z

← Older revision		Revision as of 14:13, 19 December 2017
Line 14:		Line 14:
	* [[Osiris/API/RegionStarted\|RegionStarted]]		* [[Osiris/API/RegionStarted\|RegionStarted]]

	[[Category:Osiris Events]]		[[Category:Osiris Events\|GameStarted]]

Tinkerer at 20:39, 25 August 2017

2017-08-25T20:39:36Z

← Older revision		Revision as of 20:39, 25 August 2017
Line 9:		Line 9:
	* The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.		* The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.
	* An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)		* An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)
	* See [[Osiris/API/RegionStarted]] for an event that is thrown when the level is ready on the server side.		* See [[Osiris/API/RegionStarted\|RegionStarted]] for an event that is thrown when the level is ready on the server side.
	* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).		* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal tied to this region instead).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/RegionStarted\|RegionStarted]]		* [[Osiris/API/RegionStarted\|RegionStarted]]

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

Tinkerer at 20:39, 25 August 2017

2017-08-25T20:39:11Z

← Older revision		Revision as of 20:39, 25 August 2017
Line 12:		Line 12:
	* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).		* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/RegionStarted]]		* [[Osiris/API/RegionStarted\|RegionStarted]]

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

Tinkerer: Osiris Core APIs

2017-08-08T13:52:36Z

Osiris Core APIs

New page

===== Full Definition(s) =====
* event '''GameStarted'''(''(String)'''''_LevelName''', ''(INTEGER)'''''_IsEditorMode''')
===== Description =====
Thrown when a level has been loaded and is ready at both the server and client side.
===== Parameters =====
* '''_LevelName''': The identifier name of the level that has been loaded
* '''_IsEditorMode''': Indicates whether the game is run in the editor or not
===== Notes =====
* The logic of Osiris is split into a server and a client side, even in single player mode. Some important things that run on the client side are visual effects and physics.
* An example of something that is done only when the client side is ready, is playing the effect of the source collars on the characters in the tutorial and Fort Joy levels (since they're visual effects, and hence do not work if started when only the server side is ready)
* See [[Osiris/API/RegionStarted]] for an event that is thrown when the level is ready on the server side.
* This event is also thrown when loading a savegame, so add additional logic for code that should be executed only the first time when this level is started (or trigger it from the INIT section of a story goal instead).
===== See Also =====
* [[Osiris/API/RegionStarted]]

[[Category:Osiris Events]]