View source for Enhanced Client Custom Actions

This is a walkthrough for creating custom actions in the Ultima Online Enhanced Client.

For this mod we will add an art file and make four edits in three files, which combined will add an "Exit" button to the EC crafting actions, allowing us to exit the crafting menu via keystroke or macro.



[[Enhanced Client Custom Mods |Read here]] for a walkthrough on setting up Mod directory structure.

To begin creating this mod we will setup our directory structure as follows, by creating folders and copying files from the Default folder (We will add Exit.dds to the Actions folder in the next step):
<gallery>
CustomActionDirectoryStructure.jpg |Custom Action Directory Structure
</gallery>


Next, we will need new art for the Exit button. The following image is a .png, which you can download and covert to the .dds format required by the EC via GIMP's "Export As" feature.
[[File:exit.png]]
Once converted to .dds, add the image to MyCustomUI>Icons>Actions. At this point, the file structure should look exactly as it does in the directory structure picture above.





Now we will begin editing files to create the functionality for the Exit button. First let's tell the client we have new art by editing Icons.xml. We will add the code
     <Icon id="876007" texture="Icons/actions/exit.dds" name="Exit" />
to the "Crafting Utilities" block of the file, after the line for the Make Last button.
<gallery>
CustomActionIconsXMLDefault.jpg |Icons.xml default
CustomActionIconsXMLModded.jpg |Icons.xml modded
</gallery>


We will now make two edits to ActionsWindow.lua, to call our new icon into the Actions menu. The first will be to function ActionsWindow.InitActionData(), ActionsWindow.ActionData section, Crafting Utilities sub-section, just after the instructions for Make Last. In this location, add the code
   ActionsWindow.ActionData[6007] = { type=SystemData.UserAction.TYPE_SPEECH_USER_COMMAND, inActionWindow=true, iconId=876007, detailString=L"Close the crafting menu.", nameString=L"Exit",  callback=L"script Actions.Exit()" }
<gallery>
CustomActionActionsWindowDataDefault.jpg |ActionData Default
CustomActionActionsWindowDataModded.jpg |ActionData Modded
</gallery>


The second edit to ActionsWindow.lua will also be to function ActionsWindow.InitActionData(), this time to the .Groups[23] section. Here we will add ", 6007" to the end of the list. You must remember the comma to separate 6006, 6007. The entire line of code will look like this before modding
   ActionsWindow.Groups[23] = { nameString=GetStringFromTid(1155372),		index={ 6000, 6001, 6002, 6003, 6004, 6005, 6006} }

and like this after modding
   ActionsWindow.Groups[23] = { nameString=GetStringFromTid(1155372),		index={ 6000, 6001, 6002, 6003, 6004, 6005, 6006, 6007 } }
<gallery>
CustomActionActionsWindowGroupDefault.jpg |Groups Default
CustomActionActionsWindowGroupModded.jpg |Groups Modded
</gallery>


We will make our fourth and final code edit to the file Actions.lua. This will install the functionality so that the Exit button will know what to do when we click on it. At the end of Actions.lua, after the function for Make Last, add the following code
   function Actions.Exit()
    local gumpID = 460
     if GumpData.Gumps[gumpID].windowName and DoesWindowNameExist(GumpData.Gumps[gumpID].windowName) then
      local windowName = GumpData.Gumps[gumpID].windowName
      DestroyWindow(GumpData.Gumps[gumpID].windowName)
      GumpsParsing.ParsedGumps[gumpID] = nil
      GumpsParsing.ToShow[gumpID] = nil
      GenericGump.GumpsList[windowName] = nil
     else
      GumpsParsing.ParsedGumps[gumpID] = nil
      GumpsParsing.ToShow[gumpID] = nil
      GenericGump.GumpsList[windowName] = nil
     end
   end
<gallery>
CustomActionActionsDefault.jpg |Actions Default
CustomActionActionsModded.jpg |Actions Modded
</gallery>


That's it. We are finished with editing. Remember to save your file(s) and select MyCustomUI at login. Once in game, open Menu>Actions and the new Exit button will be available for use, just as any other button.
<gallery>
CustomActionComplete.jpg
</gallery>

If you would like to add the Exit button to your available macro icons, [[Enhanced Client Custom Icons |read here]].

With this information you should now be able to create all kinds of Actions and organize them as you see fit.

Enjoy!




====See Also====
*[[Enhanced Client Mod List]]
*[[Enhanced Client Modding]]