StendhalScripting/Lua - Revision history

imported>AntumDeluge: add categories

2022-01-18T21:56:54Z

add categories

← Older revision	Revision as of 21:56, 18 January 2022
(No difference)

imported>AntumDeluge: add categories

2022-01-18T21:56:54Z

add categories

← Older revision		Revision as of 21:56, 18 January 2022
Line 532:		Line 532:

	* [[StendhalScripting/LuaAPI\|Lua API]]		* [[StendhalScripting/LuaAPI\|Lua API]]


			[[Category:Stendhal]]
			[[Category:Documentation]]
			[[Category:API]]
			[[Category:Scripting]]
			[[Category:Lua]]

imported>AntumDeluge: /* NPCs */

2020-04-13T20:33:40Z

NPCs

← Older revision	Revision as of 20:33, 13 April 2020
(No difference)

imported>AntumDeluge: /* NPCs */

2020-04-13T20:33:40Z

NPCs

← Older revision		Revision as of 20:33, 13 April 2020
Line 337:		Line 337:
	}		}

	-- Use helper object to create NPC path
	npc:setPath(nodes)		npc:setPath(nodes)

imported>AntumDeluge: /* NPCs */ Update example to use "npc:setPath" instead of "entities:setPath"

2020-04-13T20:32:28Z

NPCs: Update example to use "npc:setPath" instead of "entities:setPath"

← Older revision	Revision as of 20:32, 13 April 2020
(No difference)

imported>AntumDeluge: /* NPCs */ Update example to use "npc:setPath" instead of "entities:setPath"

2020-04-13T20:32:28Z

NPCs: Update example to use "npc:setPath" instead of "entities:setPath"

← Older revision		Revision as of 20:32, 13 April 2020
Line 338:		Line 338:

	-- Use helper object to create NPC path		-- Use helper object to create NPC path
	~~entities~~:setPath(~~npc,~~ nodes)		npc:setPath(nodes)

	-- Dialogue		-- Dialogue

imported>AntumDeluge: /* Adding Transitions */ "newAction", "newCondition", & "newNotCondition" replaced by member methods of "actions" & "conditions" objects

2020-04-13T05:45:40Z

Adding Transitions: "newAction", "newCondition", & "newNotCondition" replaced by member methods of "actions" & "conditions" objects

← Older revision	Revision as of 05:45, 13 April 2020
(No difference)

imported>AntumDeluge: /* Adding Transitions */ "newAction", "newCondition", & "newNotCondition" replaced by member methods of "actions" & "conditions" objects

2020-04-13T05:45:40Z

Adding Transitions: "newAction", "newCondition", & "newNotCondition" replaced by member methods of "actions" & "conditions" objects

← Older revision		Revision as of 05:45, 13 April 2020
Line 366:		Line 366:
	This simply adds a response to saying "hello" & sets the NPC to attend to the player (equivalent of <code>frank:addGreeting("Hello")</code>).		This simply adds a response to saying "hello" & sets the NPC to attend to the player (equivalent of <code>frank:addGreeting("Hello")</code>).

	For more complicated behavior, we need to use some helper methods. If we want to check a condition we use the <code>~~newCondition~~</code> ~~global~~ ~~function:~~		For more complicated behavior, we need to use some helper methods. If we want to check a condition we use the <code>conditions:create</code> method. The first parameter is the string name of the ChatCondition we want to instantiate. The second parameter is a table that contains the values that should be passed to the ChatCondition constructor.

			Example:
	<pre>		<pre>
	frank:add(ConversationStates.IDLE,		frank:add(ConversationStates.IDLE,
	ConversationPhrases.GREETING_MESSAGES,		ConversationPhrases.GREETING_MESSAGES,
	~~newCondition~~("PlayerHasItemWithHimCondition", "money"),		conditions:create("PlayerHasItemWithHimCondition", {"money"}),
	ConversationStates.ATTENDING,		ConversationStates.ATTENDING,
	"Hello.",		"Hello.",
Line 378:		Line 380:
	In this scenario, the NPC will only respond if the player is carrying <item>money</item>.		In this scenario, the NPC will only respond if the player is carrying <item>money</item>.

	A NotCondition instance can be created with the <code>~~newNotCondition</code> global function or using the <code>conditions.not~~</code> method:		A NotCondition instance can be created with the <code>actions:notCondition</code> method:

	Example usage:		Example usage:
	<pre>		<pre>
		⚫	local condition = conditions.notCondition(conditions:create("PlayerHasItemWithHimCondition", {"money"})
	-- using newNotCondition
	local condition = newNotCondition("PlayerHasItemWithHimCondition", "money")

	-- using conditions.not
⚫	local condition = conditions.~~not~~(~~newCondition~~("PlayerHasItemWithHimCondition", "money")
	</pre>		</pre>

	To add a ChatAction, we use the <code>~~newAction~~</code> ~~global~~ ~~function~~:		To add a ChatAction, we use the <code>actions:create</code> method. Its usage is identical to <code>conditions:create</code>.

			Example:
	<pre>		<pre>
	frank:add(ConversationStates.IDLE,		frank:add(ConversationStates.IDLE,
	ConversationPhrases.GREETING_MESSAGES,		ConversationPhrases.GREETING_MESSAGES,
	~~newCondition~~("PlayerHasItemWithHimCondition", "money"),		conditions:create("PlayerHasItemWithHimCondition", {"money"}),
	ConversationStates.ATTENDING,		ConversationStates.ATTENDING,
	"Hello.",		"Hello.",
	~~newAction~~("NPCEmoteAction", "looks greedily at your pouch of money.", false))		actions:create("NPCEmoteAction", {"looks greedily at your pouch of money.", false}))
	</pre>		</pre>

Line 404:		Line 404:
	ConversationPhrases.GREETING_MESSAGES,		ConversationPhrases.GREETING_MESSAGES,
	{		{
	~~newCondition~~("PlayerHasItemWithHimCondition", "money"),		conditions:create("PlayerHasItemWithHimCondition", {"money"}),
	~~newNotCondition~~(~~newCondition~~("NakedCondition")),		conditions:notCondition(conditions:create("NakedCondition")),
	},		},
	ConversationStates.ATTENDING,		ConversationStates.ATTENDING,
	nil,		nil,
	{		{
	~~newAction~~("SayTextAction", "Hello."),		actions:create("SayTextAction", {"Hello."}),
	~~newAction~~("NPCEmoteAction", "looks greedily at your pouch of money.", false),		actions:create("NPCEmoteAction", {"looks greedily at your pouch of money.", false}),
	})		})
	</pre>		</pre>
Line 420:		Line 420:
	<pre>		<pre>
	local conditions = {		local conditions = {
	~~newCondition~~("PlayerHasItemWithHimCondition", "money"),		conditions:create("PlayerHasItemWithHimCondition", {"money"}),
	{		{
	~~newNotCondition~~(~~newCondition~~("NakedCondition")),		conditions:notCondition(conditions:create("NakedCondition")),
	},		},
	}		}
Line 432:		Line 432:
	nil,		nil,
	{		{
	~~newAction~~("SayTextAction", "Hello."),		actions:create("SayTextAction", {"Hello."}),
	~~newAction~~("NPCEmoteAction", "looks greedily at your pouch of money.", false),		actions:create("NPCEmoteAction", {"looks greedily at your pouch of money.", false}),
	})		})

	</pre>		</pre>

imported>AntumDeluge: /* Add Zone Music */ "setZoneMusic" replaced with "game:setMusic"

2020-04-12T23:32:37Z

Add Zone Music: "setZoneMusic" replaced with "game:setMusic"

← Older revision	Revision as of 23:32, 12 April 2020
(No difference)

imported>AntumDeluge: /* Add Zone Music */ "setZoneMusic" replaced with "game:setMusic"

2020-04-12T23:32:37Z

Add Zone Music: "setZoneMusic" replaced with "game:setMusic"

← Older revision		Revision as of 23:32, 12 April 2020
Line 278:		Line 278:
	=== Add Zone Music ===		=== Add Zone Music ===

	Music can be added to zones with the <code>~~setZoneMusic~~</code> ~~global~~ function. It supports the following arguments:		Music can be added to zones with the <code>game:setMusic</code> function. It supports the following arguments:
	* ''filename:'' Basename of the OGG audio file to use stored in {{StendhalFile\|master\|data/music\|data/music}}.		* <span style="color:darkgreen; font-style:italic;>filename:</span> Basename of the OGG audio file to use stored in {{StendhalFile\|master\|data/music\|data/music}}.
			* <span style="color:darkgreen; font-style:italic;>args:</span> A table of key=value integers.
	* ''volume:'' (optional) Volume level.
			* Valid keys:
⚫	* ''x:~~'' (optional)~~ The horizontal point for the source of the music.
			** <span style="color:darkblue; font-style:italic;">volume:</span> Volume level (default: 100).
⚫	* ''y:~~'' (optional)~~ The vertical point for the source of the music.
		⚫	** <span style="color:darkblue; font-style:italic;">x:</span> The horizontal point for the source of the music (default: 1).
⚫	* ''radius:~~'' (optional)~~ The radial range at which the music can be heard.
		⚫	** <span style="color:darkblue; font-style:italic;">y:</span> The vertical point for the source of the music (default: 1).
		⚫	** <span style="color:darkblue; font-style:italic;">radius:</span> The radial range at which the music can be heard (default: 10000).

	Example:		Example:
	<pre>		<pre>
	if game:setZone("0_semos_plains_n") then		if game:setZone("0_semos_plains_n") then
	~~setZoneMusic~~("pleasant_creek_loop", 85)		game:setMusic("pleasant_creek_loop", {volume=85, radius=100})
	end		end
	</pre>		</pre>