the CreationKit Wiki

Difference between revisions of "User:DavidJCobb/Miscellany"

User:DavidJCobb/Miscellany (edit)

Revision as of 02:58, 20 March 2017

8,165 bytes removed ,  02:58, 20 March 2017
pruning, removing gamesas, etc
imported>DavidJCobb
(→‎Unsorted edge-cases: Fun with null cells: Cell variables can break during load screens.)
imported>DavidJCobb
(pruning, removing gamesas, etc)
 
Line 1: Line 1:
This page contains miscellaneous information about Skyrim modding that I've found during my glorious adventures through the Internet. Please lemme know if I link to any sources this wiki isn't cool with. __FORCETOC__
miscellanous information; outdated
 
__FORCETOC__


== Scripting ==
== Scripting ==
=== Changing a player's Speed Multiplier (SpeedMult) ===
=== Changing a player's Speed Multiplier (SpeedMult) ===
:''Source:'' [http://www.gamesas.com/dynamic-walk-speed-script-t253947.html '''gamesas:''' Dynamic Walk Speed Script]
Changes to the player's Speed Multiplier [[Actor Value|actor value]] don't take effect unless you prompt the game engine to take notice. This issue applies to both scripted changes and changes triggered by a "Value Modifier" [[Magic Effect|magic effect]]. There are two ways to force the game to actually use a changed SpeedMult:
Changes to the player's Speed Multiplier [[Actor Value|actor value]] don't take effect unless you prompt the game engine to take notice. This issue applies to both scripted changes and changes triggered by a "Value Modifier" [[Magic Effect|magic effect]]. There are two ways to force the game to actually use a changed SpeedMult:


* Modify the player's inventory. Silently [[AddItem - ObjectReference|adding]] and then [[RemoveItem - ObjectReference|removing]] an item should do the trick.
* Modify the player's inventory. Silently [[AddItem - ObjectReference|adding]] and then [[RemoveItem - ObjectReference|removing]] an item should do the trick.
* Modify the player's carry weight actor value. Adding and then removing 0.1 works.
* Modify the player's carry weight actor value. Adding and then removing 0.1 works.
=== Detecting invalid references ===
:''Source:'' [http://www.gamesas.com/suspended-stack-count-over-our-warning-threshold-t348345.html '''gamesas:''' Suspended stack count is over our warning threshold...]
It's possible for your mod to reference (by variable or Alias) a Form from another mod. If that mod is uninstalled, your reference will break. Tests like <code>kMyObject is ObjectReference</code> will return true, but attempts to access any functions or data on the variable will throw errors. What you must do instead is:
  Int iFormID = kSomeReference.GetFormId()
  If iFormID && kSomeReference is ObjectReference
      ;
      ; we're cool bro
      ;
  Else
      ;
      ; CODE RED
      ;
  EndIf
=== Detecting references created at run-time ===
:''Source:'' [http://afkmods.iguanadons.net/index.php?/topic/3941-how-to-distinguish-run-time-created-actors-from-hand-placed-ones/ '''AFKMods:''' How to distinguish run-time created actors from hand-placed ones ? ]
If the reference is an Actor, you can't! The base game can create actors to fill quest aliases, it seems.
As for other kinds of references? I'll look into that later.


=== Issues with optional function arguments ===
=== Issues with optional function arguments ===
:''Source:'' [http://www.gamesas.com/papyrus-functions-with-optional-arguments-t334901.html '''gamesas:''' Papyrus functions with optional arguments]
When you compile a function with optional script arguments, the argument data is updated for the containing script only. If other scripts make cross-script calls to your function, those functions must be recompiled in order for their calls to work properly. Otherwise...
When you compile a function with optional script arguments, the argument data is updated for the containing script only. If other scripts make cross-script calls to your function, those functions must be recompiled in order for their calls to work properly. Otherwise...


Line 57: Line 32:


Occurs when old script data (baked into a savegame) has malfunctioned badly enough for the game engine to just throw it out.
Occurs when old script data (baked into a savegame) has malfunctioned badly enough for the game engine to just throw it out.
=== Dumping stack ===
I don't fully understand this one yet. For now, I'm just tossing down any information I find, so I can get a better concept of what this one means.
* http://afkmods.iguanadons.net/index.php?/topic/3889-papyrus-stack-dump-with-dragon-attack-at-cow/
* [http://afkmods.iguanadons.net/index.php?/topic/3879-dlc1seranalevelingscript-causing-numerous-papyrus-errors/ Serana + dragon + Falkreath = bad?]


=== Variable loaded from save could not be found on the actual object ===
=== Variable loaded from save could not be found on the actual object ===
Line 69: Line 38:


     [11/17/2013 - 02:59:23AM] warning: Variable ::WVAAliasStorage_var on script DLC1_QF_DLC1EclipseAttack2_01017648 loaded from save not found within the actual object. This variable will be skipped.
     [11/17/2013 - 02:59:23AM] warning: Variable ::WVAAliasStorage_var on script DLC1_QF_DLC1EclipseAttack2_01017648 loaded from save not found within the actual object. This variable will be skipped.
== Fun with multi-threading! ==
"Fun" may not be the right word to use here, actually.
=== Conditions are interruptible ===
::''Source:'' [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-7#entry149921 '''AFKMods:''' The critter thread]
Conditions like the following are inherently unreliable due to how Papyrus handles threading.
  If kMyObjectReference && !kMyObjectReference.isDeleted() && !kMyObjectReference.isDisabled()
  EndIf
<code>IsDeleted()</code> and <code>IsDisabled()</code> are delayed functions (as opposed to [[:Category:Non-delayed Native Function|non-delayed functions]]), so Papyrus may actually pause the current script ''in the middle of this If statement'' to run them. During that time, another thread can set the ObjectReference variable to None. Per the scripter's comments in the source, this can lead to two kinds of errors:
* <code>kMyObjectReference.IsDisabled()</code> gets treated as <code>None.IsDisabled()</code>. This is invalid and returns <code>None</code>.
* That returned <code>None</code> is then inverted with <code>!</code>, which is also invalid. This yields Papyrus log errors of the form:
*: <pre>warning: Assigning None to a non-object variable named "::temp33"</pre>
The lesson to learn here is that even a single If statement can be interrupted and hosed by multithreading.
Makes me wonder if something like the following might work:
  If kMyObjectReference && !kMyObjectReference.isDeleted() && kMyObjectReference && !kMyObjectReference.isDisabled()
  EndIf
=== Delayed functions are interruptible ===
Just about every native function that isn't [[:Category:Non-delayed Native Function|listed here]] is interruptible. Every moment you call these functions is a moment your script can be interrupted. This produces all sorts of "fun" oddities.
<ul>
  <li><code>Delete()</code> is a delayed function. Your attempt to delete an object can be interrupted by another attempt to delete that same object, resulting in your interrupted call failing (it's treated as <code>None.Delete()</code>).</li>
  <li>
      The <code>x</code>, <code>y</code>, and <code>z</code> "properties" on ObjectReferences [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-8#entry150159 are actually interruptible functions]. As such, code blocks like the following can fail:
      <source lang="Papyrus">Int iCoordX = kMyObjectReference.x ; due to multi-threading, this code may be interrupted here...
Int iCoordY = kMyObjectReference.y ; ...and by the time the code resumes, kMyObjectReference could've been screwed with</source>
  </li>
</ul>
=== Other things to remember ===
* Cross-script function calls are interruptible. Your precious <code>Debug.Trace(...)</code> statements actually ''can'' affect things.




== Unsorted facts ==
== Unsorted facts ==
* If you wish to borrow critter behaviors for a script, be careful. I've been reading through USKP discussions and apparently, Bethesda's critter scripts were broke as ''hell.'' Seems like the USKP rebuilds most critter behaviors almost from scratch.
* If you wish to borrow critter behaviors for a script, be careful. I've been reading through USKP discussions and apparently, Bethesda's critter scripts were very buggy. Seems like the USKP rebuilds most critter behaviors almost from scratch.
* [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-3#entry149560 "Translate routines will operate properly in unloaded areas."] This, in regards to animating and moving critters like moths.
* [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-3#entry149560 "Translate routines will operate properly in unloaded areas."] This, in regards to animating and moving critters like moths.
** Even though translations work in unloaded cells without 3D loaded, [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-4#entry149598 "<code>StopTranslation()</code> requires the cell attached and loaded 3D. There's no reason for it, but it throws an error without it!"]
** Even though translations work in unloaded cells without 3D loaded, [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-4#entry149598 "<code>StopTranslation()</code> requires the cell attached and loaded 3D. There's no reason for it, but it throws an error without it!"]
Line 119: Line 47:
** [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-4#entry149599 There is reason to doubt that translate routines actually do operate properly in unloaded areas.] It's possible that they don't properly unlock the translated object (allowing for deletion) unless the cell is attached.
** [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-4#entry149599 There is reason to doubt that translate routines actually do operate properly in unloaded areas.] It's possible that they don't properly unlock the translated object (allowing for deletion) unless the cell is attached.
* [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-2#entry149454 When an ingredient is sold or consumed, "it will have the deleted flag set already, and won't have a parent cell or 3D."]
* [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-2#entry149454 When an ingredient is sold or consumed, "it will have the deleted flag set already, and won't have a parent cell or 3D."]
*[http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-6#entry149699 Critter animations]: butterflies and moths use <code>fTakeOff</code>, while dragonflies and fireflies can use <code>fTakeOff</code> or <code>TakeOff</code>.
* [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-6#entry149699 Critter animations]: butterflies and moths use <code>fTakeOff</code>, while dragonflies and fireflies can use <code>fTakeOff</code> or <code>TakeOff</code>.
*You cannot [[GetAnimationVariableFloat - ObjectReference|get animation variables]] for an object [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-9#entry150430 if its 3D isn't loaded].
* [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-10#entry150967 "We're just going to have to live with the fact the game engine unloads 3D at unexplained times without warning."]
** I play with a mod that creates manual saves at timed intervals for me. When it does this, I often see the game world flicker, and sometimes, statics near the edge of the screen have to fade back in. So saving the game is something that can mess with what 3D is and isn't loaded.
* When a persistent ObjectReference is removed from the game world (e.g. sold to a merchant), [http://afkmods.iguanadons.net/index.php?/topic/3717-skyrim-the-papyrus-function-getparentcell-and-what-may-happen-when-it-runs-on-a-persistent-reference/ its GetParentCell() method may return the cell from which it originated.] It may also return other nonsense results, so try to avoid using the method on a persistent reference.
* [http://afkmods.iguanadons.net/index.php?/topic/3676-skyrim-information-baked-into-saves/#entry145982 Among other things, this post describes best practices for working with vanilla Actors in a mod.]
** Do note [http://afkmods.iguanadons.net/index.php?/topic/3676-skyrim-information-baked-into-saves/page-2#entry145986 the replies], though.
* [http://afkmods.iguanadons.net/index.php?/topic/3676-skyrim-information-baked-into-saves/page-3#entry147426 "Scripts that are fragments for packages never go away, and seem to begin executing on a None package with no conditions."]
* [http://afkmods.iguanadons.net/index.php?/topic/3676-skyrim-information-baked-into-saves/page-3#entry147426 "Scripts that are fragments for packages never go away, and seem to begin executing on a None package with no conditions."]
* [http://afkmods.iguanadons.net/index.php?/topic/3676-skyrim-information-baked-into-saves/page-3#entry147468 Reportedly,] Skyrim will actually write to your save file when loading it, if it detects that a new mod with script content has been added. (Those scripts will be baked into the save.) This has significant ramifications for testing out script-based mods (to see if you should keep them), and for making "clean saves."
* [http://afkmods.iguanadons.net/index.php?/topic/3694-disabling-persistent-references-a-remarkable-solution/ Apparently, one can disable a persistent reference using a method discussed here.]
* [http://afkmods.iguanadons.net/index.php?/topic/3694-disabling-persistent-references-a-remarkable-solution/ Apparently, one can disable a persistent reference using a method discussed here.]
* [http://forums.bethsoft.com/topic/1513063-tutorial-creating-multithreaded-skyrim-mods/#entry23874487 Given a Script A with an OnInit event that calls functions on Script B, those function calls will be permitted to call other functions on Script A -- an exception to the usual behavior, where an object is locked down until its OnInit has finished.]
* You cannot use [[PlaceAtMe - ObjectReference|PlaceAtMe]] to spawn a [[Map Marker|MapMarker]]. The call will return None.


=== Unsorted edge-cases ===
=== Unsorted edge-cases ===
* Be careful about handling things OnCellAttach and OnCellDetach in Riften. [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-8#entry150257 The city's walkways have you cross back and forth across a cell boundary.]
* Be careful about handling things OnCellAttach and OnCellDetach in Riften. [http://afkmods.iguanadons.net/index.php?/topic/3781-the-critter-thread/page-8#entry150257 The city's walkways have you cross back and forth across a cell boundary.]
** ''The use case dealt with here involves deleting critters when you leave their containing cells. The scripter's attempted solution was to add a timed delay (using OnUpdateGameTime) to the deletion. Return to the cell before the timer has elapsed, and the critter is reused -- the deletion is canceled.''
** ''The use case dealt with here involves deleting critters when you leave their containing cells. The scripter's attempted solution was to add a timed delay (using OnUpdateGameTime) to the deletion. Return to the cell before the timer has elapsed, and the critter is reused -- the deletion is canceled.''
* If an NPC is attempting to use their Activate package on a Furniture, but is killed before they reach the Furniture, then [http://forums.bethsoft.com/topic/1513844-isfurnitureinuse-is-true-if-actor-died-before-activating-it/ the Furniture will remain reserved].
** An acceptable workaround is to use a Travel package to bring your NPC within activation range of the Furniture, and ''then'' run an Activate package. This method may allow other NPCs to snatch the Furniture out from under you, but it prevents indefinite reservations if your NPC dies.
** Known events that will release a dead NPC's reservation:
*** Enabling and disabling the reserving NPC
*** The player using the furniture themselves
*** The player using the Wait function
* You may run into a peculiar problem when passing through a load door: [http://forums.bethsoft.com/topic/1514401-detection-of-null-cells-when-going-through-load-doors-how/#entry23901128 cells that are unloaded by the game can still exist as "valid" Papyrus Cell objects.] They'll be recognized as Cells rather than as Nones, but attempts to call ''most'' native methods on them will fail. Effectively, it's the bizarre difference between something that's ''null'' and something that's ''None''.
* You may run into a peculiar problem when passing through a load door: [http://forums.bethsoft.com/topic/1514401-detection-of-null-cells-when-going-through-load-doors-how/#entry23901128 cells that are unloaded by the game can still exist as "valid" Papyrus Cell objects.] They'll be recognized as Cells rather than as Nones, but attempts to call ''most'' native methods on them will fail. Effectively, it's the bizarre difference between something that's ''null'' and something that's ''None''.
** Surprisingly, <code>kMyBrokenCell.GetFormID()</code> will still return a null cell's proper ID, even though the cell object is broken.
** Surprisingly, <code>kMyBrokenCell.GetFormID()</code> will still return a null cell's proper ID, even though the cell object is broken.
Line 149: Line 62:
* [http://afkmods.iguanadons.net/index.php?/topic/3997-merchant-gold-reset-bug/#entry151915 Reloading a savegame won't reset a merchant's gold.]
* [http://afkmods.iguanadons.net/index.php?/topic/3997-merchant-gold-reset-bug/#entry151915 Reloading a savegame won't reset a merchant's gold.]
* [http://forums.nexusmods.com/index.php?/topic/781746-problems-with-light-sources-flickeringturning-on-and-off/#entry6272032 If too many light sources are around in a single area, then surfaces and objects will flicker between lit and unlit as the camera moves. This is due to an engine limitation.]
* [http://forums.nexusmods.com/index.php?/topic/781746-problems-with-light-sources-flickeringturning-on-and-off/#entry6272032 If too many light sources are around in a single area, then surfaces and objects will flicker between lit and unlit as the camera moves. This is due to an engine limitation.]
** I've had this issue myself. Too many guards with torches walking around in Markarth during the start of The Forsworn Conspiracy. I also run a lighting overhaul, which likely contributes to the issue.


=== Unsorted best practices ===
=== Unsorted best practices ===
Line 157: Line 69:


=== Unsorted lessons ===
=== Unsorted lessons ===
* [http://afkmods.iguanadons.net/index.php?/topic/3863-mgritual04questscript-unendingcontinuous-papyrus-log-errors/ A 10MB Papyrus log.] This, boys and girls, is why you should be careful with update events.
* [http://afkmods.iguanadons.net/index.php?/topic/3863-mgritual04questscript-unendingcontinuous-papyrus-log-errors/ A 10MB Papyrus log.] This is why you should be careful with update events.




Anonymous user
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/981"