VoidExpanse/scope-topic - Revision history

Damonwall at 09:08, 10 April 2014

2014-04-10T09:08:47Z

← Older revision		Revision as of 09:08, 10 April 2014
Line 167:		Line 167:
	Removes all markers of quest.		Removes all markers of quest.
	}}		}}

			{{Scripting_api\|QuestRemoveLocalMarkers\|
			* string: quest_id\|
			void\|
			<pre style="margin:0px;">topic.QuestRemoveLocalMarkers("some_quest");</pre> \|
			Removes all local markers of a quest (object, coordinate). All Galaxy markers persist.
			}}


	{{Scripting_api\|QuestStart\|		{{Scripting_api\|QuestStart\|

Damonwall: /* List of functions */

2014-02-18T07:16:37Z

List of functions

@@ Line 38: / Line 38: @@
 <pre style="margin:0px;">topic.AddTopic("topic_id_01");</pre> |
 Adds specified topic to player's available topics.
 }}

Damonwall at 06:40, 14 February 2014

2014-02-14T06:40:40Z

← Older revision		Revision as of 06:40, 14 February 2014
Line 106:		Line 106:
	<pre style="margin:0px;">var bInputExists = topic.InputExists();</pre> \|		<pre style="margin:0px;">var bInputExists = topic.InputExists();</pre> \|
	}}		}}

	~~{{Scripting_api\|QuestAddLog\|~~
	* string: quest_id
	* string: entry_id
	* string: quest_text\|
	~~void\|~~
	~~<pre style="margin:0px;">topic.QuestAddLog("some_quest", "e001", "I just got this quest into quest log.");</pre> \|~~
	}}


	{{Scripting_api\|QuestAddLog\|		{{Scripting_api\|QuestAddLog\|
Line 120:		Line 111:
	* string: entry_id		* string: entry_id
	* string: quest_text		* string: quest_text
	* object: args\|		* ''(optional) object: args''\|
	void\|		void\|
	<pre style="margin:0px;">topic.QuestAddLog("some_quest", "e001", "I just got this %whaat% into quest log.", {whaat: "hamburger"});</pre> \|		<pre style="margin:0px;">topic.QuestAddLog("some_quest", "e001", "I just got this quest into quest log.");
			topic.QuestAddLog("some_quest", "e001", "I just got this %whaat% into quest log.",
			{whaat: "hamburger"});</pre> \|
	}}		}}

Damonwall at 06:39, 14 February 2014

2014-02-14T06:39:35Z

← Older revision		Revision as of 06:39, 14 February 2014
Line 9:		Line 9:

	== List of functions ==		== List of functions ==

	~~{{Scripting_api\|AddChoice\|~~
	* int: choice_id
	* string: choice_localisation_id
	* string: choice_text\|
	~~void\|~~
	~~<pre style="margin:0px;">topic.AddChoice(1, "c001", "I'd like to pass this one, please.");</pre> \|~~
	~~Adds a choice to dialog.~~
	}}

	{{Scripting_api\|AddChoice\|		{{Scripting_api\|AddChoice\|
Line 23:		Line 14:
	* string: choice_localisation_id		* string: choice_localisation_id
	* string: choice_text		* string: choice_text
	* object: parameters \|		* ''(optional) object: parameters''\|
	void\|		void\|
	<pre style="margin:0px;">topic.AddChoice(1, "c001", "I'd like to pass this %one%, please.", {one: "hamburger"});</pre> \|		<pre style="margin:0px;">topic.AddChoice(1, "c001", "I'd like to pass this one, please.");
			topic.AddChoice(1, "c001", "I'd like to pass this %one%, please.", {one: "hamburger"});</pre> \|
	Adds a choice to dialog.		Adds a choice to dialog.
	}}

	~~{{Scripting_api\|AddPhrase\|~~
	* string: phrase_localisation_id
	* string: phrase_text\|
	~~void\|~~
	~~<pre style="margin:0px;">topic.AddPhrase("p001", "Hello, i'm npc!");</pre> \|~~
	~~Adds an npc phrase to dialog.~~
	}}		}}

Line 40:		Line 24:
	* string: phrase_localisation_id		* string: phrase_localisation_id
	* string: phrase_text		* string: phrase_text
	* object: arguments \|		* object: arguments\|
	void\|		void\|
	<pre style="margin:0px;">topic.AddPhrase("p001", "Hello, i'm %npc_name%!", {npc_name: "Scott"});</pre> \|		<pre style="margin:0px;">topic.AddPhrase("p001", "Hello, i'm npc!");
			topic.AddPhrase("p001", "Hello, i'm %npc_name%!",
			{npc_name: "Scott"});</pre> \|
	Adds an npc phrase to dialog.		Adds an npc phrase to dialog.
	}}		}}

Damonwall: Created page with " Category:VoidExpanse/api_scopes = Scope topic = Topic scope is used only inside topic scripts. Controls dialogs and quests. '''Visibility:''' In..."

2014-02-14T06:20:01Z

Created page with "<noinclude> Category:VoidExpanse/api_scopes </noinclude> = Scope topic = Topic scope is used only inside topic scripts. Controls dialogs and quests. '''Visibility:''' In..."

New page

<noinclude>
[[Category:VoidExpanse/api_scopes]]
</noinclude>

= Scope topic =
Topic scope is used only inside topic scripts. Controls dialogs and quests.

'''Visibility:''' In topics only.

== List of functions ==

{{Scripting_api|AddChoice|
* int: choice_id
* string: choice_localisation_id
* string: choice_text|
void|
<pre style="margin:0px;">topic.AddChoice(1, "c001", "I'd like to pass this one, please.");</pre> |
Adds a choice to dialog.
}}

{{Scripting_api|AddChoice|
* int: choice_id
* string: choice_localisation_id
* string: choice_text
* object: parameters |
void|
<pre style="margin:0px;">topic.AddChoice(1, "c001", "I'd like to pass this %one%, please.", {one: "hamburger"});</pre> |
Adds a choice to dialog.
}}

{{Scripting_api|AddPhrase|
* string: phrase_localisation_id
* string: phrase_text|
void|
<pre style="margin:0px;">topic.AddPhrase("p001", "Hello, i'm npc!");</pre> |
Adds an npc phrase to dialog.
}}

{{Scripting_api|AddPhrase|
* string: phrase_localisation_id
* string: phrase_text
* object: arguments |
void|
<pre style="margin:0px;">topic.AddPhrase("p001", "Hello, i'm %npc_name%!", {npc_name: "Scott"});</pre> |
Adds an npc phrase to dialog.
}}

{{Scripting_api|AddTopic|
* string: topic_id|
void|
<pre style="margin:0px;">topic.AddTopic("topic_id_01");</pre> |
Adds specified topic to player's available topics.
}}

{{Scripting_api|HasTopic|
* string: topic_id|
bool: returns whether player already has this topic or not|
<pre style="margin:0px;">var bHasTopic = topic.HasTopic("topic_id_01");</pre> |
}}

{{Scripting_api|HasQuest|
* string: quest_id|
bool: returns whether player already has this quest or not|
<pre style="margin:0px;">var bHasQuest = topic.HasQuest("quest_id_01");</pre> |
}}

{{Scripting_api|Bind|
* string: trigger_name
* string: function_name
* object: parametes |
void|
<pre style="margin:0px;">topic.Bind("someTrigger", "OnSomeTrigger", { npc_id: "errors" });</pre> |
Binds function to a trigger.
}}

{{Scripting_api|DialogueBreak|
void|
void|
<pre style="margin:0px;">topic.DialogueBreak();</pre> |
Immediately breaks current dialogue.
}}

{{Scripting_api|GetCurrentNpcId|
void|
string: current npc id (name)|
<pre style="margin:0px;">var npc_id = topic.GetCurrentNpcId();</pre> |
}}

{{Scripting_api|GetCurrentNpcShipId|
void|
int: current npc's ship id|
<pre style="margin:0px;">var npc_ship_id = topic.GetCurrentNpcShipId();</pre> |
}}

{{Scripting_api|GetCurrentShipId|
void|
int: current player ship's ID|
<pre style="margin:0px;">var player_ship_id = topic.GetCurrentShipId();</pre> |
Has a global alias - PLAYER_SHIP. It's better to use alias - faster.
}}

{{Scripting_api|GetInput|
void|
int: player's choice id|
<pre style="margin:0px;">var input = topic.GetInput();</pre> |
}}

{{Scripting_api|GetState|
void|
int: topic state|
<pre style="margin:0px;">var state = topic.GetState();</pre> |
Returns current topic state - integer value. Usually state means current progress in questline, but it can be used any way possible.
}}

{{Scripting_api|InputExists|
void|
bool: returns whether player choose something or not|
<pre style="margin:0px;">var bInputExists = topic.InputExists();</pre> |
}}

{{Scripting_api|QuestAddLog|
* string: quest_id
* string: entry_id
* string: quest_text|
void|
<pre style="margin:0px;">topic.QuestAddLog("some_quest", "e001", "I just got this quest into quest log.");</pre> |
}}

{{Scripting_api|QuestAddLog|
* string: quest_id
* string: entry_id
* string: quest_text
* object: args|
void|
<pre style="margin:0px;">topic.QuestAddLog("some_quest", "e001", "I just got this %whaat% into quest log.", {whaat: "hamburger"});</pre> |
}}

{{Scripting_api|QuestAddMark|
* string: quest_id
* int: system_id|
void|
<pre style="margin:0px;">topic.QuestAddMark("some_quest", 1);</pre> |
Adds questmark, that'll be visible on a galaxy map.
}}

{{Scripting_api|QuestClearLog|
* string: quest_id|
void|
<pre style="margin:0px;">topic.QuestClearLog("some_quest");</pre> |
Clears log of specified quest.
}}

{{Scripting_api|QuestSetState|
* string: quest_id
* int: state|
void|
<pre style="margin:0px;">topic.QuestSetState("some_quest", QuestStatus.Finished);</pre> |
Sets state of quest. State can be QuestStatus.Active (0), QuestStatus.Finished (1), QuestStatus.Failed (2). All this constants are defined in any topic. You can use either them, or just numbers - 0,1,2. Status affects in which tab quest displays.
}}

{{Scripting_api|QuestRemove|
* string: quest_id|
void|
<pre style="margin:0px;">topic.QuestRemove("some_quest");</pre> |
Removes quest completely - after that it won't appear in any tab.
}}

{{Scripting_api|QuestRemoveMarkers|
* string: quest_id|
void|
<pre style="margin:0px;">topic.QuestRemoveMarkers("some_quest");</pre> |
Removes all markers of quest.
}}

{{Scripting_api|QuestStart|
* string: quest_id
* string: quest_title |
void|
<pre style="margin:0px;">topic.QuestStart("some_quest", "Rats in the cellar");</pre> |
Stars quest. After that it will appear in journal, and log messages and markers can be added to it.
}}

{{Scripting_api|RemoveTopic|
* string: topic_id|
void|
<pre style="margin:0px;">topic.RemoveTopic("topic_id");</pre> |
Removes topic completely.
}}

{{Scripting_api|SetState|
* int: state_value|
void|
<pre style="margin:0px;">topic.SetState(200);</pre> |
Changes state of current topic.
}}

{{Scripting_api|Unbind|
* string: trigger_name
* string: function_name|
void|
<pre style="margin:0px;">topic.Unbind("someTrigger", "OnSomeTrigger");</pre> |
Unbinds function from a trigger.
}}