ContentDesigner:Spawn Script Template - Revision history

Cynnar at 04:47, 16 June 2016

2016-06-16T04:47:51Z

Cynnar at 04:52, 11 September 2015

2015-09-11T04:52:02Z

Cynnar at 03:54, 11 September 2015

2015-09-11T03:54:21Z

Cynnar at 07:38, 9 September 2015

2015-09-09T07:38:15Z

Cynnar at 06:11, 8 September 2015

2015-09-08T06:11:54Z

Cynnar at 06:06, 8 September 2015

2015-09-08T06:06:34Z

Cynnar at 06:06, 8 September 2015

2015-09-08T06:06:05Z

Cynnar at 05:56, 8 September 2015

2015-09-08T05:56:13Z

Cynnar at 05:42, 8 September 2015

2015-09-08T05:42:33Z

Cynnar at 09:07, 7 September 2015

2015-09-07T09:07:12Z

← Older revision		Revision as of 04:47, 16 June 2016
Line 1:		Line 1:
−	{{PageHeaderChild\|~~ContentDesigner~~:SpawnScripts\|Spawn Script Template}}	+	{{PageHeaderChild\|LUA:SpawnScripts\|Spawn Script Template}}

	This guide is all about the spawn script template, and offers an explanation of each part of the code to help better understand how the emulator server uses LUA scripting language to make your NPC's come to life. If you are using the EQ2LuaEditor then this exact template can be created by going to ''file->New->Spawn Script''.		This guide is all about the spawn script template, and offers an explanation of each part of the code to help better understand how the emulator server uses LUA scripting language to make your NPC's come to life. If you are using the EQ2LuaEditor then this exact template can be created by going to ''file->New->Spawn Script''.

@@ Line 40: / Line 40: @@
 <br/>
 function respawn(NPC)<br/>
-	spawn(NPC)<br/>
+&nbsp;&nbsp;&nbsp;&nbsp;spawn(NPC)<br/>
 end<br/>
 <br/>
@@ Line 76: / Line 76: @@
 <br/>
 function respawn(NPC)<br/>
-	spawn(NPC)<br/>
+&nbsp;&nbsp;&nbsp;&nbsp;spawn(NPC)<br/>
 end<br/>
 <br/>

@@ Line 58: / Line 58: @@
    	FaceTarget(NPC, Spawn)
    end
-As we can see in the first line the very first word is ''function''. This is a core function that is used by the server, and tells the server that everything after this is part of LUA and needs to be executed accordingly. To see a full list of server core functions visit the [[LUA:AllFunctions|Server Core Functions]] section of the LUA page. The next word is ''hailed''. This is the function that LUA uses. To see a full list of functions that are used by a LUA Function you can visit the [[LUA:SpawnScripts|All LUA Functions]] section of the LUA page. Next we see ''(NPC, Spawn)''. These are parameters. They will always be inside the left ( and right ) parentheses and are needed for the function to work. ''NPC'' is our first parameter in this list. The first parameter is telling the ''function hailed'' who needs to be doing the responding. Since ''NPC'' is the first parameter here then it is telling the function hailed that the NPC is what needs to respond when hailed. Take notice now that there is a comma " , " then a space that separates NPC and Spawn. You must put this comma and space in so LUA knows where one parameter ends and the other begins. The second parameter is ''Spawn'' and is telling ''function hailed'' who the ''NPC'' needs to respond to. In this case it is the ''Spawn''. Current standards we have adopted are to use NPC as the value for the NPCs parameters, and depending on the function, Spawn as the value for the Players parameters.
+Every function begins with the word function, and will close out with the word end. Everything after function a before end is what we want the function to do. We need to tell the server what function we want to execute. This is done by using one of the functions the server calls, and in this example it is hailed. The hailed function needs two parameters to work properly, and will always be between the left and right parentheses ( ). In this example the first parameter is NPC. This points to the NPC that the spawn script is assigned to. There is a comma "," followed by a space that separates the two parameter, and must be there or the function will not work. The next parameter is Spawn. For the hailed function this points to the player. Just a quick note here that Spawn does not always point to player depending on the function used. Spawn could also point to another NPC for NPC to NPC interaction. For a deeper look into the spawn server functions visit the [[LUA:SpawnScripts|LUA SpawnScritps]] page.
-On the second line we see that it is indented. The more lines of code you have the harder it becomes to keep up with every thing. With this indent it allows a script writer to easily see what is inside each function, and every line inside the function should be indented also. After that the code starts with ''FaceTarget''. This is another LUA function and as it states this will make something face it's target. The following we see is again another set of parameters that is identical to the function hailed. ''(NPC, Spawn)'' The first parameter is telling ''FaceTarget'' who needs to be doing the facing. In this case it is the ''NPC''. This means that the second parameter is telling ''FaceTarget'' who the ''NPC'' needs to face. In this case it is the ''Spawn'', and remember that Spawn stands for the player.
+Inside our function we have FaceTarget. This is one of many lua functions that can be used, and as the name suggest this will cause the NPC to face its target. It also has to have two parameters as well, and uses NPC and Spawn. To see all of these function visit [[LUA:AllFunctions|LUA All Functions]] page.
 {|style="table-layout:fixed; width: 100%;"
 |{{TextBox

@@ Line 58: / Line 58: @@
    	FaceTarget(NPC, Spawn)
    end
-As we can see in the first line the very first word is ''function''. This tells the server that everything after this is part of LUA and needs to be executed accordingly. The next word is ''hailed''. This is the actual function that we want to have preformed. To see a full list of functions that the emulator use you can visit the [[LUA:AllFunctions|All Functions]] section of the LUA page. Next we see ''(NPC, Spawn)''. These are parameters. They will always be inside the left ( and right ) parentheses and are needed for the function to work. ''NPC'' is our first parameter in this list. The first parameter is telling the ''function hailed'' who needs to be doing the responding. Since ''NPC'' is the first parameter here then it is telling the function hailed that the NPC is what needs to respond when hailed. Take notice now that there is a comma " , " then a space that separates NPC and Spawn. You must put this comma and space in so LUA knows where one parameter ends and the other begins. The second parameter is ''Spawn'' and is telling ''function hailed'' who the ''NPC'' needs to respond to. In this case it is the ''Spawn''. Current standards we have adopted are to use NPC as the value for the NPCs parameters, and Spawn as the value for the Players parameters.
+As we can see in the first line the very first word is ''function''. This is a core function that is used by the server, and tells the server that everything after this is part of LUA and needs to be executed accordingly. To see a full list of server core functions visit the [[LUA:AllFunctions|Server Core Functions]] section of the LUA page. The next word is ''hailed''. This is the function that LUA uses. To see a full list of functions that are used by a LUA Function you can visit the [[LUA:SpawnScripts|All LUA Functions]] section of the LUA page. Next we see ''(NPC, Spawn)''. These are parameters. They will always be inside the left ( and right ) parentheses and are needed for the function to work. ''NPC'' is our first parameter in this list. The first parameter is telling the ''function hailed'' who needs to be doing the responding. Since ''NPC'' is the first parameter here then it is telling the function hailed that the NPC is what needs to respond when hailed. Take notice now that there is a comma " , " then a space that separates NPC and Spawn. You must put this comma and space in so LUA knows where one parameter ends and the other begins. The second parameter is ''Spawn'' and is telling ''function hailed'' who the ''NPC'' needs to respond to. In this case it is the ''Spawn''. Current standards we have adopted are to use NPC as the value for the NPCs parameters, and depending on the function, Spawn as the value for the Players parameters.
 On the second line we see that it is indented. The more lines of code you have the harder it becomes to keep up with every thing. With this indent it allows a script writer to easily see what is inside each function, and every line inside the function should be indented also. After that the code starts with ''FaceTarget''. This is another LUA function and as it states this will make something face it's target. The following we see is again another set of parameters that is identical to the function hailed. ''(NPC, Spawn)'' The first parameter is telling ''FaceTarget'' who needs to be doing the facing. In this case it is the ''NPC''. This means that the second parameter is telling ''FaceTarget'' who the ''NPC'' needs to face. In this case it is the ''Spawn'', and remember that Spawn stands for the player.

@@ Line 63: / Line 63: @@
 The final line has the word ''end'' on it and that is is. Every function must close with the word ''end''. This tells the server that this LUA function has come to and end and it can now continue down the list.
 [[ContentDesigner:Creating_Conversations | On to Creating Conversations]]<br/>
 [[ContentDesigner:SpawnScripts | Back to SpawnScripts]]

← Older revision		Revision as of 06:06, 8 September 2015
Line 65:		Line 65:


−	[[ContentDesigner:Creating_Conversations \| On to Creating Conversations]]	+	[[ContentDesigner:Creating_Conversations \| On to Creating Conversations]]<br/>
	[[ContentDesigner:SpawnScripts \| Back to SpawnScripts]]		[[ContentDesigner:SpawnScripts \| Back to SpawnScripts]]

@@ Line 44: / Line 44: @@
 <br/>
 function hailed(NPC, Spawn)<br/>
 end<br/>
 <br/>
 function aggro(NPC, Spawn)<br/>
 end<br/>
 <br/>
 function death(NPC, Spawn)<br/>
 end
 |BackgroundColor=ffffff
 |FontColor=000000}}
 |}
+In order to get a NPC to operate in a particular way, a function must be used. These five basic functions are the most used functions for a spawn script. At the very least a spawn script needs the ''function spawn'', ''function respawn'', and ''function hailed'' in order to make an NPC have a conversation. Before jumping into what each of these functions mean, it is crucial to understand the syntax and parameters that make up a function. Lets use the function hailed as an example.
 '''''More Comming Soon...'''''

@@ Line 35: / Line 35: @@
 {|style="table-layout:fixed; width: 100%;"
 |{{TextBox
-|Functions
+|Basic Functions
 |function spawn(NPC)<br/>
 end<br/>
 <br/>