Custom Scripting - Revision history

Elemuffin: Migrated Player House Variable Events

2023-12-01T16:11:45Z

Migrated Player House Variable Events

@@ Line 93: / Line 93: @@
 |-
 |}
 [[Category:Sinfar Supporters]]

ItsABadger: /* Events List */

2023-11-30T21:01:33Z

Events List

← Older revision		Revision as of 21:01, 30 November 2023
Line 66:		Line 66:

	{\| class="wikitable" border=1		{\| class="wikitable" border=1
	!Variable Name!!Called From!!Example\|		!Variable Name!!Called From!!Example\|Sample Script
	\|-		\|-
	\| P_MODEVENT_ACQITEM \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_acqitem pf_ev_acqitem] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_acqitem p_25_acqitem]		\| P_MODEVENT_ACQITEM \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_acqitem pf_ev_acqitem] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_acqitem p_25_acqitem]

Elemuffin: +Using the Module Events

2023-11-29T23:11:03Z

+Using the Module Events

← Older revision		Revision as of 23:11, 29 November 2023
Line 54:		Line 54:

	You can look at those 2 scripts: [https://nwn.sinfar.net/res_nss_edit.php?name=p_x_wokeupare p_x_wokeupare] and [https://nwn.sinfar.net/res_nss_edit.php?name=p_x_suspendare p_x_suspendare]: they basically call the same functions but of course in the context of an house script (p_) so GetLocalString automatically ensure that the variable name is prefixed by P_ and the tag check expect the _P_ prefix because it is also mandatory for a player blueprint.		You can look at those 2 scripts: [https://nwn.sinfar.net/res_nss_edit.php?name=p_x_wokeupare p_x_wokeupare] and [https://nwn.sinfar.net/res_nss_edit.php?name=p_x_suspendare p_x_suspendare]: they basically call the same functions but of course in the context of an house script (p_) so GetLocalString automatically ensure that the variable name is prefixed by P_ and the tag check expect the _P_ prefix because it is also mandatory for a player blueprint.

			= Using the Module Events =

			=== How to Register a Module Event ===

			Similar to the module events, you can register "Global" events with variables on the area containing the <code>MAIN_DOOR</code>.

			[[File:Ph mod events.png]]

			=== Events List ===

			{\| class="wikitable" border=1
			!Variable Name!!Called From!!Example\|
			\|-
			\| P_MODEVENT_ACQITEM \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_acqitem pf_ev_acqitem] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_acqitem p_25_acqitem]
			\|-
			\| P_MODEVENT_UNACQITEM \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_unacqitem pf_ev_unacqitem] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_unacqitem p_25_unacqitem]
			\|-
			\| P_MODEVENT_ACTIVATEITEM \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_activitem pf_ev_activitem] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_activatitem p_25_activatitem]
			\|-
			\| P_MODEVENT_CHAT \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_chat pf_ev_chat] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_chat p_25_chat]
			\|-
			\| P_MODEVENT_PCDEATH \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_pcdeath pf_ev_pcdeath] \|\| [[https://nwn.sinfar.net/res_nss_edit.php?name=p_25_pcdeath p_25_pcdeath]
			\|-
			\| P_MODEVENT_PCDYING \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_pcdying pf_ev_pcdying] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_pcdying p_25_pcdying]
			\|-
			\| P_MODEVENT_PCENTER \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_enterhouse pf_ev_enterhouse]] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_pcenter p_25_pcenter]
			\|-
			\| P_MODEVENT_PCLEAVE \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_leavehouse pf_ev_leavehouse]] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_pcenter p_25_pcenter]
			\|-
			\| P_MODEVENT_RESPAWN \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_pcrespawn pf_ev_pcrespawn] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_respawn p_25_respawn]
			\|-
			\| P_MODEVENT_REST \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_rest pf_ev_rest]] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_rest p_25_rest]
			\|-
			\| P_MODEVENT_EQUIP \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_equip pf_ev_equip] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_equip p_25_equip]
			\|-
			\| P_MODEVENT_UNEQUIP \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=pf_ev_unequip pf_ev_unequip] \|\| [https://nwn.sinfar.net/res_nss_edit.php?name=p_25_unequip p_25_unequip]
			\|-
			\|}

	[[Category:Sinfar Supporters]]		[[Category:Sinfar Supporters]]

Elemuffin: /* How It Was Enabled */

2023-11-29T21:37:12Z

How It Was Enabled

← Older revision		Revision as of 21:37, 29 November 2023
Line 46:		Line 46:
	=== How It Was Enabled ===		=== How It Was Enabled ===
	Simply by adding those 2 lines:		Simply by adding those 2 lines:
	<syntaxhighlight lang="~~nwscript~~">		<syntaxhighlight lang="c">
	RegisterVariableEvent(oArea, "EVENT_WOKEUP", "p_x_wokeupare");		RegisterVariableEvent(oArea, "EVENT_WOKEUP", "p_x_wokeupare");
	RegisterVariableEvent(oArea, "EVENT_SUSPEND", "p_x_suspendare");		RegisterVariableEvent(oArea, "EVENT_SUSPEND", "p_x_suspendare");

Elemuffin: Add Content From: Using Sinfar Spawning System

2023-11-29T21:30:06Z

Add Content From: Using Sinfar Spawning System

← Older revision		Revision as of 21:30, 29 November 2023
Line 34:		Line 34:

	* Only Sinfar Supporters can create Players Blueprints/Scripts and upload a house that uses them. Any Sinfar Supporter can use any of the Players Scripts or Bluprints, but they can only be changed by the owner (the player id of the owner is in the ResRef: p_<hex_player_id>_). All resources are listed here: https://nwn.sinfar.net/res_list.php?erf_id=2		* Only Sinfar Supporters can create Players Blueprints/Scripts and upload a house that uses them. Any Sinfar Supporter can use any of the Players Scripts or Bluprints, but they can only be changed by the owner (the player id of the owner is in the ResRef: p_<hex_player_id>_). All resources are listed here: https://nwn.sinfar.net/res_list.php?erf_id=2

			= Using Sinfar Spawning System =

			Sinfar's spawning system is documented here: [[Sinfar Spawning System]] and it can be used inside houses with a few differences.

			=== Usage Difference ===

			# The tag must have the additional prefix "_P_", for example: _P_SPAWN_C_P_25_SERVANT: <br />[[File:Sinfar spawning system 20190313-001318.png]]
			# The variables must have the additional prefix "P_", for example P_SPAWN_CHANCE: <br />[[File:Sinfar spawning system 20190313-001245.png]]

			=== How It Was Enabled ===
			Simply by adding those 2 lines:
			<syntaxhighlight lang="nwscript">
			RegisterVariableEvent(oArea, "EVENT_WOKEUP", "p_x_wokeupare");
			RegisterVariableEvent(oArea, "EVENT_SUSPEND", "p_x_suspendare");
			</syntaxhighlight>

			When an house area is created (SetupHomeArea in [https://nwn.sinfar.net/res_nss_edit.php?name=home_include home_include]). You could do the same by setting variables on your areas ([[Variable Based Events]]) and create your own system, but for Sinfar Spawn System, it is done automatically.

			You can look at those 2 scripts: [https://nwn.sinfar.net/res_nss_edit.php?name=p_x_wokeupare p_x_wokeupare] and [https://nwn.sinfar.net/res_nss_edit.php?name=p_x_suspendare p_x_suspendare]: they basically call the same functions but of course in the context of an house script (p_) so GetLocalString automatically ensure that the variable name is prefixed by P_ and the tag check expect the _P_ prefix because it is also mandatory for a player blueprint.

	[[Category:Sinfar Supporters]]		[[Category:Sinfar Supporters]]

Elemuffin: /* Players Custom Scripts */

2023-11-29T21:08:56Z

Players Custom Scripts

← Older revision		Revision as of 21:08, 29 November 2023
Line 34:		Line 34:

	* Only Sinfar Supporters can create Players Blueprints/Scripts and upload a house that uses them. Any Sinfar Supporter can use any of the Players Scripts or Bluprints, but they can only be changed by the owner (the player id of the owner is in the ResRef: p_<hex_player_id>_). All resources are listed here: https://nwn.sinfar.net/res_list.php?erf_id=2		* Only Sinfar Supporters can create Players Blueprints/Scripts and upload a house that uses them. Any Sinfar Supporter can use any of the Players Scripts or Bluprints, but they can only be changed by the owner (the player id of the owner is in the ResRef: p_<hex_player_id>_). All resources are listed here: https://nwn.sinfar.net/res_list.php?erf_id=2

			[[Category:Sinfar Supporters]]

Elemuffin: Created page with "= Players Custom Scripts = Sinfar Supporters can make their own scripts for inside their house. * The NWScript virtual machine use this 2da: [https://nwn.sinfar.net/res_2da_edit.php?erf_id=817&resref=pf_nwscript pf_nwscript.2da] (Supporter Login Required) ... to validate each function call. Here's what each column are for: {| class="wikitable" border=1 ! Column !! Description |- | Enable || **** = The function call will do nothing and return an empty v..."

2023-11-29T20:54:24Z

Created page with "= Players Custom Scripts = Sinfar Supporters can make their own scripts for inside their house. * The NWScript virtual machine use this 2da: [https://nwn.sinfar.net/res_2da_edit.php?erf_id=817&resref=pf_nwscript pf_nwscript.2da] (Supporter Login Required) ... to validate each function call. Here's what each column are for: {| class="wikitable" border=1 ! Column !! Description |- | Enable || <nowiki>****</nowiki> = The function call will do nothing and return an empty v..."

New page

= Players Custom Scripts =
Sinfar Supporters can make their own scripts for inside their house.

* The NWScript virtual machine use this 2da: [https://nwn.sinfar.net/res_2da_edit.php?erf_id=817&resref=pf_nwscript pf_nwscript.2da] (Supporter Login Required) ... to validate each function call.

Here's what each column are for:
{| class="wikitable" border=1
! Column !! Description
|-
| Enable ||
<nowiki>****</nowiki> = The function call will do nothing and return an empty value. 
YES = The function will be called if the parameters and OBJECT_SELF are valid. 
AS_IS = The function will be called no matter what.
|-
| ExecuteScript || After the validation, instead of calling the internal code, this script will be executed as an event with the same parameters.
|-
| GetNextFunction || Since the default behaviour of GetFirst/Next functions may return invalid objects and so break make it inefficient/impossible to loop through all objects, when this field is set, the engine will automatically call this next function until it can return a valid object or if it has really reached the last object.
|-
| ObjectSelf Param1 Param2 ParamN || This are the restriction of each parameter and the caller. If the restriction check fails, the function call will do nothing and return an empty value. The parameter depends on the value type NO_PC = The object must have been created by a player script. NO_MODULE = The object can't be the module. string/any value (often "P_") = What the string must start by.
|-
|}

* Only the module and objects that are in the house (any area of the house) are accessible. Functions may return external objects but then GetIsObjectValid(oExternalObject) will return false and calling any function with those objects as parameter will fail.

* Only Players Blueprints can be created with the CreateObject function.

* The events script field of Player Blueprints must start by "p_".

* Players Dialogs must start by "p_".

* Players Blueprints Tag must always start by "_P_".

* Local variables and Campaign variables must start by "P_".

* Only Sinfar Supporters can create Players Blueprints/Scripts and upload a house that uses them. Any Sinfar Supporter can use any of the Players Scripts or Bluprints, but they can only be changed by the owner (the player id of the owner is in the ResRef: p_<hex_player_id>_). All resources are listed here: https://nwn.sinfar.net/res_list.php?erf_id=2