Osiris Tips and Examples - Revision history

LaughingLeader: /* Databases Queries for Conditions */

2018-04-17T19:30:21Z

Databases Queries for Conditions

← Older revision		Revision as of 19:30, 17 April 2018
Line 86:		Line 86:
	DB_Santa_NaughtyList(_Target)		DB_Santa_NaughtyList(_Target)
	THEN		THEN
	DisplayText(_Santa, "Ho ho ho! You're been a bad ~~guy~~ this year! Coal for you!");		DisplayText(_Santa, "Ho ho ho! You're been bad this year! Coal for you!");
	ItemTemplateAddTo("QUEST_Coal_df215b50-e18f-4527-a2ac-e7eec6cba576", _Target, 1);		ItemTemplateAddTo("QUEST_Coal_df215b50-e18f-4527-a2ac-e7eec6cba576", _Target, 1);

LaughingLeader: Added a short example for database events.

2018-03-10T06:44:35Z

Added a short example for database events.

@@ Line 36: / Line 36: @@
 ;THEN
 :In the call section, new entries are added to databases, or existing entries are removed (i.e. NOT DB_MyDatabase(_VariableA, _VariableB).
 === Database Queries ===

LaughingLeader: /* Databases Queries for Data Retrieval */

2018-01-27T18:35:55Z

Databases Queries for Data Retrieval

← Older revision		Revision as of 18:35, 27 January 2018
Line 72:		Line 72:
	PlayEffect(_Target, "RS3_FX_Santa_HolidayExplosion_01");		PlayEffect(_Target, "RS3_FX_Santa_HolidayExplosion_01");
	</pre>		</pre>
	Since _Target ~~was never set before~~ the database query, it acts as an out variable, calling subsequent lines on each entry added to DB_Santa_NiceList.		Since the value of _Target is not specified in the database query, it acts as an out variable, calling subsequent lines on each entry added to DB_Santa_NiceList.

	=== Database Gotchas ===		=== Database Gotchas ===

LaughingLeader: /* Databases Queries for Data Retrieval */

2018-01-27T18:34:58Z

Databases Queries for Data Retrieval

← Older revision		Revision as of 18:34, 27 January 2018
Line 72:		Line 72:
	PlayEffect(_Target, "RS3_FX_Santa_HolidayExplosion_01");		PlayEffect(_Target, "RS3_FX_Santa_HolidayExplosion_01");
	</pre>		</pre>
	Since _Target was never set ~~beforehand~~, it acts as an out variable, calling subsequent lines on each entry added to DB_Santa_NiceList.		Since _Target was never set before the database query, it acts as an out variable, calling subsequent lines on each entry added to DB_Santa_NiceList.

	=== Database Gotchas ===		=== Database Gotchas ===

LaughingLeader: Did some testing on databases with more than 6 arity, and they seem to compile and work correctly.

2018-01-26T16:25:14Z

Did some testing on databases with more than 6 arity, and they seem to compile and work correctly.

← Older revision		Revision as of 16:25, 26 January 2018
Line 78:		Line 78:
	While databases are a powerful way to create complex scripting logic, there are a few crucial concepts to keep in mind:		While databases are a powerful way to create complex scripting logic, there are a few crucial concepts to keep in mind:
	* Unless you take steps to clear it out, database data persists in existing saves, even if you no longer support a particular database in a later version of your mod.		* Unless you take steps to clear it out, database data persists in existing saves, even if you no longer support a particular database in a later version of your mod.
	* ~~Osiris may have issues~~ with databases ~~containing more than 6 columns~~.		* Consider keeping the number of database columns at a manageable size. Databases can be cross-referenced with other databases if needed.
	* Inherited types from GUIDSTRING (CHARACTERGUID, ITEMGUID, TRIGGERGUID) need to be declared once in a database, to properly set the type.		* Inherited types from GUIDSTRING (CHARACTERGUID, ITEMGUID, TRIGGERGUID) need to be declared once in a database, to properly set the type.

LaughingLeader at 11:25, 21 December 2017

2017-12-21T11:25:01Z

← Older revision		Revision as of 11:25, 21 December 2017
Line 242:		Line 242:
	* [[Your First Story Script]]		* [[Your First Story Script]]
	* [[:Category:Osiris_APIs\|Osiris APIs]]		* [[:Category:Osiris_APIs\|Osiris APIs]]
	* [[Category:Osiris_Calls\|Osiris Calls]]		* [[:Category:Osiris_Calls\|Osiris Calls]]

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

LaughingLeader at 11:24, 21 December 2017

2017-12-21T11:24:42Z

← Older revision		Revision as of 11:24, 21 December 2017
Line 242:		Line 242:
	* [[Your First Story Script]]		* [[Your First Story Script]]
	* [[:Category:Osiris_APIs\|Osiris APIs]]		* [[:Category:Osiris_APIs\|Osiris APIs]]
			* [[Category:Osiris_Calls\|Osiris Calls]]

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

LaughingLeader at 11:17, 21 December 2017

2017-12-21T11:17:44Z

← Older revision		Revision as of 11:17, 21 December 2017
Line 240:		Line 240:
	* [[Osiris Design Patterns]]		* [[Osiris Design Patterns]]
	* [[Osiris Gotchas]]		* [[Osiris Gotchas]]
			* [[Your First Story Script]]
	* [[:Category:Osiris_APIs\|Osiris APIs]]		* [[:Category:Osiris_APIs\|Osiris APIs]]

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

LaughingLeader: LaughingLeader moved page Osiris Tips to Osiris Tips and Examples: Pairing Osiris tips with practical examples is really the main purpose of this page.

2017-12-21T11:14:44Z

LaughingLeader moved page Osiris Tips to Osiris Tips and Examples: Pairing Osiris tips with practical examples is really the main purpose of this page.

← Older revision	Revision as of 11:14, 21 December 2017
(No difference)

LaughingLeader at 11:09, 21 December 2017

2017-12-21T11:09:15Z

← Older revision		Revision as of 11:09, 21 December 2017
Line 1:		Line 1:
			The following is a collection of practical examples and tips that will aid in your journey to learn how to power your mod through story script usage.

	== Rule Flow ==		== Rule Flow ==
	Story scripts run on "rules". Every frame, Osiris will evaluate the rules for every running story goal.		Story scripts run on "rules". Every frame, Osiris will evaluate the rules for every running story goal.
Line 232:		Line 234:
	----		----
	Beyond changing databases, updating your mod can be a more extensive ordeal, as there's a variety of factors to keep in mind. More on that here: [[Modding:_Versioning\|Modding: Versioning]].		Beyond changing databases, updating your mod can be a more extensive ordeal, as there's a variety of factors to keep in mind. More on that here: [[Modding:_Versioning\|Modding: Versioning]].

			== Further Information ==
			More in-depth information on Osiris can be read on the following pages:
			* [[Osiris Overview]]
			* [[Osiris Design Patterns]]
			* [[Osiris Gotchas]]
			* [[:Category:Osiris_APIs\|Osiris APIs]]

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