Summertime Saga API - Revision history

Casiope: /* State specific */

2020-07-13T19:01:26Z

State specific

← Older revision		Revision as of 19:01, 13 July 2020
Line 74:		Line 74:
	: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).		: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).
	; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).		; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).
	; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|Outfit ~~manager\|display=outfit~~ manager}} to {{code\|True}} or {{code\|False}} for the current machine.		; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|Outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.
	; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.		; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.
	: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.		: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.

Casiope: /* State specific */

2020-07-13T18:57:15Z

State specific

← Older revision		Revision as of 18:57, 13 July 2020
Line 74:		Line 74:
	: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).		: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).
	; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).		; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).
	; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.		; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|Outfit manager\|display=outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.
	; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.		; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.
	: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.		: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.

Casiope: /* State specific */

2020-07-13T18:56:28Z

State specific

← Older revision		Revision as of 18:56, 13 July 2020
Line 74:		Line 74:
	: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).		: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).
	; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).		; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).
	; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the ~~[[#Outfit manager~~\|outfit manager]] to {{code\|True}} or {{code\|False}} for the current machine.		; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.
	; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.		; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.
	: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.		: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.

Casiope at 16:47, 11 July 2020

2020-07-11T16:47:37Z

← Older revision		Revision as of 16:47, 11 July 2020
Line 8:		Line 8:
	{{strong\|Finite State Machines}} control the flow of the game for a particular character. They are basically linked chains of events (which are called '''States'''). The progress is achieved via a '''Trigger'''.		{{strong\|Finite State Machines}} control the flow of the game for a particular character. They are basically linked chains of events (which are called '''States'''). The progress is achieved via a '''Trigger'''.

	[[File:Fsm1.png\|thumb\|600px\|left\|A basic example of a FSM]]~~<br~~ clear=left>		[[File:Fsm1.png\|thumb\|600px\|left\|A basic example of a FSM]]{{clear\|left}}

	=== Creating a FSM ===		=== Creating a FSM ===

Casiope at 12:47, 11 July 2020

2020-07-11T12:47:41Z

Show changes

Casiope at 15:43, 21 June 2020

2020-06-21T15:43:12Z

← Older revision		Revision as of 15:43, 21 June 2020
Line 1:		Line 1:
	{{~~Message~~ box warning\|		{{message box warning\|
	The API is depreciated: the definitions are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}		The API is depreciated: the definitions are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}

Casiope at 20:52, 27 May 2020

2020-05-27T20:52:15Z

← Older revision		Revision as of 20:52, 27 May 2020
Line 1:		Line 1:
	{{Message box warning\|		{{Message box warning\|
	~~This~~ API is depreciated: the definitions are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}		The API is depreciated: the definitions are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}

	The ''Summertime Saga'' development team provides an application programming interface for those who would like to create or modify the game content (modding). In this article you will find documentation on the technical specifications and programming language. Find all the information concerning the modding on [[Modding\|its own article]].		The ''Summertime Saga'' development team provides an application programming interface for those who would like to create or modify the game content (modding). In this article you will find documentation on the technical specifications and programming language. Find all the information concerning the modding on [[Modding\|its own article]].

Casiope: Corrected typos. Removed duplicated message box. Removed previewed functionnalities that won't be updated (key binding and furnishing).

2020-05-18T14:04:47Z

Corrected typos. Removed duplicated message box. Removed previewed functionnalities that won't be updated (key binding and furnishing).

← Older revision		Revision as of 14:04, 18 May 2020
Line 1:		Line 1:
	{{Message box warning\|		{{Message box warning\|
	This API is ~~deprecated. The API is both~~ incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED'''}}		This API is depreciated: the definitions are incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED.'''}}
	~~{{message box important\|~~
	* The API for Summertime Saga is currently under development and this page is subject to changes.
	* This page was last updated as of Summertime Saga version 0.18.0.}}
	The ''Summertime Saga'' development team provides an application programming interface for those who would like to create or modify the game content (modding). In this article you will find documentation on the technical specifications and programming language. Find all the information concerning the modding on [[Modding\|its own article]].		The ''Summertime Saga'' development team provides an application programming interface for those who would like to create or modify the game content (modding). In this article you will find documentation on the technical specifications and programming language. Find all the information concerning the modding on [[Modding\|its own article]].
	{{TOC right\|limit=3}}		{{TOC right\|limit=3}}
Line 402:		Line 400:

	The <code>dialogues.json</code> file is used for the dialogue lines written by the higher tier contributors of DarkCookie’s Patreon.		The <code>dialogues.json</code> file is used for the dialogue lines written by the higher tier contributors of DarkCookie’s Patreon.

	~~=== Key binding ===~~

	~~{{message box warning\|This code is not yet implemented.}}~~

	~~This file lists the default key bindings used by the minigames.~~

	~~=== Furnishings ===~~

	~~{{message box warning\|This code is not yet implemented.}}~~

	~~This file will be similar to <code>items.json</code>. At the moment, no furnishings have been implemented. They will be available for the [[beachhouse]] location with an upgrade system.~~

	== Game manager class ==		== Game manager class ==

Sam9 at 17:27, 17 May 2020

2020-05-17T17:27:01Z

← Older revision		Revision as of 17:27, 17 May 2020
Line 1:		Line 1:
			{{Message box warning\|
			This API is deprecated. The API is both incomplete and will not be updated for future versions. '''USAGE IS HIGHLY DISCOURAGED'''}}
	{{message box important\|		{{message box important\|
	* The API for Summertime Saga is currently under development and this page is subject to changes.		* The API for Summertime Saga is currently under development and this page is subject to changes.

Casiope at 19:28, 15 January 2020

2020-01-15T19:28:38Z

← Older revision		Revision as of 19:28, 15 January 2020
Line 1:		Line 1:
	{{~~Message~~ box important\|		{{message box important\|
	* The API for Summertime Saga is currently under development and this page is subject to changes.		* The API for Summertime Saga is currently under development and this page is subject to changes.
	* This page was last updated as of Summertime Saga version 0.18.0.}}		* This page was last updated as of Summertime Saga version 0.18.0.}}
Line 191:		Line 191:
	; property get() : Return the proper outfit given the current time of day, day of week, whether the machine is naked or not, and current location.		; property get() : Return the proper outfit given the current time of day, day of week, whether the machine is naked or not, and current location.

	{{~~Message~~ box important\|Below is a copy‐paste from Discord that will be rewritten later. It gets the point across though.}}		{{message box important\|Below is a copy‐paste from Discord that will be rewritten later. It gets the point across though.}}

	So basically how the new outfit system works; you have to setup the outfit manager. The same manager has one method called <code>bind_outfit_to_location</code> that takes 2 arguments: <code>location</code>, a location object, and <code>outfit</code>, which can be an outfit string or an outfit schedule, i.e. a matrix just like the locations. This method creates a map of outfits to use in certain conditions.		So basically how the new outfit system works; you have to setup the outfit manager. The same manager has one method called <code>bind_outfit_to_location</code> that takes 2 arguments: <code>location</code>, a location object, and <code>outfit</code>, which can be an outfit string or an outfit schedule, i.e. a matrix just like the locations. This method creates a map of outfits to use in certain conditions.
Line 403:		Line 403:
	=== Key binding ===		=== Key binding ===

	{{~~Message~~ box warning\|This code is not yet implemented.}}		{{message box warning\|This code is not yet implemented.}}

	This file lists the default key bindings used by the minigames.		This file lists the default key bindings used by the minigames.
Line 409:		Line 409:
	=== Furnishings ===		=== Furnishings ===

	{{~~Message~~ box warning\|This code is not yet implemented.}}		{{message box warning\|This code is not yet implemented.}}

	This file will be similar to <code>items.json</code>. At the moment, no furnishings have been implemented. They will be available for the [[beachhouse]] location with an upgrade system.		This file will be similar to <code>items.json</code>. At the moment, no furnishings have been implemented. They will be available for the [[beachhouse]] location with an upgrade system.

← Older revision		Revision as of 19:01, 13 July 2020
Line 74:		Line 74:
	: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).		: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).
	; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).		; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).
	; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|Outfit ~~manager\|display=outfit~~ manager}} to {{code\|True}} or {{code\|False}} for the current machine.		; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|Outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.
	; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.		; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.
	: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.		: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.

← Older revision		Revision as of 18:57, 13 July 2020
Line 74:		Line 74:
	: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).		: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).
	; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).		; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).
	; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.		; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|Outfit manager\|display=outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.
	; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.		; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.
	: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.		: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.

← Older revision		Revision as of 18:56, 13 July 2020
Line 74:		Line 74:
	: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).		: The argument is in the same format as the {{code\|default_loc}} argument in the machine constructor (1x4, 2x4 or 7x4 matrices).
	; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).		; ['setoutfit', [location, outfit]] : Set the outfit for that location. {{var\|outfit}} may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).
	; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the ~~[[#Outfit manager~~\|outfit manager]] to {{code\|True}} or {{code\|False}} for the current machine.		; ['setnaked', True/False] : Set {{code\|is_naked}} attribute of the {{section link\|\|outfit manager}} to {{code\|True}} or {{code\|False}} for the current machine.
	; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.		; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the default outfit for the current machine.
	: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.		: {{var\|tod}} and {{var\|dow}} can be omitted. {{var\|outfit}} is a required argument in the format of a string or a 1x4, 2x4, 7x4 matrix.