the CreationKit Wiki

Difference between revisions of "Bendu and S M Nodes"

Bendu and S M Nodes (edit)

Revision as of 06:30, 18 February 2015

2,158 bytes added ,  06:30, 18 February 2015
→‎The Nodes
imported>Lmstearn
m
imported>Lmstearn
 
(30 intermediate revisions by the same user not shown)
Line 15: Line 15:
*Completion of the "Intermediate Quest Design" series with particular focus on the [[http://www.creationkit.com/Bethesda_Tutorial_Story_Manager Story Manager]].
*Completion of the "Intermediate Quest Design" series with particular focus on the [[http://www.creationkit.com/Bethesda_Tutorial_Story_Manager Story Manager]].


*Having a working copy of the Bendu Quest that will either activate by the Startquest command through console or with "Start Game enabled" checked off.
*A working copy of the Bendu Quest that will either activate by the Startquest command through console or with "Start Game enabled" checked off.


*A brief look at the [[http://www.creationkit.com/SM_Event_Node wiki description of the topic]].
*A brief look at the [[http://www.creationkit.com/SM_Event_Node wiki description of the topic]].
Completion of the "Scripting with Papyrus" series is also strongly recommended.




{{ProTip|<nowiki>Seasoned stagers can bypass the above and transpose just the methods to their own works.</nowiki>}}
{{ProTip|<nowiki>Seasoned stagers can bypass the above and transpose just the methods to their own works.</nowiki>}}


==The Nodes==


==The Nodes==
*Load up the quest and navigate to the Keyword entry under the Miscellaneous category in the Object Browser. Right click somewhere in the RH pane, New, and type the name of a keyword, in this case: ''GSQ01Keyword''.


*Load up the quest and navigate to the Keyword entry under Miscellaneous in the Object Browser. Right click somewhere in the RH pane, New, and type the name of a keyword, in this case: ''GSQ01Keyword''.


*From the Character entry choose SM Event Node and double click on Script Event. Right click and create a new Branch node. It will be stacked by default. This will appear below all other entries. I gave it a name of ''GSQ01BranchStart''.
*From the Character category in the Object Browser choose SM Event Node and double click on Script Event. Right click and create a new Branch node. It will be checked as '''stacked''' by default. The new node will appear below all other entries. I gave it a name of ''GSQ01BranchStart''.




Line 33: Line 37:




*Right click on ''GSQ01BranchStart'' and select '''New Quest Node'''. Give this a name of something like ''GSQ01Start''. The GSQ part will at some stage appear as lower case for some reason. I checked '''Num quests to run''' and left it at 1. Ensure the '''Stacked''' Bullet is checked and locate at the base of the page the '''Shared''' checkbox and click. On lower resolutions this requires some sorcery.
*Right click on ''GSQ01BranchStart'' and select '''New Quest Node'''. Give this a name of something like ''GSQ01Start''. The GSQ part will at some stage appear as lower case for some reason. I checked '''Num quests to run''' and left it at 1. Ensure the '''Stacked''' Bullet is checked and, at the base of the page locate the '''Shared''' checkbox and click it. On lower resolutions accessing the bottom requires some sorcery.
 
 
*Right click on the '''GSQ01Start Node''' Conditions area and implement a new condition with function ''GetEventData''. The function parameters will be from top-down: ''GetIsId'', ''Keyword'', and ''GSQ01Keyword''. Click Ok out.


*Right click on the '''GSQ01Start Node''' Conditions area and implement a new condition with function ''GetEventData''. The Function Parameters will be from top-down: ''GetIsId'', ''Keyword'', and ''GSQ01Keyword''. Click Ok out.


*Right click on the ''GSQ01Start Node'' and select '''Add Quests'''. Choose ''GSQ01'' from the list. Then select the newly created quest node, right click it, and choose '''Edit Quest'''.
*Right click on the ''GSQ01Start Node'' and select '''Add Quests'''. Choose ''GSQ01'' from the list. Then select the newly created quest node, right click it, and choose '''Edit Quest'''.


*This will bring up the quest tab, which is quite a useful shortcut, actually. Select the '''Quest Data''' tab and from the event drop-down list choose '''Script Event'''. Notice that the '''Start Game Enabled''' box is now greyed out. Now Ok out of all windows back to the main CK window and save.
 
This will bring up the quest tab, which serves as quite a useful shortcut to it, actually


{{WarningBox|It's important to '''remove''' an attached quest before deleting a node.}}
*Select the '''Quest Data''' tab and from the event drop-down list choose '''Script Event'''. Notice that the '''Start Game Enabled''' box is now greyed out. Now Ok out of all windows back to the main CK window and save.
Now that the '''Node''' has been set up with the minimum amount of information required to activate the quest, let's work on our '''Script Event'''.


==The Quest Script==
==The Quest Script==
Line 47: Line 62:
     GSQ01KeywordLocal of type Keyword filled with the GSQ01Keyword object.
     GSQ01KeywordLocal of type Keyword filled with the GSQ01Keyword object.
     MixWaterMill of type Location filled with the MixWaterMillLocation object
     MixWaterMill of type Location filled with the MixWaterMillLocation object


* Edit the script '''source''' and add this code below all existing code:
* Edit the script '''source''' and add this code below all existing code:
<source lang="papyrus">
     Function GSQ01Story()
     Function GSQ01Story()
     if (!GetStageDone(0))
     if (!GetStageDone(0))
Line 54: Line 73:
     endif
     endif
     endFunction
     endFunction
</source>




{{InDepth|<nowiki>All of the parameters excepting akLoc are unused here and can be removed,  
{{ProTip|Even though the quest may be stopped and/or in a disabled state, the mod is still active,
so GSQ01KeywordLocal.SendStoryEvent(akLoc = MixWaterMill) would work fine.
Leaving them in shows how this function can work in relatively complex scenarios.</nowiki>}}


and the SendStoryEvent will transmit the data from the trigger zone to the node stack via the quest script.}}


*Save it and exit: let's review we have done so far. See [[Bendu_and_S_M_Nodes#Notes]] regarding the extra entry in the conditions.
 
{{InDepth|All of the parameters excepting akLoc are unused here and can be removed,
so <nowiki>GSQ01KeywordLocal.SendStoryEvent(akLoc = MixWaterMill)</nowiki> would work fine.
 
Including them here shows the potential capabilities of this function in more complex quest trigger scenarios.}}
 
 
*Save it and exit: let's review we have done so far. See [[Bendu_and_S_M_Nodes#Notes| notes]] regarding the extra entry in the conditions.




Line 81: Line 107:




*Locate and edit the FarmhouseDoor01 object on the exterior of the MixwaterMill Workers House. Click the scripts tab and Add a new script. Call it ''StartingGSQ01Quest''.
*Locate and edit the '''FarmhouseDoor01''' object on the exterior of the MixwaterMill Workers House. Click the scripts tab and Add a new script. Call it ''StartingGSQ01Quest''.
 


*Add a new property to it:
*Add a new property to it:
Line 91: Line 118:




<source lang="papyrus">
     EVENT onActivate (objectReference akActionRef)
     EVENT onActivate (objectReference akActionRef)
     Send_Story()
     Send_Story()
Line 98: Line 126:
     QF_GSQ01_01000D62 tempGSQ01 = GetGSQ01 as QF_GSQ01_01000D62
     QF_GSQ01_01000D62 tempGSQ01 = GetGSQ01 as QF_GSQ01_01000D62
     tempGSQ01.GSQ01Story()
     tempGSQ01.GSQ01Story()
    tempGSQ01=None
     EndFunction
     EndFunction
</source>
{{InDepth|The long line of code beginning with ''QF_GSQ01_01000D62'' looks scary.
Here we replace the (empty) reference of ''tempGSQ01'' with the reference we ''got'' from ''GetGSQ01'',
a reference which is, in fact, directed toward our quest object, ''GSQ01''.
Consider ''QF_GSQ01_01000D62'' as a "type". It's type is that of '''script'''.}}
If the line in ''Send_Story()'' were just
<source lang="papyrus">
QF_GSQ01_01000D62 tempGSQ01 = GetGSQ01
</source>
That would be the same as:
<source lang="papyrus">
QF_GSQ01_01000D62 tempGSQ01 = GetGSQ01 as Quest
</source>
The "as" operator is called a '''cast''' and the following statement looks for something in GSQ01 to "match" the '''script''' object ''QF_GSQ01_01000D62'':
<source lang="papyrus">
QF_GSQ01_01000D62 tempGSQ01 = GetGSQ01
</source>
Unfortunately Quest doesn't match and it won't compile because there is no implicit casting of ''GetGSQ01'' to ''QF_GSQ01_01000D62''
We expect the variable ''tempGSQ01'' to be used just once, so it's good practice to clear any persistent reference to the local ''GetGSQ01'' by "nulling" ''tempGSQ01'' after ''GSQ01Story'' is called.
{{ProTip|For more detailed info on casting refer [http://www.cipscis.com/skyrim/tutorials/externalaccess.aspx here].
For a better picture of how script objects are organized in the CK, check [http://www.creationkit.com/Category:Script_Objects this] out.}}


Save the script. Our task is done and the modifications are ready for testing.
*Save the script. Our task is done and the modifications are ready for Bendu.


== Notes ==
== Notes ==
Line 112: Line 173:
     [Date - Time] [StartingGSQ01Quest < (0001656B)>]: send_story Called - starting quest [Keyword <GSQ01Keyword (2E00A9D9)>]
     [Date - Time] [StartingGSQ01Quest < (0001656B)>]: send_story Called - starting quest [Keyword <GSQ01Keyword (2E00A9D9)>]
:only appears when the SendStory Event is generated from the trigger object.
:only appears when the SendStory Event is generated from the trigger object.


*Given a [[http://www.creationkit.com/Talk:SM_Event_Node#Conditions problem]] experienced with conditions, the '''if''' condition in Function ''GSQ01Story''() can be replaced by adding:
*Given a [[http://www.creationkit.com/Talk:SM_Event_Node#Conditions problem]] experienced with conditions, the '''if''' condition in Function ''GSQ01Story''() can be replaced by adding:
Anonymous user
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/7035...7066"