Difference between revisions of "Creating a Mannequin"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Pufthemajicdragon
(→‎Known Issues: Updated details about wandering mannequins)
imported>DavidJCobb
(Some modifications. The correction to Known Issues is based on a reading of the vanilla mannequin script. Can't preview this edit because the site CAPTCHA is breaking the preview function (nice bloody job on that, Google).)
Line 10: Line 10:


Before you begin, it's helpful to know that there are three components that go into creating a functioning mannequin:
Before you begin, it's helpful to know that there are three components that go into creating a functioning mannequin:
* ''PlayerHouseMannequin''
* ''PlayerHouseMannequin'' (Actor)
* ''XMarkerHeading''
* ''XMarkerHeading'' (Static)
* ''MannequinActivateTrig''
* ''MannequinActivateTrig''


First, add a ''PlayerHouseMannequin'' to the space. It can be located under ''Actors/Actor''
To add all of the required pieces, start by adding your ''PlayerHouseMannequin'' to the space. Then, place your ''XMarkerHeading'' next to the ''PlayerHouseMannequin'', but not on top of it; and rotate the ''XMarkerHeading'' to face the same direction that your mannequin should face.
Second, add the ''XMarkerHeading'' next to the 'PlayerHouseMannequin'.  Place it next to the mannequin, but not on top.
 
Third, with the ''PlayerHouseMannequin'' selected, click the ''Create Trigger'' button on the toolbar.  The icon looks like a cube with a "T" on the front of it. In the Filter box at the top of the Triggers window, type in ''Mann'' to search for the mannequin trigger.  Select the ''MannequinActivateTrig'' and and choose '''OK'''.  This will add the required trigger to the mannequin.
Finally, select the ''PlayerHouseMannequin'' and click the Create Trigger button on the toolbar (that is, the button whose icon is a cube with a "T" in front of it). This will open the Triggers window. In that window, select ''MannequinActivateTrig'' (you can use the "Filter" box to search for it) and click "OK."
You now have all the components necessary.
 
Once all of the needed pieces are in your cell, they have to be set up.


Editing the PlayerHouseMannequin:
Editing the PlayerHouseMannequin:
* Double click the ''PlayerHouseMannequin'' to open the edit window. Careful to not accidentally double click the ''MannequinActivateTrig'' box that surrounds the mannequin, usually the mannequin's hands stick out from the box and can be selected by double clicking on the exposed hands.
* Double click the ''PlayerHouseMannequin'' to open the edit window. (Be careful to not accidentally double click the ''MannequinActivateTrig'' box that surrounds the mannequin. If you have trouble, you can use the Cell View window to find the mannequin actor, right-click its listing, and select "Edit.")
** Choose the '''Linked Ref''' tab, right click in the empty field, and choose '''new'''.  The ''Choose Reference'' window will open, choose '''Select Reference in Render Window'''. Then double click the ''XMarkerHeading'', and choose '''OK'''.
** Choose the '''Linked Ref''' tab, right click in the empty field, and then choose '''new'''.  The ''Choose Reference'' window will open; choose '''Select Reference in Render Window'''. Then double click the ''XMarkerHeading'' in the render window, and choose '''OK'''.
** Choose the '''Activate Parents''' tab and right click in the empty field, and choose '''new'''.  The 'Choose Reference' window will open, choose '''Select Reference in Render Window'''.  Then double click the ''MannequinActivateTrig'' box that surrounds the mannequin, and choose '''OK'''.  Check the box marked '''Parent Activate Only''' and then close the edit window by choosing '''OK'''.
** Choose the '''Activate Parents''' tab, right click in the empty field, and choose '''new'''.  The 'Choose Reference' window will open; choose '''Select Reference in Render Window'''.  Then double click the ''MannequinActivateTrig'' box that surrounds the mannequin, and choose '''OK'''.  Check the box marked '''Parent Activate Only''' and then close the edit window by choosing '''OK'''.


Editing the XMarkerHeading:
Editing the XMarkerHeading:
* Double click the ''XMarkerHeading'' object to open the edit window.
* Double click the ''XMarkerHeading'' object to open the edit window.
** Choose the '''Linked Ref''' tab, right click in the empty field, and choose '''new'''.  The ''Choose Reference'' window will open, choose '''Select Reference in Render Window'''.  Then double click the ''PlayerHouseMannequin'', and choose '''OK'''.  Choose '''OK''' again to close the edit window.
** Choose the '''Linked Ref''' tab, right click in the empty field, and choose '''new'''.  The ''Choose Reference'' window will open; choose '''Select Reference in Render Window'''.  Then double click the ''PlayerHouseMannequin'', and choose '''OK'''.  Choose '''OK''' again to close the edit window.


Editing the MannequinActivateTrig
Editing the MannequinActivateTrig
Line 32: Line 33:
** Choose the '''Primitive''' tab and check the box marked '''Player Activation'''.  Choose '''OK''' to close the edit window.
** Choose the '''Primitive''' tab and check the box marked '''Player Activation'''.  Choose '''OK''' to close the edit window.


The last step is to select the ''XMarkerHeading'' and physically drag it on top of the ''PlayerHouseMannequin'' and ''MannequinActivateTrig'' so that the mannequin is centered inside the XMarkerHeading box.
The last step is to select the ''XMarkerHeading'' and physically drag it on top of the ''PlayerHouseMannequin'' and ''MannequinActivateTrig'', so that the mannequin is centered inside the XMarkerHeading box.


The process is complete.
The process is complete.
Line 39: Line 40:
* If the Mannequin seems to be alive and freeze in a strange pose after you leave the inventory, just leave the room (cell) and come back. <------- *Temporary fix*
* If the Mannequin seems to be alive and freeze in a strange pose after you leave the inventory, just leave the room (cell) and come back. <------- *Temporary fix*


* For an unknown reason, the mannequins don't work properly when facing "North" of the cell.  Rotating the mannequin even a fraction of a degree in another direction seems to fix the issue.
* For an unknown reason, the mannequins don't work properly when facing "North" of the cell.  Rotating the mannequin even a fraction of a degree in another direction seems to fix the issue.{{citation needed}}


* It was mentioned previously that the Mannequins will face the direction of the XMarker irrespective of the direction of the Trigger or the Mannequin. Using version 1.9.32 of the CK this result did not happen in game.  Instead when rotating the Mannequin and the Trigger 90 degrees from 0, that is they way they faced even though the XMarker was only rotated 1 degree from 0.
* When you visit the mannequin's containing cell in-game, the mannequin will be moved to your XMarkerHeading. If your XMarkerHeading is facing in the wrong direction, then the mannequin may end up facing the wrong way, too. For best results, be sure to match the actor and the marker's rotations.


* Mannequins may wander if there is now navmesh under them. Even with a navmesh, there is still a chance that they may wander or change poses before the script can disable their AI. This can be mitigated by creating a navmesh "island" under the mannequin, isolated from the rest of the cell's navmesh.
* Mannequins may wander if there is now navmesh under them. Even with a navmesh, there is still a chance that they may wander or change poses before the script can disable their AI. This can be mitigated by creating a navmesh "island" under the mannequin, isolated from the rest of the cell's navmesh.
Line 47: Line 48:
* If the XMarkerHeading for the mannequin is the last XMarker to be placed in the cell, when the cell loads in game NPCs may load on that marker. This will cause them to load in the same place as the mannequin and be unable to move. This can be prevented by editing or placing another XMarker in the cell ''after'' modifying the XMarkerHeading for the mannequin.
* If the XMarkerHeading for the mannequin is the last XMarker to be placed in the cell, when the cell loads in game NPCs may load on that marker. This will cause them to load in the same place as the mannequin and be unable to move. This can be prevented by editing or placing another XMarker in the cell ''after'' modifying the XMarkerHeading for the mannequin.


* It is also helpful to snap the MannequinActivateTrig to the PlayerHouseMannequin then snap the XMarkerHeading to the MannequinActivateTrig.  (Unconfirmed)
* After placing/adding a PlayerHouseMannequin, MannequinActivateTrig, and XMarkerHeading to the space you can't activate it in game.  With version 1.9.32 of the CK it was possible to fix this issue.  If your mannequin would normally be rotated 0, 90, 180, or 270 degrees, try rotating the XMarkerHeading 1 degree greater then the original rotation.  Then have the PlayerHouseMannequin and the MannequinActivateTrig rotated 1 degree less then then the original rotation.  Then go to the MannequinActivateTrig -> Primitive tab and, set the Bounds to (X) 67, (Y) 42, (Z) 141.
 
* After placing/adding a PlayerHouseMannequin, MannequinActivateTrig, and XMarkerHeading to the space you can't activate it in game.  With version 1.9.32 of the CK it was possible to fix this issue.  If your manequin would normally be rotated 0, 90, 180, or 270 degrees, try rotating the XMarkerHeading 1 degree greater then the original rotation.  Then have the PlayerHouseMannequin and the MannequinActivateTrig rotated 1 degree less then then the original rotation.  Then go to the MannequinActivateTrig -> Primitive tab and, set the Bounds to (X) 67, (Y) 42, (Z) 141.


== External Links ==
== External Links ==

Revision as of 19:40, 22 April 2016

Mannequins are a convenient and visually pleasant way for the player to store armor. This tutorial will show you how to add a mannequin to your mod.

Adding Your Mannequin

  • From the Object Window, drag PlayerHouseMannequin and XMarkerHeading into the Render Window with the desired cell loaded.
    • PlayerHouseMannequin > Under Actors\Actor.
    • XMarkerHeading > Under WorldObjects\Static

Setting up the Mannequin

Before you begin, it's helpful to know that there are three components that go into creating a functioning mannequin:

  • PlayerHouseMannequin (Actor)
  • XMarkerHeading (Static)
  • MannequinActivateTrig

To add all of the required pieces, start by adding your PlayerHouseMannequin to the space. Then, place your XMarkerHeading next to the PlayerHouseMannequin, but not on top of it; and rotate the XMarkerHeading to face the same direction that your mannequin should face.

Finally, select the PlayerHouseMannequin and click the Create Trigger button on the toolbar (that is, the button whose icon is a cube with a "T" in front of it). This will open the Triggers window. In that window, select MannequinActivateTrig (you can use the "Filter" box to search for it) and click "OK."

Once all of the needed pieces are in your cell, they have to be set up.

Editing the PlayerHouseMannequin:

  • Double click the PlayerHouseMannequin to open the edit window. (Be careful to not accidentally double click the MannequinActivateTrig box that surrounds the mannequin. If you have trouble, you can use the Cell View window to find the mannequin actor, right-click its listing, and select "Edit.")
    • Choose the Linked Ref tab, right click in the empty field, and then choose new. The Choose Reference window will open; choose Select Reference in Render Window. Then double click the XMarkerHeading in the render window, and choose OK.
    • Choose the Activate Parents tab, right click in the empty field, and choose new. The 'Choose Reference' window will open; choose Select Reference in Render Window. Then double click the MannequinActivateTrig box that surrounds the mannequin, and choose OK. Check the box marked Parent Activate Only and then close the edit window by choosing OK.

Editing the XMarkerHeading:

  • Double click the XMarkerHeading object to open the edit window.
    • Choose the Linked Ref tab, right click in the empty field, and choose new. The Choose Reference window will open; choose Select Reference in Render Window. Then double click the PlayerHouseMannequin, and choose OK. Choose OK again to close the edit window.

Editing the MannequinActivateTrig

  • Double click the MannequinActivateTrig object to open the edit window.
    • Choose the Primitive tab and check the box marked Player Activation. Choose OK to close the edit window.

The last step is to select the XMarkerHeading and physically drag it on top of the PlayerHouseMannequin and MannequinActivateTrig, so that the mannequin is centered inside the XMarkerHeading box.

The process is complete.

Known Issues

  • If the Mannequin seems to be alive and freeze in a strange pose after you leave the inventory, just leave the room (cell) and come back. <------- *Temporary fix*
  • For an unknown reason, the mannequins don't work properly when facing "North" of the cell. Rotating the mannequin even a fraction of a degree in another direction seems to fix the issue.Template:Citation needed
  • When you visit the mannequin's containing cell in-game, the mannequin will be moved to your XMarkerHeading. If your XMarkerHeading is facing in the wrong direction, then the mannequin may end up facing the wrong way, too. For best results, be sure to match the actor and the marker's rotations.
  • Mannequins may wander if there is now navmesh under them. Even with a navmesh, there is still a chance that they may wander or change poses before the script can disable their AI. This can be mitigated by creating a navmesh "island" under the mannequin, isolated from the rest of the cell's navmesh.
  • If the XMarkerHeading for the mannequin is the last XMarker to be placed in the cell, when the cell loads in game NPCs may load on that marker. This will cause them to load in the same place as the mannequin and be unable to move. This can be prevented by editing or placing another XMarker in the cell after modifying the XMarkerHeading for the mannequin.
  • After placing/adding a PlayerHouseMannequin, MannequinActivateTrig, and XMarkerHeading to the space you can't activate it in game. With version 1.9.32 of the CK it was possible to fix this issue. If your mannequin would normally be rotated 0, 90, 180, or 270 degrees, try rotating the XMarkerHeading 1 degree greater then the original rotation. Then have the PlayerHouseMannequin and the MannequinActivateTrig rotated 1 degree less then then the original rotation. Then go to the MannequinActivateTrig -> Primitive tab and, set the Bounds to (X) 67, (Y) 42, (Z) 141.

External Links