Script:Persist.js - Revision history

Apollolux: /* Download */ link to GDrive-hosted demo

2013-06-03T23:15:53Z

‎Download: link to GDrive-hosted demo

Apollolux: reorder

2013-06-03T23:05:18Z

reorder

Apollolux: /* How to… */ fill

2013-06-03T23:03:53Z

‎How to…: fill

Apollolux: /* Reference */ fill

2013-06-03T22:56:01Z

‎Reference: fill

Apollolux: /* Quick start */ fill

2013-06-03T22:47:06Z

‎Quick start: fill

Apollolux: /* Download */ fix link

2013-06-03T22:41:40Z

‎Download: fix link

Apollolux: created from http://web.archive.org/web/20100621061805/http://www.spheredev.org/wiki/Persist.js

2013-06-02T02:53:36Z

created from http://web.archive.org/web/20100621061805/http://www.spheredev.org/wiki/Persist.js

New page

[[Script:persist.js|persist.js]] lets you store variables in persons and maps, and use them in event scripts.

At its simplest, you can store simple quest information, e.g. if you've talked to an NPC, or collected an item. Power users can take full advantage of JavaScript, and write templates for common person patterns, e.g. one-line townsfolk, store keepers, inn keepers, save points, chests, items, door switches, bosses blocking passages, and warps.

It helps you to organise your game data. If you ever got sick of making global variables and confusing data structures to hold your game info, this is your answer.

__TOC__

==Download==
==Quick start==
==Reference==
==How to…==

[[Category:Scripts]]

@@ Line 9: / Line 9: @@
 ==Download==
 *	[https://gist.github.com/apollolux/5702052 persist.js] (17.9 KB JavaScript file, hosted as a GitHub Gist)
-*	<del>persist.js demo game</del> (15.6 KB ZIP archive, requires Sphere) <!-- TODO: get this back -->
+*	[https://docs.google.com/file/d/0B61J-Dngz0Q9NUdwVTdnYVNhV0k/edit?usp=sharing persist.js demo game] (15.6 KB ZIP archive, requires Sphere) <!-- TODO: get this back -->
 ==Quick start==

@@ Line 8: / Line 8: @@
 ==Download==
-*	[https://gist.github.com/apollolux/5702052 persist.js] (17.9 KB JavaScript file)
+*	[https://gist.github.com/apollolux/5702052 persist.js] (17.9 KB JavaScript file, hosted as a GitHub Gist)
 *	<del>persist.js demo game</del> (15.6 KB ZIP archive, requires Sphere) <!-- TODO: get this back -->
 ==Quick start==
@@ Line 284: / Line 281: @@
 ===Send feedback or report bugs===
 Visit [http://forums.spheredev.org/ the forums] for support!
 [[Category:Scripts]]

← Older revision		Revision as of 23:03, 3 June 2013
Line 129:		Line 129:

	==How to…==		==How to…==
		+	===Deal with maps in sub-folders===
		+	Regular maps have scripts located as follows:
		+
		+	maps/map1.rmp -> scripts/maps/map1.js
		+
		+	Maps in sub-folders just have to be in the same relative location:
		+
		+	maps/overworld.rmp -> scripts/maps/overworld.js
		+	maps/tower/level1.rmp -> scripts/maps/tower/level1.js
		+	maps/tower/level2.rmp -> scripts/maps/tower/level2.js
		+	maps/mine/b1.rmp -> scripts/maps/mine/b1.js
		+	maps/mine/b2.rmp -> scripts/maps/mine/b2.js
		+
		+	===Save and load the whole game state===
		+	You can use [[Script:json.js\|json.js]] to serialise the persist world state. You may want to adapt this to your game's needs.
		+	<syntaxhighlight>
		+	RequireScript("persist.js");
		+	RequireScript("json2.js");
		+
		+	// ...
		+
		+	function save(filename)
		+	{
		+	var f = OpenRawFile(filename, true);
		+	try {
		+	var objectString = JSON.stringify(persist.getWorldState());
		+	f.write(CreateByteArrayFromString(objectString));
		+	} finally {
		+	f.close();
		+	}
		+	}
		+
		+	function load(filename)
		+	{
		+	var f = OpenRawFile(filename);
		+	try {
		+	var objectString = CreateStringFromByteArray(f.read(f.getSize()));
		+	persist.setWorldState(JSON.parse(objectString));
		+	} finally {
		+	f.close();
		+	}
		+	}
		+	</syntaxhighlight>
		+
		+	===Use map/person states and functions outside of event scripts===
		+	If you want to, say, use a local map script in a trigger, in your map script:
		+	<syntaxhighlight>
		+	/** scripts/maps/example.js */
		+
		+	({
		+	myCustomFunction: function (a, b, c) {
		+	// your code here
		+	}
		+	})
		+	</syntaxhighlight>
		+
		+	Then in your trigger:
		+	<syntaxhighlight>
		+	persist.map().myCustomFunction(1, 2, 3);
		+	</syntaxhighlight>
		+
		+	===Write one-time "factory" person functions===
		+	If you notice a pattern in your person scripts for a single map, you might want to put the common bits in a single function.
		+
		+	In your map script:
		+	<syntaxhighlight>
		+	/** scripts/maps/example.js */
		+
		+	function sequenceTalker()
		+	{
		+	var lines = arguments;
		+
		+	return {
		+	which_line: 0,
		+
		+	talk: function (self) {
		+	Say(lines[which_line]);
		+	if (which_line < lines.length)
		+	which_line += 1;
		+	}
		+	};
		+	}
		+
		+	({
		+	tom: sequenceTalker("Hi."),
		+	dick: sequenceTalker("Hello.", "My name is Dick."),
		+	harry: sequenceTalker("Hey.", "I'm Harry.", "You forgot my name already?")
		+	})
		+	</syntaxhighlight>
		+
		+	This example shows the creation of script events for 3 persons. Each one speaks their lines in order when spoken to.
		+
		+	The key is to have the function return a JavaScript object. That person factory function won't be dumped into the global namespace, so feel free to give it a simple name.
		+
		+	===Write common "factory" person functions===
		+	If you have a sort of person that keeps showing up, e.g. treasure chests, you may want to write a function that can handle making all of those.
		+
		+	In your main script:
		+	<syntaxhighlight>
		+	/** scripts/main.js */
		+
		+	function game()
		+	{
		+	// ...
		+	}
		+
		+	function makeChest(item)
		+	{
		+	return {
		+	opened: false,
		+
		+	create: function (self) {
		+	if (self.opened) {
		+	SetPersonDirection(GetCurrentPerson(), "open");
		+	} else {
		+	SetPersonDirection(GetCurrentPerson(), "closed");
		+	}
		+	},
		+
		+	talk: function (self) {
		+	if (!self.opened) {
		+	GiveItem(item);
		+	Say("Received " + item + ".");
		+	self.opened = true;
		+	SetPersonDirection(GetCurrentPerson(), "open");
		+	} else {
		+	Say("This chest is empty.");
		+	}
		+	}
		+	};
		+	}
		+	</syntaxhighlight>
		+
		+	And in your map scripts:
		+	<syntaxhighlight>
		+	/** scripts/maps/map1.js */
		+
		+	({
		+	chest_1: makeChest("sword"),
		+	chest_2: makeChest("shield"),
		+	chest_3: makeChest("potion"),
		+	})
		+	</syntaxhighlight>
		+
		+	<syntaxhighlight>
		+	/** scripts/maps/map2.js */
		+
		+	({
		+	chest_1: makeChest("knife");
		+	chest_2: makeChest("fork");
		+	})
		+	</syntaxhighlight>
		+
		+	===Send feedback or report bugs===
		+	Visit [http://forums.spheredev.org/ the forums] for support!

	[[Category:Scripts]]		[[Category:Scripts]]

@@ Line 54: / Line 54: @@
 ==Reference==
 ==How to&hellip;==
 [[Category:Scripts]]