CustomContextmenuLib

[KVonGit]

---

Download the library files as a ZIP

CustomContextmenuLib.zip

---

The library files

Click here to view CustomContextmenuLib.aslx

<?xml version="1.0"?>
<!--
  CustomContextmenuLib for Quest 5.8 (and 5.9)
  v1.0.0
-->
<library>
  <!--
    For the parameter, you can use:
    - a string like this: "look/wait/help" or "look,wait,help" or "look;wait;help"
    - a string list
    - a string dictionary, which allows you to choose the text displayed for each command, like:
      
      EXAMPLE: QuickParams("look", "Look", "wait", "Take a break", "help", "HELP ME!")
      
      Or you can use the normal way to create a string dictionary
      
      The key is the command sent, and the value is the text displayed for that command in the contextmenu
  -->
  <function name="CreateCustomContextmenu" parameters="data"><![CDATA[
    JS.eval ("$('#custom-contextmenu').remove();")
    menu = "<div id=\"custom-contextmenu\" class=\"jjmenu bottomOriented\" style=\"display:none; cursor:pointer; position:fixed;\"><span><!--PLACEHOLDER--></span></div>"
    options = NewStringDictionary()
    if (TypeOf(data) = "stringdictionary" or TypeOf(data) = "dictionary") {
      foreach (k, data) {
        DictionaryAdd (options, Replace(k, " ", "___SPACE___"), DictionaryItem(data,k))
      }
    }
    else if (TypeOf(data) = "string") {
      delimiters = Split("/_,_;","_")
      delimiter = ","
      foreach (d, delimiters) {
        if (Instr(data, d) > 0) {
          delimiter = d
        }
      }
      cmds = Split(data, delimiter)
      foreach (cmd, cmds) {
        dictionary add (options, Replace(cmd, " ", "___SPACE___"), CapFirst(cmd))
      }
    }
    else if (TypeOf(data) = "stringlist") {
      foreach (cmd, data) {
        dictionary add (options, Replace(cmd, " ", "___SPACE___"), CapFirst(cmd))
      }
    }
    else {
      CreateCustomContextmenu (game.contextmenucommands)
      return ("start over and use default")
    }
    menuitems = NewStringList()
    foreach (option, options) {
      cmd = option
      displayed_text = DictionaryItem(options, option)
      menuitem = "<div class=\"jj_menu_item\" onmouseover=\"$(this).addClass(&quot;jj_menu_item_hover&quot;);\" onmouseout=\"$(this).removeClass(&quot;jj_menu_item_hover&quot;)\"><span name=\"" + cmd + "\" onclick=\"$(&quot;#custom-contextmenu&quot;).hide(); sendCommand($(this).attr(&quot;name&quot;).replace(/___SPACE___/g,&quot; &quot;))\">" + displayed_text + "</span></div>"
      list add (menuitems, menuitem)
    }
    custom_context_menu = Replace (menu, "<!--PLACEHOLDER-->", Join(menuitems, ""))
    JS.createCustomContextmenu (custom_context_menu)
  ]]></function>
  
  <javascript src="customContextmenu.js" />
  
</library>

---

Click here to view customContextmenu.js

function createCustomContextmenu(menu){
  overrideContextMenuClick = function(e) {
    if (!e) e = window.event;
    if (e.type && e.type == 'contextmenu') {
      $('div.jjmenu').hide();
      if($('#gamePanesFinished').css('display') != 'block'){
        customContextMenu(e);
      }
      else {
        return false;
      }
    }
    else if ((e.button && e.button == 2) || (e.which && e.which == 3)) {
      return false;
    }
    else {
      return true;
    }
  };
  window.document.oncontextmenu = overrideContextMenuClick;
  $('body').append($(menu));
  var customContextMenu = function(e){
    $('#custom-contextmenu').show().css('left',e.x).css('top',e.y);
    e.preventDefault();
    return true;
  };
  document.onclick = function(){
    $('#custom-contextmenu').hide();
  };
}

---

How to use it

Add the library to your game. ¹

Create game.contextmenucommands for your menu's items. ²

For game.contextmenucommands, you can use:

• a string like this: "look/wait/help" or "look,wait,help" or "look;wait;help"
• a string list
• a string dictionary, which allows you to choose the text displayed for each command
  • The key is the command sent, and the value is the text displayed for that command in the contextmenu

Important

Be sure to add this to game.inituserinterface! ³

      if (not HasAttribute(game, "contextmenucommands")) {
        // If game.contextmenucommands exists in the game's code, this will have no effect.
        // If it does not, the next line is a safety catch, and it can be modified here to customize the choices.
        game.contextmenucommands = "look,save,help,inventory"
      }
      CreateCustomContextmenu (game.contextmenucommands)

---

Example Game

Play or download

https://textadventures.co.uk/games/view/656ev17sr0unwhvsfd_1aw/custom-contextmenu-example

The code

Click here to view Custom Contextmenu Example.aslx

<!--Saved by Quest 5.8.6836.13983-->
<asl version="580">
  <include ref="English.aslx" />
  <include ref="Core.aslx" />
  <include ref="CustomContextmenuLib.aslx" />
  <game name="Custom Contextmenu Example">
    <gameid>9df888a4-8fc9-4460-84d8-58be11b39de8</gameid>
    <version>0.0.1</version>
    <firstpublished>2024</firstpublished>
    <author>Quest 5 Examples</author>
    <description>Example game</description>
    <inituserinterface type="script">
      // This needs to be here, not in the start script!
      if (not HasAttribute(game, "contextmenucommands")) {
        // If game.contextmenucommands exists in the game's code, this will have no effect.
        // If it does not, the next line can be modified to customize the choices.
        game.contextmenucommands = "look,save,help,inventory"
      }
      CreateCustomContextmenu (game.contextmenucommands)
    </inituserinterface>
  </game>
  <object name="room">
    <inherit name="editor_room" />
    <isroom />
    <object name="player">
      <inherit name="editor_object" />
      <inherit name="editor_player" />
    </object>
  </object>
</asl>

---

Original idea by @Pertex

Much thanks to Davy B for all his contributions!

Footnotes

1. How to Add a Library to Your Game ↩

2. Optionally, you could just modify this line in game.inituserinterface to customize your menu items: game.contextmenucommands = "look,save,help,inventory" ↩

3. Advanced game scripts ↩