From 19e5fa4e20803cd54619dd5ece54114e93329bfa Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sun, 13 Apr 2025 13:28:01 -0500 Subject: [PATCH 01/41] macros for embedding commands & datatypes on a page --- main.py | 280 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 279 insertions(+), 1 deletion(-) diff --git a/main.py b/main.py index b5aa96f4d..fac37dbe5 100644 --- a/main.py +++ b/main.py @@ -1,3 +1,6 @@ +import re +from pathlib import Path, PurePosixPath + def define_env(env): @env.macro @@ -14,4 +17,279 @@ def renderMember(name, type=None, params=None, toc_label=None): if toc_label is None: toc_label = f'{name}{params_str}' - return f"{type_str} `{name}{params_str}` {{ #{toc_label} data-toc-label='{toc_label}' }}" \ No newline at end of file + return f"{type_str} `{name}{params_str}` {{ #{toc_label} data-toc-label='{toc_label}' }}" + + @env.macro + def embedCommand(command_file): + data = parse_command_file(command_file) + + doc_url = data.get("doc_url", "#") + syntax_content = data.get("syntax_content") + is_codeblock = data.get("is_codeblock", False) + lexer = data.get("lexer", "") + full_description = data.get("full_description", "") + has_more_content = data.get("has_more_content", False) + + syntax = f'⚠️ Syntax missing' + if syntax_content: + if is_codeblock: + lexer_str = lexer or '' + syntax = f'\n```{lexer_str}\n{syntax_content}\n```\n' + else: + syntax = f'{syntax_content}' + + # Format Description (add "read more" link if it's long) + formatted_description = "" + if full_description: + description = full_description + read_more_link = f' [:material-book-arrow-right-outline:]({doc_url})' + max_description_length = 280 + if len(description) > max_description_length: + # Find a space between words before cutting off a long description + break_point = description.rfind(' ', 0, max_description_length - len(read_more_link) - 3) + if break_point == -1: + break_point = max_description_length - len(read_more_link) - 3 + formatted_description = description[:break_point] + '...' + read_more_link + elif has_more_content: + formatted_description = description + read_more_link + else: + formatted_description = description + + return f"{syntax}\n: {formatted_description}" + + @env.macro + def embedMQType(doc_file): + data = parse_mq_type(doc_file) + + doc_url = data.get("doc_url", "#") # the default URL is a same page link + name = data.get("name", "Unknown Type") + description = data.get("description", "No description available.") + members = data.get("members", []) + link_refs = data.get("link_refs", []) + + members_table = "" + if members: + members_table = "\n\n" + render_members_table(members, link_refs) + "\n\n" + + link_refs_part = "" + if link_refs: + formatted_links = "\n".join([f"[{ref_name}]: {ref_url}" for ref_name, ref_url in link_refs]) + link_refs_part = f"\n\n{formatted_links}" + + # Add read more link only if description exists + read_more_indicator = f" [:material-book-arrow-right-outline:]({doc_url})" if description else "" + + result = ( + f"### [`{name}`]({doc_url})\n\n" + f"{description}{read_more_indicator}\n\n" + f"{members_table}" + f"{link_refs_part}" + ) + + return result + +# == Helper functions == + +def parse_command_file(command_file): + """ + Parse command file for syntax and description. + """ + try: + content = Path(command_file).read_text() + base_dir = Path(command_file).parent + doc_url = make_content_link(command_file) + except FileNotFoundError: + return { + "doc_url": "#", + "syntax_content": "Error: File not found", + "lexer": "", + "is_codeblock": False, + "full_description": "", + "has_more_content": False, + } + + syntax_content = None + lexer = "" + is_codeblock = False + full_description = "" + has_more_content = False + + # Extract syntax (and lexer) that's in a code block so we can render the link correctly. + syntax_match = re.search( + r'## Syntax\s*\n\s*```(\w+)?\s*\n(.*?)\n```', + content, re.DOTALL + ) + if syntax_match: + is_codeblock = True + lexer = syntax_match.group(1) or "" + syntax_content = syntax_match.group(2).strip() + else: + # Extract syntax that's not in a code block, which is much simpler to render: + syntax_match = re.search( + r'## Syntax\s+\n+(.+?)(?=\n\n|\n##)', + content, re.DOTALL + ) + if syntax_match: + syntax_content = syntax_match.group(1).strip() + + # Extract first paragraph of description (before any subsections) + description_match = re.search( + r'## Description\s+\n+(.*?)(?=\n\n\*\*|\n##|$)', + content, re.DOTALL + ) + if description_match: + description_text = description_match.group(1).strip() + # Convert links and collapse whitespace + full_description = convert_relative_links(description_text, base_dir) + full_description = re.sub(r'\s*\n\s*', ' ', full_description) + # Check if there's more content after the description paragraph + remaining_content = content[description_match.end():] + if re.search(r'\n\n\*\*|\n##', remaining_content): + has_more_content = True + + return { + "doc_url": doc_url, + "syntax_content": syntax_content, + "lexer": lexer, + "is_codeblock": is_codeblock, + "full_description": full_description, + "has_more_content": has_more_content, + } + +def parse_mq_type(doc_file): + """ + Extract information from a TLO or datatype file + """ + try: + content = Path(doc_file).read_text() + doc_path = Path(doc_file) + base_dir = doc_path.parent + doc_url = make_content_link(doc_file) + except FileNotFoundError: + return { + "name": "Error: File not found", + "description": "", + "section_name": "", + "members": [], + "link_refs": [], + "doc_url": "#", + } + + # Initialize variables with default values + name = "" + description = "" + section_name = "" + members = [] + link_refs = [] # Initialize link_refs as an empty list + + # Extract the name from the top of the page. + name_match = re.search(r'# `(.+?)`', content) + if name_match: + name = name_match.group(1) + + # Extract the description as the first paragraph after the header. + desc_match = re.search(r'# `.+?`\s*\n+(.*?)(?=\n\n|\n##|$)', content, re.DOTALL) + if desc_match: # Check if match was found + description_text = desc_match.group(1).strip() + description = re.sub(r'\s*\n\s*', ' ', description_text) + description = convert_relative_links(description, base_dir) + + # Extract the Members or Forms section. Stops when a new level-2 header (##) appears. + section_match = re.search(r'## (Forms|Members)\s*\n+(.*?)(?=\n##(?!#)|$)', content, re.DOTALL) + if section_match: + section_name = section_match.group(1) + raw_section_content = section_match.group(2).strip() + # Parse out the individual member definitions. + members = parse_render_members(raw_section_content, base_dir) + + # Process link references using helper + link_ref_matches = re.findall(r'^\[([^\]]+)\]:\s*(.+?)(?:\s*)$', content, re.MULTILINE) + for ref_name, ref_url in link_ref_matches: + if ref_url.endswith('.md'): # Only process .md links + try: + absolute_ref = make_content_link(ref_url, base_dir) + link_refs.append((ref_name, absolute_ref)) + except Exception as e: + print(f"Warning: Could not process link ref [{ref_name}]: {ref_url} in {doc_file}. Error: {e}") + + return { + "name": name, + "description": description, + "section_name": section_name, + "members": members, + "link_refs": link_refs, + "doc_url": doc_url, + } + +def parse_render_members(raw_content, base_dir): + """ + parse renderMember macro calls for member info. + """ + # Pattern captures the parameters inside renderMember and then the description + pattern = r"###\s*\{\{\s*renderMember\s*\((.*?)\)\s*\}\}\s*\n\s*\:\s*(.*?)(?=\n###|\Z)" + matches = re.findall(pattern, raw_content, re.DOTALL) + + members = [] + for params_str, description in matches: + # Capture key='value' pairs from the renderMember call. + kv_pattern = r"(\w+)\s*=\s*'([^']+)'" + kv_pairs = re.findall(kv_pattern, params_str) + params = {k: v for k, v in kv_pairs} + + member_name = params.get("name", "").strip() + member_type = params.get("type", "").strip() + members.append({ + "name": member_name, + "type": member_type, + "description": convert_relative_links(description.strip(), base_dir) + }) + return members + +def make_content_link(file_path, base_dir=None): + """ + Convert a file path to mkdocs url + - (when base_dir=None): "commands/foo.md" → "/commands/foo/" + - (with base_dir): "../datatypes/bar.md" → "/datatypes/bar/" + """ + if base_dir: + # For relative links within embedded content + full_path = PurePosixPath(base_dir / file_path) + else: + # For main document (embed-er) links + full_path = PurePosixPath(file_path) + + return f"/{full_path.with_suffix('')}/" + +def convert_relative_links(content, base_dir): + """ + Convert relative links to absolute links for embedded content + """ + def replace_link(match): + text = match.group(1) + rel_path = match.group(2) + return f"[{text}]({make_content_link(rel_path, base_dir)})" + + return re.sub( + r'\[([^\]]+)\]\(([^\)]+\.md)\)', + replace_link, + content + ) + +def render_members_table(members, link_refs): + """ + Use members and link_refs to create a markdown table. + """ + lines = [ + "| Type | Member | Description |", + "| ---- | ------ | ----------- |" + ] + # Convert link_refs to a dictionary for easier lookup + link_dict = {ref_name: ref_url for ref_name, ref_url in link_refs} + for m in members: + type_val = m["type"] + if type_val in link_dict: + type_rendered = f"[{type_val}]({link_dict[type_val]})" + else: + type_rendered = type_val + lines.append(f"| {type_rendered} | `{m['name']}` | {m['description']} |") + return "\n".join(lines) \ No newline at end of file From b5ae621a824ce64a1aad90c3a27b51e0ec26b040 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sun, 13 Apr 2025 15:11:50 -0500 Subject: [PATCH 02/41] convert autologin to use embed macros --- mkdocs.yml | 3 +- .../autologin/datatype-autologin.md | 27 +++++++++ .../autologin/datatype-loginprofile.md | 58 +++++++++++++++++++ .../{mq2autologin.md => autologin/index.md} | 27 ++++----- plugins/core-plugins/autologin/loginchar.md | 22 +++++++ plugins/core-plugins/autologin/relog.md | 15 +++++ plugins/core-plugins/autologin/switchchar.md | 15 +++++ .../core-plugins/autologin/switchserver.md | 15 +++++ .../core-plugins/autologin/tlo-autologin.md | 21 +++++++ 9 files changed, 189 insertions(+), 14 deletions(-) create mode 100644 plugins/core-plugins/autologin/datatype-autologin.md create mode 100644 plugins/core-plugins/autologin/datatype-loginprofile.md rename plugins/core-plugins/{mq2autologin.md => autologin/index.md} (88%) create mode 100644 plugins/core-plugins/autologin/loginchar.md create mode 100644 plugins/core-plugins/autologin/relog.md create mode 100644 plugins/core-plugins/autologin/switchchar.md create mode 100644 plugins/core-plugins/autologin/switchserver.md create mode 100644 plugins/core-plugins/autologin/tlo-autologin.md diff --git a/mkdocs.yml b/mkdocs.yml index 0fa5511d0..e5da7e8c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -77,7 +77,7 @@ nav: - Core Plugins: - plugins/core-plugins/README.md - - MQ2AutoLogin: plugins/core-plugins/mq2autologin.md + - AutoLogin: plugins/core-plugins/autologin/index.md - MQ2Bzsrch: - plugins/core-plugins/mq2bzsrch/README.md @@ -635,6 +635,7 @@ plugins: redirect_maps: 'main/submodule-quick-list.md': 'main/plugin-quick-list.md' 'reference/general/combatstate.md': 'reference/data-types/datatype-character#CombatState' + 'plugins/core-plugins/mq2autologin.md': 'plugins/core-plugins/autologin/index.md' - tags: tags_file: tags.md diff --git a/plugins/core-plugins/autologin/datatype-autologin.md b/plugins/core-plugins/autologin/datatype-autologin.md new file mode 100644 index 000000000..b803d32fd --- /dev/null +++ b/plugins/core-plugins/autologin/datatype-autologin.md @@ -0,0 +1,27 @@ +--- +tags: + - datatype +--- +# `AutoLogin` + +Datatype providing access to AutoLogin status and profile information. + +## Members + +### {{ renderMember(type='bool', name='Active')}} + +: True when actively performing automated login + +### {{ renderMember(type='LoginProfile', name='Profile')}} + +: Displays autologin profile information, also provides access to current profile information ([LoginProfile] type) + +## Examples + +```text +/echo ${AutoLogin.Active} # Check if autologin is running +/echo ${AutoLogin.Profile.Account} # Show account name from profile +``` + +[bool]: ../../../reference/data-types/datatype-bool.md +[LoginProfile]: datatype-loginprofile.md diff --git a/plugins/core-plugins/autologin/datatype-loginprofile.md b/plugins/core-plugins/autologin/datatype-loginprofile.md new file mode 100644 index 000000000..364e783e7 --- /dev/null +++ b/plugins/core-plugins/autologin/datatype-loginprofile.md @@ -0,0 +1,58 @@ +--- +tags: + - datatype +--- +# `LoginProfile` + +Datatype providing access to AutoLogin profile information. + +## Members + +### {{ renderMember(type='string', name='Account')}} + +: Account name associated with the profile + +### {{ renderMember(type='string', name='Character')}} + +: Character name from the profile + +### {{ renderMember(type='string', name='Server')}} + +: Server name from the profile + +### {{ renderMember(type='string', name='Profile')}} + +: Profile group name (if part of a profile group) + +### {{ renderMember(type='string', name='HotKey')}} + +: Hotkey assigned to the profile (if any) + +### {{ renderMember(type='class', name='Class')}} + +: Character's class as shortname, also provides access to class type members. + +### {{ renderMember(type='int', name='Level')}} + +: Character's level + +### {{ renderMember(type='string', name='CustomCharacterIni')}} + +: Custom client INI file path if specified in the profile + +### {{ renderMember(type='string', name='ToString') }} + +: Returns formatted profile info as "Profile: Character (Server)" + +## Examples + +```text +/echo ${AutoLogin.Profile.Account} # Show account name +/echo ${AutoLogin.Profile.Level} # Show character level +/echo ${AutoLogin.Profile} # Show formatted profile info e.g. "MyProfile: MyCharacter (MyServer)" +/echo ${AutoLogin.Profile.Profile} # Show profile name only +``` + +[string]: ../../../reference/data-types/datatype-string.md +[int]: ../../../reference/data-types/datatype-int.md +[class]: ../../../reference/data-types/datatype-class.md diff --git a/plugins/core-plugins/mq2autologin.md b/plugins/core-plugins/autologin/index.md similarity index 88% rename from plugins/core-plugins/mq2autologin.md rename to plugins/core-plugins/autologin/index.md index 2bd7f72b1..b98de17c5 100644 --- a/plugins/core-plugins/mq2autologin.md +++ b/plugins/core-plugins/autologin/index.md @@ -2,7 +2,7 @@ tags: - plugin --- -# MQ2AutoLogin +# AutoLogin ## Description @@ -12,7 +12,7 @@ AutoLogin is a plugin that automatically logs in your characters. It can also sw Right click on your MacroQuest tray icon -Select Profiles->Create New. +Select Profiles->Create New. You'll be asked to enter nine fields: @@ -30,25 +30,26 @@ Upon clicking "Save", your profile will be encrypted and saved in MQ2AutoLogin.i ## Commands -`/switchserver ` +{{ embedCommand('plugins/core-plugins/autologin/loginchar.md') }} -Will log out your current character and log in the specified server/character on the same account. +{{ embedCommand('plugins/core-plugins/autologin/relog.md') }} -`/switchchar ` +{{ embedCommand('plugins/core-plugins/autologin/switchchar.md') }} -Will log out your current character and log in the specified character on the same account/server. +{{ embedCommand('plugins/core-plugins/autologin/switchserver.md') }} -`/loginchar [server:character|profile_server:character|server^login^character^password|server^login^password]` +`END` and `HOME` +: Pressing the "END" key at the character select screen will pause autologin, "HOME" will unpause. -Will open a new EverQuest instance and login the specified character. Example: `/loginchar vox:bobby` +## Top-Level Objects -`/relog [#s|#m]` +{{ embedMQType('plugins/core-plugins/autologin/tlo-autologin.md') }} -Will log character out, and then log back in after specified time. Default time is in seconds. Example: `/relog 5m` +## Datatypes -`END` and `HOME` +{{ embedMQType('plugins/core-plugins/autologin/datatype-autologin.md') }} -Pressing the "END" key at the character select screen will pause autologin, "HOME" will unpause. +{{ embedMQType('plugins/core-plugins/autologin/datatype-loginprofile.md') }} ## INI @@ -178,7 +179,7 @@ EQ Might=[[R] ] EQ Might Project Lazarus=Project Lazarus ``` -## MQ2Login Profiles GUI +## Profiles GUI Right click on the MacroQuest tray icon -> Profiles diff --git a/plugins/core-plugins/autologin/loginchar.md b/plugins/core-plugins/autologin/loginchar.md new file mode 100644 index 000000000..83dd9e1b6 --- /dev/null +++ b/plugins/core-plugins/autologin/loginchar.md @@ -0,0 +1,22 @@ +--- +tags: + - command +--- +# /loginchar + +## Syntax + +```eqcommand +/loginchar [server:character|profile_server:character|server^login^character^password|server^login^password] +``` + +## Description + +Launches a new EverQuest instance and logs in the specified character. e.g. `/loginchar vox:aradune` + +**Examples** +```text +/loginchar vox:aradune +/loginchar drinal^user123^aradune^mypass123 +/loginchar MyProfile_vox:Vaelen +``` \ No newline at end of file diff --git a/plugins/core-plugins/autologin/relog.md b/plugins/core-plugins/autologin/relog.md new file mode 100644 index 000000000..28ecd707e --- /dev/null +++ b/plugins/core-plugins/autologin/relog.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /relog + +## Syntax + +```eqcommand +/relog [<#>s|<#>m] +``` + +## Description + +Logs out the current character and automatically logs back in after 10 seconds or specified delay. e.g. `/relog 5m` for 5 minutes. \ No newline at end of file diff --git a/plugins/core-plugins/autologin/switchchar.md b/plugins/core-plugins/autologin/switchchar.md new file mode 100644 index 000000000..9e2203b27 --- /dev/null +++ b/plugins/core-plugins/autologin/switchchar.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /switchchar + +## Syntax + +```eqcommand +/switchchar +``` + +## Description + +Logs out of the current character and logs back into the specified character on the same server and account. diff --git a/plugins/core-plugins/autologin/switchserver.md b/plugins/core-plugins/autologin/switchserver.md new file mode 100644 index 000000000..776b87c08 --- /dev/null +++ b/plugins/core-plugins/autologin/switchserver.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /switchserver + +## Syntax + +```eqcommand +/switchserver +``` + +## Description + +Logs out of the current character and logs back into the specified server and character using the same account credentials. \ No newline at end of file diff --git a/plugins/core-plugins/autologin/tlo-autologin.md b/plugins/core-plugins/autologin/tlo-autologin.md new file mode 100644 index 000000000..dde273022 --- /dev/null +++ b/plugins/core-plugins/autologin/tlo-autologin.md @@ -0,0 +1,21 @@ +--- +tags: + - tlo +--- +# `AutoLogin` + +Returns "AutoLogin" string when plugin is loaded, provides access to AutoLogin functionality. + +## Forms + +### {{ renderMember(type='AutoLogin', name='AutoLogin') }} + +: Returns "AutoLogin" string when plugin is loaded + +## Example + +```text +/echo ${AutoLogin} # Outputs "AutoLogin" +``` + +[AutoLogin]: datatype-autologin.md From d7909f266db3d03cc9bd7ec683eea6c6fdb1ae73 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 16 Apr 2025 00:06:58 -0500 Subject: [PATCH 03/41] remove description header --- plugins/core-plugins/autologin/index.md | 22 ++++++------- plugins/core-plugins/mq2bzsrch/README.md | 33 ------------------- plugins/core-plugins/mq2chatwnd/README.md | 2 -- plugins/core-plugins/mq2custombinds/README.md | 2 -- plugins/core-plugins/mq2hud/README.md | 2 -- 5 files changed, 10 insertions(+), 51 deletions(-) delete mode 100644 plugins/core-plugins/mq2bzsrch/README.md diff --git a/plugins/core-plugins/autologin/index.md b/plugins/core-plugins/autologin/index.md index b98de17c5..bd7ac07ec 100644 --- a/plugins/core-plugins/autologin/index.md +++ b/plugins/core-plugins/autologin/index.md @@ -4,8 +4,6 @@ tags: --- # AutoLogin -## Description - AutoLogin is a plugin that automatically logs in your characters. It can also switch characters, servers and login new accounts via commandline. It was originally made by [ieatacid](https://macroquest2.com/phpBB3/viewtopic.php?f=50&t=16427). ## Setting up profiles via tray icon @@ -41,16 +39,6 @@ Upon clicking "Save", your profile will be encrypted and saved in MQ2AutoLogin.i `END` and `HOME` : Pressing the "END" key at the character select screen will pause autologin, "HOME" will unpause. -## Top-Level Objects - -{{ embedMQType('plugins/core-plugins/autologin/tlo-autologin.md') }} - -## Datatypes - -{{ embedMQType('plugins/core-plugins/autologin/datatype-autologin.md') }} - -{{ embedMQType('plugins/core-plugins/autologin/datatype-loginprofile.md') }} - ## INI MQ2AutoLogin.ini has the following global settings, @@ -206,3 +194,13 @@ This helps export and import login profiles, which are otherwise hard to decrypt `Launch Clean` Launch single sessions without logging in. + +## Top-Level Objects + +{{ embedMQType('plugins/core-plugins/autologin/tlo-autologin.md') }} + +## Datatypes + +{{ embedMQType('plugins/core-plugins/autologin/datatype-autologin.md') }} + +{{ embedMQType('plugins/core-plugins/autologin/datatype-loginprofile.md') }} \ No newline at end of file diff --git a/plugins/core-plugins/mq2bzsrch/README.md b/plugins/core-plugins/mq2bzsrch/README.md deleted file mode 100644 index 18b762562..000000000 --- a/plugins/core-plugins/mq2bzsrch/README.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2Bzsrch - -## Description - -This plugin adds some bazaar searching functionality. - -## Commands - -**/bzsrch \[params\] \[name\]** - -* **\[params\]** can be one of the following: - * race any\|barbarian\|dark elf\|dwarf\|etc - * class any\|bard\|beastlord\|berserker\|etc - * stat any\|armor class\|agility\|charisma\|etc - * slot any\|ammo\|arms\|back\|charm\|chest\|etc - * type any\|1h slashing\|1h blunt\|2h blunt\|etc - * price -* **\[name\]** is the name or partial name of the item you wish to search for - -## Top-Level Objects - -* [_bazaar_](mq2bzsrch-datatype-bazaar.md) [**Bazaar**](mq2bzsrch-tlo-bazaar.md) - -## Data types - -* [bazaar](mq2bzsrch-datatype-bazaar.md) -* [bazaaritem](mq2bzsrch-datatype-bazaaritem.md) - -## Examples diff --git a/plugins/core-plugins/mq2chatwnd/README.md b/plugins/core-plugins/mq2chatwnd/README.md index 6c38fd6f3..764282bd1 100644 --- a/plugins/core-plugins/mq2chatwnd/README.md +++ b/plugins/core-plugins/mq2chatwnd/README.md @@ -4,8 +4,6 @@ tags: --- # MQ2ChatWnd -## Description - This plugin adds an additional window to your UI which displays ALL information generated by MQ2. **Note:** Any information displayed or typed in this window will NOT go into your character log. It is invisible to EverQuest \(and invisible to /petitions and /reports too\). diff --git a/plugins/core-plugins/mq2custombinds/README.md b/plugins/core-plugins/mq2custombinds/README.md index d432ea022..d3ee1ed28 100644 --- a/plugins/core-plugins/mq2custombinds/README.md +++ b/plugins/core-plugins/mq2custombinds/README.md @@ -4,8 +4,6 @@ tags: --- # MQ2CustomBinds -## Description - This plugin allows you to specify custom commands that are executed when specific key combinations are pressed. You may specify a command for when the key is pressed \(down\), and another for when it is released \(up\). diff --git a/plugins/core-plugins/mq2hud/README.md b/plugins/core-plugins/mq2hud/README.md index 2d3e2106d..fa326f03a 100644 --- a/plugins/core-plugins/mq2hud/README.md +++ b/plugins/core-plugins/mq2hud/README.md @@ -4,8 +4,6 @@ tags: --- # MQ2HUD -## Description - This plugin provides a Heads Up Display for your EQ window, which can provide a large amount of information in a relatively small amount of space. The HUD acts as a transparent background layer, upon which any information can be displayed. Each element of the HUD gets parsed each time MQ2Data is displayed, so there is no need to reload the HUD after making changes to the .ini file, they are instantly available as soon as you save. The HUD is customized by entries in the MQ2HUD.ini file. The .ini file allows any number of HUDs to be created and saved within. Loading a new HUD from the .ini file can be done with `/loadhud`. The entry names are not case-sensitive. From 2114a8a8174708625db58f736fcca4cc44ce4192 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Thu, 17 Apr 2025 10:24:28 -0500 Subject: [PATCH 04/41] moving hud command out of the plugin --- plugins/core-plugins/mq2hud/hud.md | 20 -------------------- reference/commands/hud.md | 24 ++++++++++++++++++++++++ 2 files changed, 24 insertions(+), 20 deletions(-) delete mode 100644 plugins/core-plugins/mq2hud/hud.md create mode 100644 reference/commands/hud.md diff --git a/plugins/core-plugins/mq2hud/hud.md b/plugins/core-plugins/mq2hud/hud.md deleted file mode 100644 index 82724cddf..000000000 --- a/plugins/core-plugins/mq2hud/hud.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -tags: - - command ---- -# /hud - -## Syntax - -**/hud \[ normal \| underui \| always \]** - -## Description - -Defines how the HUD is displayed. - -* **Normal** - * Above the EQ UI but will not be displayed if pressing F11. -* **UnderUI** - * Under the EQ UI and will disappear if F11 is pressed. -* **Always** - * The HUD will always be present above the EQ UI and will not disappear when F11 is pressed. diff --git a/reference/commands/hud.md b/reference/commands/hud.md new file mode 100644 index 000000000..b246146d8 --- /dev/null +++ b/reference/commands/hud.md @@ -0,0 +1,24 @@ +--- +tags: + - command +--- +# /hud + +## Syntax + +```eqcommand +/hud [ normal | underui | always ] +``` + +## Description + +Defines how the HUD is displayed. + +## Options + +- **Normal** + - Above the EQ UI but will not be displayed if pressing F11. +- **UnderUI** + - Under the EQ UI and will disappear if F11 is pressed. +- **Always** + - The HUD will always be present above the EQ UI and will not disappear when F11 is pressed. From 8189f01275b4495b37ed5f3d50a27555a8cfff4c Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 26 Apr 2025 09:22:57 -0500 Subject: [PATCH 05/41] updating embed macros --- main.py | 440 ++++++++++++++++++++++++++++++++------------------------ 1 file changed, 252 insertions(+), 188 deletions(-) diff --git a/main.py b/main.py index fac37dbe5..e61a069c4 100644 --- a/main.py +++ b/main.py @@ -1,4 +1,5 @@ import re +import textwrap from pathlib import Path, PurePosixPath def define_env(env): @@ -21,7 +22,8 @@ def renderMember(name, type=None, params=None, toc_label=None): @env.macro def embedCommand(command_file): - data = parse_command_file(command_file) + page = env.variables.page + data = parse_command_file(command_file, page) doc_url = data.get("doc_url", "#") syntax_content = data.get("syntax_content") @@ -30,7 +32,8 @@ def embedCommand(command_file): full_description = data.get("full_description", "") has_more_content = data.get("has_more_content", False) - syntax = f'⚠️ Syntax missing' + # we use html links here because markdown wasn't able to link a codeblock. + syntax = f'⚠️ Syntax missing' if syntax_content: if is_codeblock: lexer_str = lexer or '' @@ -38,28 +41,18 @@ def embedCommand(command_file): else: syntax = f'{syntax_content}' - # Format Description (add "read more" link if it's long) - formatted_description = "" - if full_description: - description = full_description - read_more_link = f' [:material-book-arrow-right-outline:]({doc_url})' - max_description_length = 280 - if len(description) > max_description_length: - # Find a space between words before cutting off a long description - break_point = description.rfind(' ', 0, max_description_length - len(read_more_link) - 3) - if break_point == -1: - break_point = max_description_length - len(read_more_link) - 3 - formatted_description = description[:break_point] + '...' + read_more_link - elif has_more_content: - formatted_description = description + read_more_link - else: - formatted_description = description - - return f"{syntax}\n: {formatted_description}" + formatted_description = truncate_description( + full_description, + doc_url, + has_more_content + ) + + return f"{syntax}\n: {formatted_description}\n" @env.macro def embedMQType(doc_file): - data = parse_mq_type(doc_file) + page = env.variables.page + data = parse_type_file(doc_file, page) doc_url = data.get("doc_url", "#") # the default URL is a same page link name = data.get("name", "Unknown Type") @@ -71,225 +64,296 @@ def embedMQType(doc_file): if members: members_table = "\n\n" + render_members_table(members, link_refs) + "\n\n" - link_refs_part = "" - if link_refs: - formatted_links = "\n".join([f"[{ref_name}]: {ref_url}" for ref_name, ref_url in link_refs]) - link_refs_part = f"\n\n{formatted_links}" - - # Add read more link only if description exists - read_more_indicator = f" [:material-book-arrow-right-outline:]({doc_url})" if description else "" + # Unified truncation using shared helper + formatted_desc = truncate_description( + data.get("full_description", data.get("description", "")), + doc_url, + data.get("has_more_content", False) + ) result = ( f"### [`{name}`]({doc_url})\n\n" - f"{description}{read_more_indicator}\n\n" + f"{formatted_desc}\n\n" # Use processed description f"{members_table}" - f"{link_refs_part}" ) return result # == Helper functions == -def parse_command_file(command_file): - """ - Parse command file for syntax and description. - """ - try: - content = Path(command_file).read_text() - base_dir = Path(command_file).parent - doc_url = make_content_link(command_file) - except FileNotFoundError: - return { - "doc_url": "#", - "syntax_content": "Error: File not found", - "lexer": "", - "is_codeblock": False, - "full_description": "", - "has_more_content": False, - } +# Parse for syntax and description. +def parse_command_file(command_file, page): + SYNTAX_CODEBLOCK_PATTERN = r'## Syntax\s*\n\s*```(\w+)?\s*\n(.*?)\n```' + SYNTAX_NOCODE_PATTERN = r'## Syntax\s+\n+(.+?)(?=\n\n|\n##)' + DESCRIPTION_PATTERN = r'## Description\s*\n(.*?)(?=\n\n\*\*|\n##|$)' + + file_result = read_file(command_file, page) + + # Initialize for clarity + data = { + "doc_url": file_result["doc_url"], + "syntax_content": None, + "lexer": "", + "is_codeblock": False, + "full_description": "", + "has_more_content": False + } - syntax_content = None - lexer = "" - is_codeblock = False - full_description = "" - has_more_content = False + # return on error + if not file_result["success"]: + data["syntax_content"] = f"Error: {file_result['error']}" + data["full_description"] = "Documentation file could not be loaded" + return data - # Extract syntax (and lexer) that's in a code block so we can render the link correctly. - syntax_match = re.search( - r'## Syntax\s*\n\s*```(\w+)?\s*\n(.*?)\n```', - content, re.DOTALL - ) + content = file_result["content"] + base_dir = file_result["base_dir"] + + # This keeps track of how far down the file we've parsed for the has_more_content check + end_pos = 0 + + # Syntax is in codeblocks + syntax_match = re.search(SYNTAX_CODEBLOCK_PATTERN, content, re.DOTALL) if syntax_match: - is_codeblock = True - lexer = syntax_match.group(1) or "" - syntax_content = syntax_match.group(2).strip() + data.update({ + "is_codeblock": True, + "lexer": syntax_match.group(1) or "", + "syntax_content": syntax_match.group(2).strip() + }) + end_pos = max(end_pos, syntax_match.end()) else: - # Extract syntax that's not in a code block, which is much simpler to render: - syntax_match = re.search( - r'## Syntax\s+\n+(.+?)(?=\n\n|\n##)', - content, re.DOTALL - ) - if syntax_match: - syntax_content = syntax_match.group(1).strip() - - # Extract first paragraph of description (before any subsections) - description_match = re.search( - r'## Description\s+\n+(.*?)(?=\n\n\*\*|\n##|$)', - content, re.DOTALL + # Syntax if no codeblocks, we use extract_section for help. + syntax_content_nocode, syntax_end = extract_section(SYNTAX_NOCODE_PATTERN, content) + if syntax_content_nocode: + data["syntax_content"] = syntax_content_nocode + end_pos = max(end_pos, syntax_end) + else: + data["syntax_content"] = "⚠️ Syntax missing" + + description_text, desc_end = extract_section( + DESCRIPTION_PATTERN, + content, + clean_whitespace=True, + convert_links=True, + base_dir=base_dir, + page=page ) - if description_match: - description_text = description_match.group(1).strip() - # Convert links and collapse whitespace - full_description = convert_relative_links(description_text, base_dir) - full_description = re.sub(r'\s*\n\s*', ' ', full_description) - # Check if there's more content after the description paragraph - remaining_content = content[description_match.end():] - if re.search(r'\n\n\*\*|\n##', remaining_content): - has_more_content = True - - return { - "doc_url": doc_url, - "syntax_content": syntax_content, - "lexer": lexer, - "is_codeblock": is_codeblock, - "full_description": full_description, - "has_more_content": has_more_content, - } -def parse_mq_type(doc_file): - """ - Extract information from a TLO or datatype file - """ + if description_text: + data["full_description"] = description_text + end_pos = max(end_pos, desc_end) + # else: # No need for else, default is "" + + data["has_more_content"] = bool(re.search(r'\S', content[end_pos:].strip())) + + return data + +def read_file(file_path, page): try: - content = Path(doc_file).read_text() - doc_path = Path(doc_file) + doc_path = Path(file_path) + content = doc_path.read_text() base_dir = doc_path.parent - doc_url = make_content_link(doc_file) - except FileNotFoundError: + doc_url = relative_link(file_path, page.file.src_uri) # src_uri is the path to the embedding page return { - "name": "Error: File not found", - "description": "", - "section_name": "", - "members": [], - "link_refs": [], + "content": content, + "base_dir": base_dir, + "doc_url": doc_url, + "success": True, + "error": None + } + except Exception as e: + return { + "content": "", + "base_dir": None, "doc_url": "#", + "success": False, + "error": str(e) } - # Initialize variables with default values - name = "" - description = "" - section_name = "" - members = [] - link_refs = [] # Initialize link_refs as an empty list +# create a url that's relative to the embedding page +def relative_link(target_file_path, embedding_page_src_uri, base_dir=None): + # i could only get this working with pureposixpath + target_path = PurePosixPath(base_dir) / target_file_path if base_dir else PurePosixPath(target_file_path) + embedding_dir = PurePosixPath(embedding_page_src_uri).parent - # Extract the name from the top of the page. - name_match = re.search(r'# `(.+?)`', content) - if name_match: - name = name_match.group(1) + relative_path = target_path.relative_to(embedding_dir, walk_up=True) - # Extract the description as the first paragraph after the header. - desc_match = re.search(r'# `.+?`\s*\n+(.*?)(?=\n\n|\n##|$)', content, re.DOTALL) - if desc_match: # Check if match was found - description_text = desc_match.group(1).strip() - description = re.sub(r'\s*\n\s*', ' ', description_text) - description = convert_relative_links(description, base_dir) + # special case for index and readme files + if relative_path.name.lower() in ('index.md', 'readme.md'): + parent_dir = relative_path.parent + return './' if str(parent_dir) == '.' else f"{parent_dir}/" - # Extract the Members or Forms section. Stops when a new level-2 header (##) appears. - section_match = re.search(r'## (Forms|Members)\s*\n+(.*?)(?=\n##(?!#)|$)', content, re.DOTALL) - if section_match: - section_name = section_match.group(1) - raw_section_content = section_match.group(2).strip() - # Parse out the individual member definitions. - members = parse_render_members(raw_section_content, base_dir) + # otherwise, remove the .md extension and add a trailing slash + return f"{relative_path.with_suffix('')}/" - # Process link references using helper - link_ref_matches = re.findall(r'^\[([^\]]+)\]:\s*(.+?)(?:\s*)$', content, re.MULTILINE) - for ref_name, ref_url in link_ref_matches: - if ref_url.endswith('.md'): # Only process .md links - try: - absolute_ref = make_content_link(ref_url, base_dir) - link_refs.append((ref_name, absolute_ref)) - except Exception as e: - print(f"Warning: Could not process link ref [{ref_name}]: {ref_url} in {doc_file}. Error: {e}") - - return { - "name": name, - "description": description, - "section_name": section_name, - "members": members, - "link_refs": link_refs, - "doc_url": doc_url, +def extract_section(pattern, content, clean_whitespace=False, convert_links=False, base_dir=None, page=None): + match = re.search(pattern, content, re.DOTALL) + + if not match: + return None, None + + extracted = match.group(1).strip() + + if clean_whitespace: + extracted = re.sub(r'\s*\n\s*', ' ', extracted) + + if convert_links and base_dir and page: + extracted = rewrite_markdown_links(extracted, base_dir, page) + + return extracted, match.end() + +def parse_type_file(doc_file, page): + NAME_PATTERN = r'# `(.+?)`' + DESCRIPTION_PATTERN = r'# `.+?`\s*\n+(.*?)(?=\n\n|\n##|$)' + SECTION_PATTERN = r'## (Forms|Members)\s*\n+(.*?)(?=\n##(?!#)|$)' + LINK_REF_PATTERN = r'^\[([^\]]+)\]:\s*(.+?)(?:\s*)$' + + file_result = read_file(doc_file, page) + + # Initialize for clarity + data = { + "doc_url": file_result["doc_url"], + "name": "Unknown Type", + "full_description": "", + "section_name": "", + "members": [], + "link_refs": [], + "has_more_content": False, } -def parse_render_members(raw_content, base_dir): - """ - parse renderMember macro calls for member info. - """ - # Pattern captures the parameters inside renderMember and then the description - pattern = r"###\s*\{\{\s*renderMember\s*\((.*?)\)\s*\}\}\s*\n\s*\:\s*(.*?)(?=\n###|\Z)" - matches = re.findall(pattern, raw_content, re.DOTALL) + # return on error + if not file_result["success"]: + data["name"] = "Error loading type" + data["full_description"] = f"Error: {file_result['error']}" + return data + + content = file_result["content"] + base_dir = file_result["base_dir"] + # This keeps track of how far down the file we've parsed for the has_more_content check + end_pos = 0 + + # Name extraction + name_match = re.search(NAME_PATTERN, content) + if name_match: + data["name"] = name_match.group(1) # Update data dict + # Update end_pos to the end of the name section if it's further + end_pos = max(end_pos, name_match.end()) + + description_text, desc_end = extract_section( + DESCRIPTION_PATTERN, + content, + clean_whitespace=True, + convert_links=True, + base_dir=base_dir, + page=page + ) + + if description_text: + data["full_description"] = description_text + end_pos = max(end_pos, desc_end) + + # Members section extraction + section_match = re.search( + SECTION_PATTERN, + content, re.DOTALL + ) + + if section_match: + data["section_name"] = section_match.group(1) # Forms or Members + raw_content = section_match.group(2).strip() + data["members"] = parse_render_members(raw_content, base_dir, page) + end_pos = max(end_pos, section_match.end()) + + # Link reference extraction + link_ref_matches = re.findall(LINK_REF_PATTERN, content, re.MULTILINE) + processed_link_refs = [] + for ref_name, ref_url in link_ref_matches: + if ref_url.endswith('.md'): + relative_ref_url = relative_link(ref_url, page.file.src_uri, base_dir=base_dir) + processed_link_refs.append((ref_name, relative_ref_url)) + data["link_refs"] = processed_link_refs + + data["has_more_content"] = bool(re.search(r'\S', content[end_pos:].strip())) + + return data + +# parse renderMember macro calls +def parse_render_members(raw_content, base_dir, page): + MEMBER_PATTERN = r"###\s*\{\{\s*renderMember\s*\((.*?)\)\s*\}\}(?:\s*\n\s*\:\s*(.*?))?(?=\n\n|\n###|\Z)" + KV_PAIR_PATTERN = r"(\w+)\s*=\s*'([^']+)'" + + matches = re.findall(MEMBER_PATTERN, raw_content, re.DOTALL) members = [] for params_str, description in matches: - # Capture key='value' pairs from the renderMember call. - kv_pattern = r"(\w+)\s*=\s*'([^']+)'" - kv_pairs = re.findall(kv_pattern, params_str) - params = {k: v for k, v in kv_pairs} - - member_name = params.get("name", "").strip() - member_type = params.get("type", "").strip() + kv_pairs = re.findall(KV_PAIR_PATTERN, params_str) + params_dict = {k: v for k, v in kv_pairs} + + member_name = params_dict.get("name", "").strip() + member_type = params_dict.get("type", "").strip() + member_params = params_dict.get("params", "").strip() + # convert any links in the description + cleaned_description = rewrite_markdown_links(description.strip(), base_dir, page) if description else "" members.append({ "name": member_name, "type": member_type, - "description": convert_relative_links(description.strip(), base_dir) + "params": member_params, + "description": cleaned_description }) return members -def make_content_link(file_path, base_dir=None): - """ - Convert a file path to mkdocs url - - (when base_dir=None): "commands/foo.md" → "/commands/foo/" - - (with base_dir): "../datatypes/bar.md" → "/datatypes/bar/" - """ - if base_dir: - # For relative links within embedded content - full_path = PurePosixPath(base_dir / file_path) - else: - # For main document (embed-er) links - full_path = PurePosixPath(file_path) - - return f"/{full_path.with_suffix('')}/" +def rewrite_markdown_links(content, base_dir, page): + MARKDOWN_LINK_PATTERN = r'\[([^\]]+)\]\(([^\)]+\.md)\)' -def convert_relative_links(content, base_dir): - """ - Convert relative links to absolute links for embedded content - """ def replace_link(match): - text = match.group(1) + name = match.group(1) rel_path = match.group(2) - return f"[{text}]({make_content_link(rel_path, base_dir)})" - + return f"[{name}]({relative_link(rel_path, page.file.src_uri, base_dir=base_dir)})" + return re.sub( - r'\[([^\]]+)\]\(([^\)]+\.md)\)', + MARKDOWN_LINK_PATTERN, replace_link, content ) +# a nice little markdown table def render_members_table(members, link_refs): - """ - Use members and link_refs to create a markdown table. - """ lines = [ "| Type | Member | Description |", "| ---- | ------ | ----------- |" ] - # Convert link_refs to a dictionary for easier lookup link_dict = {ref_name: ref_url for ref_name, ref_url in link_refs} for m in members: type_val = m["type"] - if type_val in link_dict: + if type_val in link_dict: # does it match a link ref? type_rendered = f"[{type_val}]({link_dict[type_val]})" + elif type_val: + type_rendered = f"`{type_val}`" + else: + type_rendered = '' + + member_name = m['name'] + member_params = m.get('params') + if member_params: + member_name_rendered = f"`{member_name}[{member_params}]`" else: - type_rendered = type_val - lines.append(f"| {type_rendered} | `{m['name']}` | {m['description']} |") - return "\n".join(lines) \ No newline at end of file + member_name_rendered = f"`{member_name}`" + + lines.append(f"| {type_rendered} | {member_name_rendered} | {m['description']} |") + return "\n".join(lines) + +def truncate_description(description_text, doc_url, has_more_content, max_length=280): + if not description_text: + return "" + + read_more_link = f' [:material-book-arrow-right-outline:]({doc_url})' + max_desc_length = max(max_length - len(read_more_link), 0) + + shortened = textwrap.shorten(description_text, width=max_desc_length, break_long_words=False, placeholder='...') + + if has_more_content: + return f"{shortened}{read_more_link}" + + if len(shortened) < len(description_text): + return f"{shortened}{read_more_link}" + + return description_text \ No newline at end of file From 7f07ccf5620b9dcb048c262713d6e941a2418877 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 26 Apr 2025 09:30:34 -0500 Subject: [PATCH 06/41] renaming core plugins, standardizing for embed format --- plugins/core-plugins/README.md | 18 +++ plugins/core-plugins/autobank/index.md | 48 ++++++ plugins/core-plugins/bzsrch/README.md | 24 +++ plugins/core-plugins/bzsrch/breset.md | 15 ++ plugins/core-plugins/bzsrch/bzquery.md | 15 ++ .../bzsrch/bzsrch-datatype-bazaar.md | 25 ++++ .../bzsrch/bzsrch-datatype-bazaaritem.md | 61 ++++++++ .../core-plugins/bzsrch/bzsrch-tlo-bazaar.md | 15 ++ plugins/core-plugins/bzsrch/bzsrch.md | 38 +++++ plugins/core-plugins/chat/index.md | 12 ++ plugins/core-plugins/chatwnd/README.md | 33 +++++ plugins/core-plugins/chatwnd/mqchat.md | 23 +++ .../{mq2chatwnd => chatwnd}/mqclear.md | 7 +- plugins/core-plugins/chatwnd/mqfont.md | 15 ++ .../{mq2chatwnd => chatwnd}/mqmin.md | 6 +- plugins/core-plugins/chatwnd/setchattitle.md | 15 ++ plugins/core-plugins/chatwnd/style.md | 16 ++ plugins/core-plugins/custombinds/README.md | 22 +++ .../custombind.md | 16 +- .../{mq2eqbugfix.md => eqbugfix/index.md} | 4 +- plugins/core-plugins/hud/README.md | 108 ++++++++++++++ plugins/core-plugins/hud/classhud.md | 14 ++ .../{mq2hud => hud}/defaulthud.md | 4 +- plugins/core-plugins/hud/loadhud.md | 15 ++ plugins/core-plugins/hud/tlo-hud.md | 21 +++ plugins/core-plugins/hud/unloadhud.md | 15 ++ plugins/core-plugins/hud/zonehud.md | 14 ++ plugins/core-plugins/itemdisplay/README.md | 40 +++++ .../itemdisplay/datatype-displayitem.md | 50 +++++++ .../{mq2itemdisplay => itemdisplay}/inote.md | 9 +- .../core-plugins/itemdisplay/itemdisplay.md | 15 ++ .../itemdisplay/tlo-displayitem.md | 19 +++ plugins/core-plugins/labels/index.md | 140 ++++++++++++++++++ plugins/core-plugins/map/README.md | 24 +++ plugins/core-plugins/map/highlight.md | 15 ++ plugins/core-plugins/map/mapactivelayer.md | 15 ++ plugins/core-plugins/map/mapclick.md | 40 +++++ .../core-plugins/{mq2map => map}/mapfilter.md | 53 ++++--- plugins/core-plugins/map/maphide.md | 29 ++++ plugins/core-plugins/map/maploc.md | 63 ++++++++ plugins/core-plugins/map/mapnames.md | 53 +++++++ plugins/core-plugins/map/mapshow.md | 15 ++ plugins/core-plugins/map/tlo-mapspawn.md | 17 +++ .../mq2bzsrch/mq2bzsrch-datatype-bazaar.md | 14 -- .../mq2bzsrch-datatype-bazaaritem.md | 17 --- .../mq2bzsrch/mq2bzsrch-tlo-bazaar.md | 17 --- plugins/core-plugins/mq2chat.md | 11 -- plugins/core-plugins/mq2chatwnd/README.md | 60 -------- plugins/core-plugins/mq2chatwnd/mqfont.md | 19 --- plugins/core-plugins/mq2custombinds/README.md | 13 -- plugins/core-plugins/mq2hud/README.md | 92 ------------ plugins/core-plugins/mq2hud/classhud.md | 14 -- plugins/core-plugins/mq2hud/loadhud.md | 13 -- plugins/core-plugins/mq2hud/zonehud.md | 14 -- plugins/core-plugins/mq2itemdisplay/README.md | 58 -------- plugins/core-plugins/mq2labels.md | 86 ----------- plugins/core-plugins/mq2map/README.md | 24 --- plugins/core-plugins/mq2map/highlight.md | 16 -- plugins/core-plugins/mq2map/mapclick.md | 34 ----- plugins/core-plugins/mq2map/maphide.md | 27 ---- plugins/core-plugins/mq2map/mapnames.md | 41 ----- plugins/core-plugins/mq2map/mapshow.md | 15 -- plugins/core-plugins/targetinfo/index.md | 54 +++++++ plugins/core-plugins/targetinfo/targetinfo.md | 26 ++++ plugins/core-plugins/xtarinfo/index.md | 69 +++++++++ plugins/core-plugins/xtarinfo/xtarinfo.md | 15 ++ 66 files changed, 1333 insertions(+), 632 deletions(-) create mode 100644 plugins/core-plugins/autobank/index.md create mode 100644 plugins/core-plugins/bzsrch/README.md create mode 100644 plugins/core-plugins/bzsrch/breset.md create mode 100644 plugins/core-plugins/bzsrch/bzquery.md create mode 100644 plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md create mode 100644 plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md create mode 100644 plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md create mode 100644 plugins/core-plugins/bzsrch/bzsrch.md create mode 100644 plugins/core-plugins/chat/index.md create mode 100644 plugins/core-plugins/chatwnd/README.md create mode 100644 plugins/core-plugins/chatwnd/mqchat.md rename plugins/core-plugins/{mq2chatwnd => chatwnd}/mqclear.md (51%) create mode 100644 plugins/core-plugins/chatwnd/mqfont.md rename plugins/core-plugins/{mq2chatwnd => chatwnd}/mqmin.md (58%) create mode 100644 plugins/core-plugins/chatwnd/setchattitle.md create mode 100644 plugins/core-plugins/chatwnd/style.md create mode 100644 plugins/core-plugins/custombinds/README.md rename plugins/core-plugins/{mq2custombinds => custombinds}/custombind.md (64%) rename plugins/core-plugins/{mq2eqbugfix.md => eqbugfix/index.md} (70%) create mode 100644 plugins/core-plugins/hud/README.md create mode 100644 plugins/core-plugins/hud/classhud.md rename plugins/core-plugins/{mq2hud => hud}/defaulthud.md (76%) create mode 100644 plugins/core-plugins/hud/loadhud.md create mode 100644 plugins/core-plugins/hud/tlo-hud.md create mode 100644 plugins/core-plugins/hud/unloadhud.md create mode 100644 plugins/core-plugins/hud/zonehud.md create mode 100644 plugins/core-plugins/itemdisplay/README.md create mode 100644 plugins/core-plugins/itemdisplay/datatype-displayitem.md rename plugins/core-plugins/{mq2itemdisplay => itemdisplay}/inote.md (60%) create mode 100644 plugins/core-plugins/itemdisplay/itemdisplay.md create mode 100644 plugins/core-plugins/itemdisplay/tlo-displayitem.md create mode 100644 plugins/core-plugins/labels/index.md create mode 100644 plugins/core-plugins/map/README.md create mode 100644 plugins/core-plugins/map/highlight.md create mode 100644 plugins/core-plugins/map/mapactivelayer.md create mode 100644 plugins/core-plugins/map/mapclick.md rename plugins/core-plugins/{mq2map => map}/mapfilter.md (50%) create mode 100644 plugins/core-plugins/map/maphide.md create mode 100644 plugins/core-plugins/map/maploc.md create mode 100644 plugins/core-plugins/map/mapnames.md create mode 100644 plugins/core-plugins/map/mapshow.md create mode 100644 plugins/core-plugins/map/tlo-mapspawn.md delete mode 100644 plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaar.md delete mode 100644 plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaaritem.md delete mode 100644 plugins/core-plugins/mq2bzsrch/mq2bzsrch-tlo-bazaar.md delete mode 100644 plugins/core-plugins/mq2chat.md delete mode 100644 plugins/core-plugins/mq2chatwnd/README.md delete mode 100644 plugins/core-plugins/mq2chatwnd/mqfont.md delete mode 100644 plugins/core-plugins/mq2custombinds/README.md delete mode 100644 plugins/core-plugins/mq2hud/README.md delete mode 100644 plugins/core-plugins/mq2hud/classhud.md delete mode 100644 plugins/core-plugins/mq2hud/loadhud.md delete mode 100644 plugins/core-plugins/mq2hud/zonehud.md delete mode 100644 plugins/core-plugins/mq2itemdisplay/README.md delete mode 100644 plugins/core-plugins/mq2labels.md delete mode 100644 plugins/core-plugins/mq2map/README.md delete mode 100644 plugins/core-plugins/mq2map/highlight.md delete mode 100644 plugins/core-plugins/mq2map/mapclick.md delete mode 100644 plugins/core-plugins/mq2map/maphide.md delete mode 100644 plugins/core-plugins/mq2map/mapnames.md delete mode 100644 plugins/core-plugins/mq2map/mapshow.md create mode 100644 plugins/core-plugins/targetinfo/index.md create mode 100644 plugins/core-plugins/targetinfo/targetinfo.md create mode 100644 plugins/core-plugins/xtarinfo/index.md create mode 100644 plugins/core-plugins/xtarinfo/xtarinfo.md diff --git a/plugins/core-plugins/README.md b/plugins/core-plugins/README.md index 33cc03715..f34326e8a 100644 --- a/plugins/core-plugins/README.md +++ b/plugins/core-plugins/README.md @@ -1,2 +1,20 @@ # Core Plugins +MacroQuest's core plugins are maintained by MacroQuest Authors, and are included by default in MacroQuest distributions. + +## List of Core Plugins + +* [AutoBank](./autobank/index.md) +* [AutoLogin](./autologin/index.md) +* [Bzsrch](./bzsrch/README.md) +* [Chat](./chat/index.md) +* [ChatWnd](./chatwnd/README.md) +* [CustomBinds](./custombinds/README.md) +* [EQBugFix](./eqbugfix/index.md) +* [HUD](./hud/README.md) +* [ItemDisplay](./itemdisplay/README.md) +* [Labels](./labels/index.md) +* [Lua](../../lua/README.md) +* [Map](./map/README.md) +* [TargetInfo](./targetinfo/index.md) +* [XTarInfo](./xtarinfo/index.md) diff --git a/plugins/core-plugins/autobank/index.md b/plugins/core-plugins/autobank/index.md new file mode 100644 index 000000000..73fd85830 --- /dev/null +++ b/plugins/core-plugins/autobank/index.md @@ -0,0 +1,48 @@ +--- +tags: + - plugin +--- +# AutoBank +AutoBank adds a context menu to the AutoBank button in EQ's bank window. It allows you to automatically remove or add items to the bank with Tradeskill, Collectible, or Quest tags on it. +Additionally, in the case of tradeskill items you can filter if you should or shouldn't move items with skill mods (Trophies). +More feature to be considered/added in the future. + +## Getting Started + +Quick start instructions to get users up and going + +```txt +/plugin AutoBank +``` + +### Commands +```txt +None +``` + +### Configuration File + +Describe the configuration file and what the settings do + +```Macroquest.ini +[AutoBank] +AutoBankCollectibleItems=0 +AutoBankTradeSkillItems=0 +AutoInventoryItems=0 +AutoBankTropiesWithTradeskill=0 +AutoBankTrophiesWithTradeskill=1 +``` + +## Authors + +* **Eqmule** - *Initial work* +* **ChatWithThisName** +* **Brainiac** + + +See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. + +## Acknowledgments + +* Inspiration from... +* I'd like to thank the Thieves' Guild for helping me with all the code I stole... diff --git a/plugins/core-plugins/bzsrch/README.md b/plugins/core-plugins/bzsrch/README.md new file mode 100644 index 000000000..bf7355784 --- /dev/null +++ b/plugins/core-plugins/bzsrch/README.md @@ -0,0 +1,24 @@ +--- +tags: + - plugin +--- +# Bzsrch + +This plugin adds bazaar search access and commands. + +## Commands + +{{ embedCommand('plugins/core-plugins/bzsrch/bzsrch.md') }} +{{ embedCommand('plugins/core-plugins/bzsrch/breset.md') }} +{{ embedCommand('plugins/core-plugins/bzsrch/bzquery.md') }} + +## Top-Level Objects + +{{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md') }} + +## Datatypes + +{{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md') }} +{{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md') }} +{{ embedMQType('plugins/core-plugins/autologin/datatype-loginprofile.md') }} +{{ embedMQType('reference/data-types/datatype-body.md') }} diff --git a/plugins/core-plugins/bzsrch/breset.md b/plugins/core-plugins/bzsrch/breset.md new file mode 100644 index 000000000..d228b1aa7 --- /dev/null +++ b/plugins/core-plugins/bzsrch/breset.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /breset + +## Syntax + +```eqcommand +/breset +``` + +## Description + +Stops and resets the current bazaar search. \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzquery.md b/plugins/core-plugins/bzsrch/bzquery.md new file mode 100644 index 000000000..9169ad4d6 --- /dev/null +++ b/plugins/core-plugins/bzsrch/bzquery.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /bzquery + +## Syntax + +```eqcommand +/bzquery +``` + +## Description + +The same as clicking the "find items" button on the bazaar window. \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md new file mode 100644 index 000000000..f1b7b1bfa --- /dev/null +++ b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md @@ -0,0 +1,25 @@ +--- +tags: + - datatype +--- +# `bazaar` + +Datatype providing access to bazaar search results and status information.Datatype providing access to bazaar search results and status information. + +## Members + +### {{ renderMember(type='int', name='Count') }} +: Number of search results available + +### {{ renderMember(type='bool', name='Done') }} +: True if search operation has completed + +### {{ renderMember(type='bazaaritem', name='Item', params='#') }} +: Returns the name of the item at the specified index + +### {{ renderMember(type='bazaaritem', name='SortedItem', params='#') }} +: Returns the name of the item at the specified index from a sorted list, as you'd see it in the GUI. + +[bazaaritem]: bzsrch-datatype-bazaaritem.md +[bool]: ../../../reference/data-types/datatype-bool.md +[int]: ../../../reference/data-types/datatype-int.md \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md new file mode 100644 index 000000000..e1acac88b --- /dev/null +++ b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md @@ -0,0 +1,61 @@ +--- +tags: + - datatype +--- +# `bazaaritem` + +Represents an individual item in bazaar search results, providing access to item details and trader information. + +## Members + +### {{ renderMember(type='string', name='Name') }} +: The name of the item. + +### {{ renderMember(type='string', name='FullName') }} +: Full item name including special characters (e.g. `Burynai Burial Regalia (Caza)`) + +### {{ renderMember(type='string', name='Trader') }} +: The name of the trader selling the item. + +### {{ renderMember(type='int', name='Price') }} +: Price per unit + +### {{ renderMember(type='int', name='Quantity') }} +: Available quantity from this trader **per stack**. If the item id is stackable, this will return the stack size. If the item id is not stackable, this will return 1. + +### {{ renderMember(type='int', name='ItemID') }} +: EQ item ID number + +## Methods + +| Name | Action | +| ---------- | ------------------------------------- | +| **Select** | Selects item in bazaar search window | + +## Examples + +!!! Example "bazaaritem" + === "MQScript" + ```text + /echo ${Bazaar.SortedItem[2].Price} + /echo ${Bazaar.Item[1].Quantity} + /echo ${Bazaar.SortedItem[5].ItemID} + /echo ${Bazaar.Item[20].Trader} + /echo ${Bazaar.SortedItem[5].Name} + /invoke ${Bazaar.Item[1].Select} + /echo ${Bazaar.Item[3].FullName} + ``` + + === "Lua" + ```lua + print(mq.TLO.Bazaar.SortedItem(2).Price()) + print(mq.TLO.Bazaar.Item(1).Quantity()) + print(mq.TLO.Bazaar.SortedItem(5).ItemID()) + print(mq.TLO.Bazaar.Item(20).Trader()) + print(mq.TLO.Bazaar.SortedItem(5).Name()) + mq.TLO.Bazaar.Item(1).Select() + print(mq.TLO.Bazaar.Item(3).FullName()) + ``` + +[int]: ../../../reference/data-types/datatype-int.md +[string]: ../../../reference/data-types/datatype-string.md \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md new file mode 100644 index 000000000..b2f87a44e --- /dev/null +++ b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md @@ -0,0 +1,15 @@ +--- +tags: + - tlo +--- +# `Bazaar` + +Provides access to bazaar search functionality and results. + +## Forms + +### {{ renderMember(type='bazaar', name='Bazaar') }} + +: TRUE if there are search results + +[bazaar]: bzsrch-datatype-bazaar.md \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzsrch.md b/plugins/core-plugins/bzsrch/bzsrch.md new file mode 100644 index 000000000..fb653c0ef --- /dev/null +++ b/plugins/core-plugins/bzsrch/bzsrch.md @@ -0,0 +1,38 @@ +--- +tags: + - command +--- +# /bzsrch + +## Syntax + +```eqcommand +/bzsrch [params] [name] +``` + +## Description + +Searches the bazaar for items matching the specified criteria. Parameters mirror the bazaar window. + +## Parameters + +* **`trader`** *[parameter]* - Filter by trader name or index number +* **`race`** *[parameter]* - Filter by race (e.g. `human`, `"dark elf"`) or index +* **`class`** *[parameter]* - Filter by class (e.g. `warrior`, `"cleric"`) or index +* **`stat`** *[parameter]* - Filter by primary stat (e.g. `strength`, `"heroic stamina"`) or index +* **`slot`** *[parameter]* - Filter by equipment slot (e.g. `chest`, `ammo`) or index +* **`type`** *[parameter]* - Filter by item type (e.g. `"1h slashing"`, `"2h blunt"`) or index +* **`prestige`** *[true|false]* - Filter prestige items +* **`augment`** *[true|false]* - Filter augmented items +* **`price`** *[low]* *[high]* - Price range filter +* **[name]** - Item name or partial name (use quotes for "multi word names") + +## Examples + +```text +/bzsrch class Bard "lute of the howler" +``` +You can string together multiple parameters, like this: +```text +/bzsrch class "shadow knight" race Human stat "heroic stamina" +``` \ No newline at end of file diff --git a/plugins/core-plugins/chat/index.md b/plugins/core-plugins/chat/index.md new file mode 100644 index 000000000..028a66e25 --- /dev/null +++ b/plugins/core-plugins/chat/index.md @@ -0,0 +1,12 @@ +--- +tags: + - plugin +--- +# Chat + +This plugin directs MQ output to your main EQ chat window. + +!!! warning "MQ Output in Reports" + Be careful if doing a /report or /petition because MQ output will be visible in the /report lines that you send. + +By default, MQ output is set to go to a custom MQ window, handled by the [ChatWnd](../chatwnd/README.md) plugin. diff --git a/plugins/core-plugins/chatwnd/README.md b/plugins/core-plugins/chatwnd/README.md new file mode 100644 index 000000000..89bee5ae6 --- /dev/null +++ b/plugins/core-plugins/chatwnd/README.md @@ -0,0 +1,33 @@ +--- +tags: + - plugin +--- +# ChatWnd + +An additional window that displays all output from MacroQuest. Anything you type into this window will avoid your character log. + +## Commands + +{{ embedCommand('plugins/core-plugins/chatwnd/mqchat.md') }} +{{ embedCommand('plugins/core-plugins/chatwnd/style.md') }} +{{ embedCommand('plugins/core-plugins/chatwnd/mqfont.md') }} +{{ embedCommand('plugins/core-plugins/chatwnd/mqmin.md') }} +{{ embedCommand('plugins/core-plugins/chatwnd/mqclear.md') }} +{{ embedCommand('plugins/core-plugins/chatwnd/setchattitle.md') }} + +## Configuration + +The easiest way to configure ChatWnd is to use [/mqchat ui](mqchat.md) to open the ChatWnd configuration window. Alternately you can configure the window by using the commands listed above, or editing the _MQ2ChatWnd.ini_ file directly. + +```text +[Settings] +AutoScroll=on +NoCharSelect=off +SaveByChar=on +``` + +(*Explanation of these settings can be found in the [mqchat](mqchat.md) command reference.*) + +## Key Binding + +By default, the chat window has a key bind of `.` (period) and this is handy! Rather than selecting the window with your mouse, you can hit the period key `.` and MQ window will be selected, so you can type a command quickly. This can be modified in [MacroQuest.ini](../../../main/macroquest.ini.md) under `[Key Binds]` via the setting `MQ2CHAT_Nrm=.` diff --git a/plugins/core-plugins/chatwnd/mqchat.md b/plugins/core-plugins/chatwnd/mqchat.md new file mode 100644 index 000000000..2b8335d92 --- /dev/null +++ b/plugins/core-plugins/chatwnd/mqchat.md @@ -0,0 +1,23 @@ +--- +tags: + - command +--- +# /mqchat + +## Syntax + +```eqcommand +/mqchat [reset | ui | autoscroll {on|off} | NoCharSelect {on|off} | SaveByChar {on|off}] +``` + +## Description + +Configure and manage mqchatwnd's settings. + +## Options + +- **reset**: Resets window and INI settings. +- **ui**: A UI to configure settings. +- **autoscroll {on|off}**: By default set to on, this automatically scrolls to the bottom of the chat window every time a new text line is displayed. If you set this option to off, the chat window will retain your current slider position rather than automatically scroll to the bottom. +- **NoCharSelect {on|off}**: By default set to off, this displays the chat window at the character select screen. If you set this option to on, the chat window will only display when you have entered or re-entered the world. +- **SaveByChar {on|off}**: By default set to on, this creates a new INI entry for every character that you log in so that each character uses its own window position and settings. If you set this option to off, a single [Default] section will be created and all characters will use the same window position and settings. diff --git a/plugins/core-plugins/mq2chatwnd/mqclear.md b/plugins/core-plugins/chatwnd/mqclear.md similarity index 51% rename from plugins/core-plugins/mq2chatwnd/mqclear.md rename to plugins/core-plugins/chatwnd/mqclear.md index 79db8204f..5a69f0775 100644 --- a/plugins/core-plugins/mq2chatwnd/mqclear.md +++ b/plugins/core-plugins/chatwnd/mqclear.md @@ -6,9 +6,10 @@ tags: ## Syntax -**/mqclear** +```eqcommand +/breset +``` ## Description -Clears the chat buffer in the MQ2ChatWnd. - +Clears the chat buffer in the ChatWnd. \ No newline at end of file diff --git a/plugins/core-plugins/chatwnd/mqfont.md b/plugins/core-plugins/chatwnd/mqfont.md new file mode 100644 index 000000000..c204ed914 --- /dev/null +++ b/plugins/core-plugins/chatwnd/mqfont.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /mqfont + +## Syntax + +```eqcommand +/mqfont <#> +``` + +## Description + +Sets the font size in the MQ window, from 1 to 10. Default is 4. \ No newline at end of file diff --git a/plugins/core-plugins/mq2chatwnd/mqmin.md b/plugins/core-plugins/chatwnd/mqmin.md similarity index 58% rename from plugins/core-plugins/mq2chatwnd/mqmin.md rename to plugins/core-plugins/chatwnd/mqmin.md index d55f8d6d0..f89a75989 100644 --- a/plugins/core-plugins/mq2chatwnd/mqmin.md +++ b/plugins/core-plugins/chatwnd/mqmin.md @@ -6,9 +6,11 @@ tags: ## Syntax -**/mqmin** +```eqcommand +/mqmin +``` ## Description -Minimizes the MQ2ChatWnd. +Minimizes the ChatWnd. diff --git a/plugins/core-plugins/chatwnd/setchattitle.md b/plugins/core-plugins/chatwnd/setchattitle.md new file mode 100644 index 000000000..96e101965 --- /dev/null +++ b/plugins/core-plugins/chatwnd/setchattitle.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /setchattitle + +## Syntax + +```eqcommand +/setchattitle +``` + +## Description + +Sets the title of the ChatWnd. By default, it's "MQ". \ No newline at end of file diff --git a/plugins/core-plugins/chatwnd/style.md b/plugins/core-plugins/chatwnd/style.md new file mode 100644 index 000000000..49c647c12 --- /dev/null +++ b/plugins/core-plugins/chatwnd/style.md @@ -0,0 +1,16 @@ +--- +tags: + - command +--- +# /style + +## Syntax + +```eqcommand +/style [!]0xN +``` + +## Description + +Set the style bit corresponding to 0xN or unset it if ! is supplied. See EQ documentation for further details about WindowStyle. + diff --git a/plugins/core-plugins/custombinds/README.md b/plugins/core-plugins/custombinds/README.md new file mode 100644 index 000000000..1e86a4eaf --- /dev/null +++ b/plugins/core-plugins/custombinds/README.md @@ -0,0 +1,22 @@ +--- +tags: + - plugin +--- +# CustomBinds + +Custom commands that are executed when key combinations are pressed. + +You may specify a command for when the key is pressed (down), and another for when it is released (up). + +## Commands + +{{ embedCommand('plugins/core-plugins/custombinds/custombind.md') }} + +## Examples + +``` +/custombind add crylaugh +/custombind set crylaugh-down /cry +/custombind set crylaugh-up /laugh +/bind crylaugh shift+f +``` diff --git a/plugins/core-plugins/mq2custombinds/custombind.md b/plugins/core-plugins/custombinds/custombind.md similarity index 64% rename from plugins/core-plugins/mq2custombinds/custombind.md rename to plugins/core-plugins/custombinds/custombind.md index 0c2564158..2da3038ae 100644 --- a/plugins/core-plugins/mq2custombinds/custombind.md +++ b/plugins/core-plugins/custombinds/custombind.md @@ -6,21 +6,25 @@ tags: ## Syntax -**/custombind \[ list \| \[ add\|delete\|set\|clear** _**bindname**_**\[-down\|-up\] \] \[**_**command**_ **\]** +```eqcommand +/custombind [ list ] | [add|delete] <bindname> | [set|clear] <bindname>[-down|-up] [command] +``` ## Description This command is used to add, delete, list or change custom key bindings. See [/bind](../../../reference/commands/bind.md) and [/dumpbinds](../../../reference/commands/dumpbinds.md). -| | | +## Parameters + +| Parameter | Description | | :--- | :--- | -| **/custombind list** | Lists all your custom bind names and commands \(the key combinations must be set using /bind\) | +| **/custombind list** | Lists all your custom bind names and commands (the key combinations must be set using /bind) | | **/custombind add** _**bindname**_ | Add a new bind called _bindname_ ready for use. | | **/custombind delete** _**bindname**_ | Remove the custom bind _bindname_. | -| **/custombind clear name\[-down\|-up\]** | This will clear a specific command for a custom bind. If -up or -down is not specified it defaults to -down. | -| **/custombind set** _**bindname**_**\[-down\|-up\]** | Will set a specific command for a custom bind. This too defaults to -down if not specified. | +| **/custombind clear name[-down\|-up]** | This will clear a specific command for a custom bind. If -up or -down is not specified it defaults to -down. | +| **/custombind set** _**bindname**_**[-down\|-up]** | Will set a specific command for a custom bind. This too defaults to -down if not specified. | -## Example +## Examples !!! note diff --git a/plugins/core-plugins/mq2eqbugfix.md b/plugins/core-plugins/eqbugfix/index.md similarity index 70% rename from plugins/core-plugins/mq2eqbugfix.md rename to plugins/core-plugins/eqbugfix/index.md index 9307d44a9..9022810fd 100644 --- a/plugins/core-plugins/mq2eqbugfix.md +++ b/plugins/core-plugins/eqbugfix/index.md @@ -2,8 +2,6 @@ tags: - plugin --- -# MQ2EQBugFix - -## Description +# EQBugFix This plugin is used to correct bugs in EQ. diff --git a/plugins/core-plugins/hud/README.md b/plugins/core-plugins/hud/README.md new file mode 100644 index 000000000..10846810f --- /dev/null +++ b/plugins/core-plugins/hud/README.md @@ -0,0 +1,108 @@ +--- +tags: + - plugin +--- +# HUD + +This plugin provides a Heads Up Display for your EQ window, which can provide a large amount of information in a relatively small amount of space. The HUD acts as a transparent background layer, upon which any information can be displayed. Each element of the HUD gets parsed each time MQ2Data is displayed, so there is no need to reload the HUD after making changes to the .ini file, they are instantly available as soon as you save. + +The HUD is customized by entries in the MQ2HUD.ini file. The .ini file allows any number of HUDs to be created and saved within. Loading a new HUD from the .ini file can be done with `/loadhud`. The entry names are not case-sensitive. + +The default HUD entry is called [Elements] and can be loaded with the `/defaulthud` command. + +You can toggle the display of the HUD by using F11. + +## Commands + +{{ embedCommand('plugins/core-plugins/hud/loadhud.md') }} +{{ embedCommand('plugins/core-plugins/hud/defaulthud.md') }} +{{ embedCommand('plugins/core-plugins/hud/classhud.md') }} +{{ embedCommand('plugins/core-plugins/hud/zonehud.md') }} +{{ embedCommand('plugins/core-plugins/hud/unloadhud.md') }} + +## INI File Format + +Entries in the MQ2HUD.ini file are in the following format: + +```ini +[Elements] +TYPE,X,Y,RED,GREEN,BLUE,TEXT +``` + +- **TYPE** can be a combination of the following (just add the numbers): + - **1:** Display in non-fullscreen mode + - **2:** Display in fullscreen mode ("F10 mode") + - **4:** Based on cursor location + - **8:** Display at charselect + - **16:** Only parse if a macro IS running +- **X** and **Y** denote the location of the entry on the screen (0,0 is the upper left of your screen) +- **RED**, **GREEN** and **BLUE** are RGB values for the **TEXT** color (255,255,255 is white; 0,0,0 is black) +- **TEXT** is the MQ2Data you wish to display. As a tip, the [If](../../../reference/top-level-objects/tlo-if.md) TLO is very useful here. + +## Examples + +```ini +[Elements] +TargetInfo=3,5,35,255,255,255,${Target} +GMIndicator=3,5,45,0,0,255,${Spawn[gm]} +CursorItemName=7,-15,-15,255,255,255,${If[${Cursor.ID},${Cursor},]} +ClickMeForFun=6,-25,-25,255,255,255,${If[!${Cursor.ID},click me,]} +MacroName=19,5,70,255,255,255,${If[${Bool[${Macro}]}, Current Macro Running - ${Macro},]} +``` + +In the above HUD, the _CursorItemName_ entry states that it will show the name of your cursor item in all modes. Using 6 as the **TYPE** will display the cursor in full-screen mode only. + +`/loadhud bard` + +This will load the \[bard\] section of the MQ2HUD.ini. + +## Code Segments + +This section contains code segments to help you customize your HUD. Please be sure to substitute the X, Y cords for the location you'd like to see them on your HUD. + +```ini +//AAXP +AAXPText=3,X,Y,255,234,8,AAXP +AAXP=3,X,Y,255,234,8,${Me.PctAAExp} +``` + +```ini +//AttackSpeed +AttackSpeedText=3,X,Y,255,234,8,AttackSpeed : +AttackSpeed=3,X,Y,255,234,8,${Me.AttackSpeed} +``` + +```ini +//Date +Datetext=3,X,Y,255,234,8,Todays Date Is +Date=3,X,Y,255,234,8,${Time.Date} +``` + +```ini +//Damage Absorb Left +DamageShieldText=3,X,Y,255,234,8,Dmg Abs. Left +DamageShield=3,X,Y,255,234,8,${Me.Dar} +``` + +```ini +//Vet AA's +ThroneText=3,500,402,255,234,8,GL Port - - - - +ThroneReadyText=3,610,402,0,255,0,${If[${Me.AltAbilityReady[Throne Of Heroes]},Ready,]} +ThroneNotReady=3,610,402,255,0,0,${If[!${Me.AltAbilityReady[Throne Of Heroes]},${Me.AltAbilityTimer[Throne Of Heroes].TimeHMS},]} +``` + +```ini +//what macro is currently running +Macro1=3,110,110,0,250,0,${If[${Macro.Name.NotEqual["NULL"]},${Macro.Name},]} +Macro2=3,10,110,225,250,225,MACRO RUNNING = +``` + +```ini +//if the macro Raid Druid (Autobot) is currently paused +RDPauseInd1=3,10,122,225,250,225,RD PAUSED = +RDPauseInd2=3,85,122,225,0,0,${RDPause} +``` + +## Top-Level Objects + +{{ embedMQType('plugins/core-plugins/hud/tlo-hud.md') }} diff --git a/plugins/core-plugins/hud/classhud.md b/plugins/core-plugins/hud/classhud.md new file mode 100644 index 000000000..0808547ca --- /dev/null +++ b/plugins/core-plugins/hud/classhud.md @@ -0,0 +1,14 @@ +--- +tags: + - command +--- +# /classhud + +## Syntax + +```eqcommand +/classhud {on|off} +``` + +## Description +Loads the HUD section for your class. You must have a `[Class]` section in `MQ2HUD.ini`. diff --git a/plugins/core-plugins/mq2hud/defaulthud.md b/plugins/core-plugins/hud/defaulthud.md similarity index 76% rename from plugins/core-plugins/mq2hud/defaulthud.md rename to plugins/core-plugins/hud/defaulthud.md index 2681bc4d2..f27946531 100644 --- a/plugins/core-plugins/mq2hud/defaulthud.md +++ b/plugins/core-plugins/hud/defaulthud.md @@ -6,7 +6,9 @@ tags: ## Syntax -**/defaulthud** +```eqcommand +/defaulthud +``` ## Description diff --git a/plugins/core-plugins/hud/loadhud.md b/plugins/core-plugins/hud/loadhud.md new file mode 100644 index 000000000..c6930e915 --- /dev/null +++ b/plugins/core-plugins/hud/loadhud.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /loadhud + +## Syntax + +```eqcommand +/loadhud <HUDName> +``` + +## Description + +Load the specified HUD from the configuration file. e.g. `/loadhud elements` diff --git a/plugins/core-plugins/hud/tlo-hud.md b/plugins/core-plugins/hud/tlo-hud.md new file mode 100644 index 000000000..8248f138d --- /dev/null +++ b/plugins/core-plugins/hud/tlo-hud.md @@ -0,0 +1,21 @@ +--- +tags: + - tlo +--- +# `HUD` + +Returns the current HUD name. + +## Forms + +### {{ renderMember(type='string', name='HUD') }} + +: Returns the current HUD name + +## Example + +```text +/echo ${HUD} # Outputs "elements" +``` + +[string]: ../../../reference/data-types/datatype-string.md diff --git a/plugins/core-plugins/hud/unloadhud.md b/plugins/core-plugins/hud/unloadhud.md new file mode 100644 index 000000000..1f565fd7b --- /dev/null +++ b/plugins/core-plugins/hud/unloadhud.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /unloadhud + +## Syntax + +```eqcommand +/unloadhud <HUDName> +``` + +## Description + +Unload the specified HUD from the configuration file. e.g. `/unloadhud elements` diff --git a/plugins/core-plugins/hud/zonehud.md b/plugins/core-plugins/hud/zonehud.md new file mode 100644 index 000000000..9b593a809 --- /dev/null +++ b/plugins/core-plugins/hud/zonehud.md @@ -0,0 +1,14 @@ +--- +tags: + - command +--- +# /zonehud + +## Syntax + +```eqcommand +/zonehud {on|off} +``` + +## Description +Toggles loading the HUD section for the current zone. You must have a `[zone]` section in `MQ2HUD.ini`, long names are used. diff --git a/plugins/core-plugins/itemdisplay/README.md b/plugins/core-plugins/itemdisplay/README.md new file mode 100644 index 000000000..831e4adea --- /dev/null +++ b/plugins/core-plugins/itemdisplay/README.md @@ -0,0 +1,40 @@ +--- +tags: + - plugin +--- +# ItemDisplay + +This plugin shows spell information and item data in their respective display windows. It can also show custom notes. + +## Commands + +{{ embedCommand('plugins/core-plugins/itemdisplay/itemdisplay.md') }} +{{ embedCommand('plugins/core-plugins/itemdisplay/inote.md') }} + +## INI File + +Settings can be configured via GUI as well with the [mqsettings](../../../reference/commands/mqsettings.md) command. + +```ini +[Notes] +; section for item notes +0014905=mushroom makes me feel good +; this is a note I made for the item "Mushroom" id 0014905, which will appear in the item display window. It's helpful to remember this fact! +[Settings] +LootButton=1 +; the loot button is on +LucyButton=1 +; the lucy button is on, too +ShowSpellInfoOnSpells=0 +; Toggle extra info on the spell window +ShowSpellsInfoOnItems=0 +; Toggle extra info on item window +``` + +## Top-Level Objects + +{{ embedMQType('plugins/core-plugins/itemdisplay/tlo-displayitem.md') }} + +## Datatypes + +{{ embedMQType('plugins/core-plugins/itemdisplay/datatype-displayitem.md') }} diff --git a/plugins/core-plugins/itemdisplay/datatype-displayitem.md b/plugins/core-plugins/itemdisplay/datatype-displayitem.md new file mode 100644 index 000000000..533c4b97d --- /dev/null +++ b/plugins/core-plugins/itemdisplay/datatype-displayitem.md @@ -0,0 +1,50 @@ +--- +tags: + - datatype +--- +# `displayitem` + +Holds members that can control and return status on item display windows. This datatype inherits all members from the **[item]** datatype. + +## Members + +### {{ renderMember(type='string', name='Info') }} +: Returns details from the item. Note that this is different from the "Information" member. + +### {{ renderMember(type='string', name='WindowTitle') }} +: Returns the title of the window + +### {{ renderMember(type='string', name='AdvancedLore') }} +: Displays lore text + +### {{ renderMember(type='string', name='MadeBy') }} +: Displays the maker of the crafted item + +### {{ renderMember(type='bool', name='Collected') }} + +### {{ renderMember(type='bool', name='CollectedReceived') }} + +### {{ renderMember(type='bool', name='Scribed') }} + +### {{ renderMember(type='bool', name='ScribedReceived') }} + +### {{ renderMember(type='string', name='Information') }} +: Returns the "item information" text from the item window. + +### {{ renderMember(type='int', name='DisplayIndex') }} +: Shows the index number of the item window + +### {{ renderMember(type='window', name='Window') }} +: Gives access to the **[window]** datatype, allowing you to do things like `/invoke ${DisplayItem[5].Window.DoClose}` + +### {{ renderMember(type='item', name='Item') }} +: Gives access to the **[item]** datatype, although its members are already inherited. e.g. `/echo ${DisplayItem[2].Item.HP}` + +### {{ renderMember(type='DisplayItem', name='Next') }} + +[DisplayItem]: datatype-displayitem.md +[bool]: ../../../reference/data-types/datatype-bool.md +[int]: ../../../reference/data-types/datatype-int.md +[item]: ../../../reference/data-types/datatype-item.md +[string]: ../../../reference/data-types/datatype-string.md +[window]: ../../../reference/data-types/datatype-window.md \ No newline at end of file diff --git a/plugins/core-plugins/mq2itemdisplay/inote.md b/plugins/core-plugins/itemdisplay/inote.md similarity index 60% rename from plugins/core-plugins/mq2itemdisplay/inote.md rename to plugins/core-plugins/itemdisplay/inote.md index 0d5796fbe..d894e7c16 100644 --- a/plugins/core-plugins/mq2itemdisplay/inote.md +++ b/plugins/core-plugins/itemdisplay/inote.md @@ -6,13 +6,12 @@ tags: ## Syntax -**/inote add\|del \# \[comment text\]** +```eqcommand +/inote <add|del> <itemno> <comment> +``` ## Description - -* This is used to add additional text to the display window for a certain item -* The item number \# must always be present -* The _comment text_ can contain tags to break the line of text +Adds a note to the display window for a the specified item. The _comment_ can contain html `<br>` tags to break the line of text. ## Example diff --git a/plugins/core-plugins/itemdisplay/itemdisplay.md b/plugins/core-plugins/itemdisplay/itemdisplay.md new file mode 100644 index 000000000..94a105799 --- /dev/null +++ b/plugins/core-plugins/itemdisplay/itemdisplay.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /itemdisplay + +## Syntax + +```eqcommand +/itemdisplay [LootButton|LucyButton] [on|off] | reload +``` + +## Description + +Controls display of the advanced loot buttons and lucy button on the item display and spell windows. diff --git a/plugins/core-plugins/itemdisplay/tlo-displayitem.md b/plugins/core-plugins/itemdisplay/tlo-displayitem.md new file mode 100644 index 000000000..1cf72df2d --- /dev/null +++ b/plugins/core-plugins/itemdisplay/tlo-displayitem.md @@ -0,0 +1,19 @@ +--- +tags: + - tlo +--- +# `DisplayItem` + +Gives information on item windows + +## Forms + +### {{ renderMember(type='DisplayItem', name='DisplayItem') }} + +### {{ renderMember(type='DisplayItem', name='DisplayItem', params='x') }} +: Valid range 1-6. Returns information on one of the 6 possible item windows open. + +### {{ renderMember(type='DisplayItem', name='DisplayItem', params='<itemname>') }} +: Return the Item display window for the specified item name, if one exists. + +[DisplayItem]: datatype-displayitem.md diff --git a/plugins/core-plugins/labels/index.md b/plugins/core-plugins/labels/index.md new file mode 100644 index 000000000..66c4fe59a --- /dev/null +++ b/plugins/core-plugins/labels/index.md @@ -0,0 +1,140 @@ +--- +tags: + - plugin +--- +# Labels + +This plugin allows you to use MQ2Data within your EQ UI. + +* It provides a number of EQTypes that can be used exactly as you use the built-in EQTypes. +* If there is not a suitable EQType for your use, you can use ToolTips to display custom information. + +## MQ EQTypes + +* **1000:** `${Me.CurrentMana}` +* **1001:** `${Me.MaxMana}` +* **1002:** `${Me.CurrentHP}` +* **1003:** `${Me.MaxHP}` +* **1004:** `${Me.CurrentEndurance}` +* **1005:** `${Me.MaxEndurance}` +* **1006:** `${Me.CurrentMana}` +* **1007:** `${Me.MaxMana}` +* **1008:** `${Me.CurrentHP}` +* **1009:** `${Me.MaxHP}` +* **1008:** `${Me.Dar}` +* **1009:** `${Me.Cash}` +* **1010:** `${Me.CashBank}` +* **1011:** `${Me.Platinum}` +* **1012:** `${Me.PlatinumShared}` +* **1013:** `${Me.Gold}` +* **1014:** `${Me.SilverBank}` +* **1015:** `${Me.CopperBank}` + +* **2000:** `${Target.Level}` +* **2001:** `${Target.Class}` +* **2002:** `${Target.Race}` +* **2003:** `${Target.Distance}` +* **2004:** _none_ +* **2005:** `${Target.State}` +* **2006:** `${Target.X}` +* **2007:** `${Target.Y}` +* **2008:** `${Target.Z}` +* **2009:** `${Target.Heading}` +* **2010:** `${Target.Speed}` +* **2011:** `${Target.ID}` + +* **3000:** `${Zone}` +* **3001:** _none_ +* **3002:** `${Me.Bound}` +* **3003:** `${Time.Time24}` +* **3004:** `${Time.Hour}` +* **3005:** `${Time.Minute}` +* **3006:** `${Time.Second}` +* **3007:** `${Time.Date}` +* **3008:** `${Time.Year}` +* **3009:** `${Time.Month}` +* **3010:** `${Time.Day}` +* **3011:** `${If[${Spawn[gm].ID},TRUE,FALSE]}` +* **3012:** `${Me.FreeInventory}` + +### Example + +```xml +<Label item ="Target_Level"> + <ScreenID>TargetLevel</ScreenID> + <EQType>2000</EQType> + <Font>2</Font> + <RelativePosition>true</RelativePosition> + <Location> + <X>24</X> + <Y>33</Y> + </Location> + <Size> + <CX>22</CX> + <CY>14</CY> + </Size> + <Text>0</Text> + <TextColor> + <R>255</R> + <G>255</G> + <B>0</B> + </TextColor> + <NoWrap>true</NoWrap> + <AlignCenter>false</AlignCenter> + <AlignRight>true</AlignRight> + <AlignLeft>false</AlignLeft> + </Label> +``` + +## Using Tooltips + +Tooltips can be used to add any information (even information from plugins or macros) that doesn't have a built-in EQType. You add the EQType of 9999 and then add the MQ2Data string that gives you your required information within the + +```xml +<EQType>9999</EQType> + <TooltipReference>${variable}</TooltipReference> +``` + +### Example + +```xml +<Label item ="BW_Buff0_Duration"> + <ScreenID>Buff0Duration</ScreenID> + <EQType>9999</EQType> + <TooltipReference>${Me.Buff1.Duration}</TooltipReference> + <Font>2</Font> + <RelativePosition>true</RelativePosition> + <Location> + <X>23</X> + <Y>3</Y> + </Location> + <Size> + <CX>153</CX> + <CY>14</CY> + </Size> + <Text></Text> + <TextColor> + <R>255</R> + <G>255</G> + <B>255</B> + </TextColor> + <NoWrap>true</NoWrap> + <AlignCenter>false</AlignCenter> + <AlignRight>false</AlignRight> + </Label> +``` + +### Note about ToolTipReference + +There are certain characters that are used in XML Code that are reserved. If these characters are used in the tooltipreference they will cause errors and the UI to fail loading. Most noteable of these characters is the `<` symbol. The `>` symbol can still be used for comparisons. So In cases where you would use `<`, rephase the statement to use `>` instead. The `&` character also causes problems. In case where you use a `&&` in your if statements use nested ifs to get around the problem. + +#### Example + +```xml +<TooltipReference>${If[${Target.ID} && ${Target.Casting},${Target.CleanName} is casting.,]}</TooltipReference> +``` +would become + +```xml +<TooltipReference>${If[${Target.ID},${If[${Target.Casting},${Target.CleanName} is casting.,]},]}</TooltipReference> +``` \ No newline at end of file diff --git a/plugins/core-plugins/map/README.md b/plugins/core-plugins/map/README.md new file mode 100644 index 000000000..f245e06b2 --- /dev/null +++ b/plugins/core-plugins/map/README.md @@ -0,0 +1,24 @@ +--- +tags: + - plugin +--- +# Map + +## Description + +This plugin provides additional functionality to the in game map. + +## Commands + +{{ embedCommand('plugins/core-plugins/map/highlight.md') }} +{{ embedCommand('plugins/core-plugins/map/mapclick.md') }} +{{ embedCommand('plugins/core-plugins/map/mapfilter.md') }} +{{ embedCommand('plugins/core-plugins/map/maphide.md') }} +{{ embedCommand('plugins/core-plugins/map/mapnames.md') }} +{{ embedCommand('plugins/core-plugins/map/mapshow.md') }} +{{ embedCommand('plugins/core-plugins/map/mapactivelayer.md') }} +{{ embedCommand('plugins/core-plugins/map/maploc.md') }} + +## Top-Level Objects + +{{ embedMQType('plugins/core-plugins/map/tlo-mapspawn.md') }} \ No newline at end of file diff --git a/plugins/core-plugins/map/highlight.md b/plugins/core-plugins/map/highlight.md new file mode 100644 index 000000000..5b0e16237 --- /dev/null +++ b/plugins/core-plugins/map/highlight.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /highlight + +## Syntax + +```eqcommand +/highlight [reset | <spawnfilter> | size | pulse | [color # # #]] +``` + +## Description + +Highlights the specified spawn(s) on the in-game map. Accepts partial names or any terms from [Spawn search](../../../reference/general/spawn-search.md). You can also specify a color, font size, and pulse for the highlight. \ No newline at end of file diff --git a/plugins/core-plugins/map/mapactivelayer.md b/plugins/core-plugins/map/mapactivelayer.md new file mode 100644 index 000000000..c1904c8fc --- /dev/null +++ b/plugins/core-plugins/map/mapactivelayer.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /mapactivelayer + +## Syntax + +```eqcommand +/mapactivelayer [0 | 1 | 2 | 3] +``` + +## Description + +Changes active map layer. diff --git a/plugins/core-plugins/map/mapclick.md b/plugins/core-plugins/map/mapclick.md new file mode 100644 index 000000000..f59dd0f59 --- /dev/null +++ b/plugins/core-plugins/map/mapclick.md @@ -0,0 +1,40 @@ +--- +tags: + - command +--- +# /mapclick + +## Syntax + +```eqcommand +/mapclick [left] {list|<key[+key[...]]> {clear|<command>}} +``` + +## Description + +Define custom commands to execute when clicking on an in-game map object while holding down a specific key combination. + +## Options +* `left` - Left-click (default is right-click) +* `list` - List the current mapclicks that have been defined. +* *`key`* can be one or more of the following (multiple keys must be specified with +): + - ctrl + - lalt + - alt (same as lalt) + - ralt + - shift + +## Default Mapclicks + +| Mapclick | Command | Description | +| :--- | :--- | :--- | +| **ctrl** | /maphide id %i | Hides that spawn from the map | +| **lalt** | /highlight id %i | Highlights the clicked spawn | + +## Example + +```text +/mapclick lalt+shift /mycommand %i +``` + +When holding down the left alt, shift and then right-clicking a spawn on the map, "/mycommand %i" will be executed. diff --git a/plugins/core-plugins/mq2map/mapfilter.md b/plugins/core-plugins/map/mapfilter.md similarity index 50% rename from plugins/core-plugins/mq2map/mapfilter.md rename to plugins/core-plugins/map/mapfilter.md index c1fedbda7..8683163a2 100644 --- a/plugins/core-plugins/mq2map/mapfilter.md +++ b/plugins/core-plugins/map/mapfilter.md @@ -6,58 +6,61 @@ tags: ## Syntax -**/mapfilter help\|**_**option**_ **\[show\|hide\] \[color R\# G\# B\#\]** +```eqcommand +/mapfilter <filter> [show|hide] [color <R# G# B#>] +``` ## Description -This controls what appears or does not appear on the in-game map provided by [MQ2Map](./). +This controls what appears or does not appear on the in-game map. There's a nice GUI for these filters in [/mqsettings](../../../reference/commands/mqsettings.md). -* **Help** will show all current settings. -* _**Option**_ can be one of the following followed by "show" or "hide". If no show/hide argument is given, it will +## Options - toggle the setting between show and hide. +* **`help`** will show all current settings. +* _**`<filter>`**_ can be one of the following, -| | | +| filter | description | | :--- | :--- | | **All** | Shows/hides all map items **that have already been set to "show".** | | **Aura** | Show/hide auras. | | **Banner** | Show/hide guild banner. | | **Campfire** | Show/hide campfire. | -| **CastRadius \#** | Show a cast radius circle around your own spawn on the map. Set to "hide" or "0" to disable. | +| **CampRadius #** | Sets radius of camp circle to #. +| **CastRadius #** | Show a cast radius circle around your own spawn on the map. Set to "hide" or "0" to disable. | | **Chest** | Show/hide chests. | -| **Corpse** | Master toggle to show/hide all corpses \(PC and NPC\). | -| **Custom** _**searchfilter**_ | Set a custom filter, which can contain any filtering arguments from the [Spawn Search](../../../reference/general/spawn-search.md) page. | +| **Corpse** | Master toggle to show/hide all corpses (PC and NPC). | +| **Custom** _**searchfilter**_ | Set a custom filter, which can contain any filtering arguments from the [Spawn Search](../../../reference/general/spawn-search.md) page. Note: The use of custom is a one time event, it is not persistent. | | **Group** | Whether group members should be listed in another color. | | **Ground** | Show/hide ground spawns. | -| **Merceneary** | Show/hide mercenaries. | +| **Marker** _`<filter> <shape> [#]`_ | Change the marker shape for specified spawns. Passing a number at the end will change shape size. Accepted shapes: none/triangle/square/diamond. | +| **Mercenary** | Show/hide mercenaries. | | **Menu** | Enable or disable the right-click context menu | | **Mount** | Show/hide mounts. | -| **Named** | Displays only 'named' NPCs, other NPCs are filtered out \(not perfect\). | -| **NormalLabels** | Toggles normal EQ \(non-MQ2\) label display. | +| **Named** | Displays only 'named' NPCs, other NPCs are filtered out (not perfect). | +| **NormalLabels** | Toggles normal EQ (non-MQ2) label display. | | **NPC** | Show/hide all NPCs. | | **NPCConColor** | Whether the dots on the map should be the same as the NPCs con colors. | | **NPCCorpse** | Show/hide NPC corpses. | -| **Object** | Show/hide destructible objects \(as were implemented in Prophecy of Ro expansion\), like catapults, tents, practice dummies, etc. | +| **Object** | Show/hide destructible objects (as were implemented in Prophecy of Ro expansion), like catapults, tents, practice dummies, etc. | | **PC** | Show/hide all Player Characters. | | **PCConColor** | Whether the dots on the map should be the same as the PCs con colors. | | **PCCorpse** | Show/hide Player corpses. | | **Pet** | Show/hide pets. | -| **SpellRadius \#** | Show another radius circle around your own spawn. Functions the same way as **CastRadius**. | +| **PullRadius #** | Sets radius of casting circle to # (omit or set to 0 to disable) | +| **SpellRadius #** | Show another radius circle around your own spawn. Functions the same way as **CastRadius**. | | **Target** | Show your target in a different color. | | **TargetLine** | Draw a line between yourself and your target. | | **TargetMelee** | Draw a melee range circle around your target. | -| **TargetRadius \#** | Draw a radius of \# around your target. Using "hide" or "0" will disable the TargetRadius circle. | +| **TargetPath** | Draws EQ path to selected target. | +| **TargetRadius #** | Draw a radius of # around your target. Using "hide" or "0" will disable the TargetRadius circle. | | **Timer** | Show/hide timers. | | **Trigger** | Show/hide trigger locations. | | **Trap** | Show/hide traps. | -| **Vector** | Display heading vectors. | | **Untargettable** | Show/hide untargettable spawns. | +| **Vector** | Display heading vectors. | -* Any of the above options can have "color R\# G\# B\#" added to them, to set the color for that specific option. Omit - - the R\# G\# B\# values to reset them back to default. - -**Note:** The use of custom is a one time event, it is not persistent. +* **`show|hide`** will toggle the filter between show and hide. +* **`color <R# G# B#>`** will set the color for the filter. Omit the R# G# B# values to reset. ## Examples @@ -81,10 +84,6 @@ To restore the settings saved in your ini and remove your custom filters use the ## Troubleshooting -**Question:** - -My map is no different than normal and /mapfilter all had no effect, what did I do wrong? - -**Answer:** +??? question "My map is no different than normal and `/mapfilter all` had no effect, what did I do wrong?" -Each individual filter needs to be turned on individually, _/mapfilter all show_ does not toggle all filters to "show" as might be expected. + The `/mapfilter all show` command only affects map items that have *already* been individually set to "show". It does not enable all filters simultaneously as might be expected. You need to enable each desired filter type individually first (e.g., `/mapfilter npc show`, `/mapfilter pc show`, etc.) before `/mapfilter all show` will display them. diff --git a/plugins/core-plugins/map/maphide.md b/plugins/core-plugins/map/maphide.md new file mode 100644 index 000000000..569aa9bf8 --- /dev/null +++ b/plugins/core-plugins/map/maphide.md @@ -0,0 +1,29 @@ +--- +tags: + - command +--- +# /maphide + +## Syntax + +```eqcommand +/maphide [<spawnsearch> | reset | repeat] +``` + +## Description + +This will hide spawns from the map, using [Spawn search](../../../reference/general/spawn-search.md). Hidden spawns are in effect until you reset /maphide, or the mapped spawns are regenerated (such as changing certain map filters). + +## Examples + +* Re-generates the spawn list + + ```text + /maphide reset + ``` + +* Hides all spawns level 39 and below + + ```text + /maphide npc range 1-39 + ``` diff --git a/plugins/core-plugins/map/maploc.md b/plugins/core-plugins/map/maploc.md new file mode 100644 index 000000000..d843a57d7 --- /dev/null +++ b/plugins/core-plugins/map/maploc.md @@ -0,0 +1,63 @@ +--- +tags: + - command +--- +# /maploc + +## Syntax + +```eqcommand +/maploc <x> <y> [<z>] [options] | [options] +``` + +## Description + +Places a big X on a location or target. Helpful when you're given a loc and want to see it on the map. It's as simple as `/maploc 1 2 3` + +## Options + +* **size `<10-200>`** + Determines size of the X. + +* **width `<1-10>`** + Determines width of the X. + +* **color `<r g b>`** + The color of the X. + +* **radius `<distance>`** + The size of the circle radius around the X. + +* **rcolor `<r> <g> <b>`** + The color of the radius. + +* **`<yloc> <xloc> [<zloc>]`** + The location you'd like the X to appear. Z axis is optional. + +* **target** + Rather than placing the X on a location, this will place it on a target. + +* **label `<text>`** + Adds a label to the X. Must come at the end of syntax. + +* **remove `[<index> | <loc>]`** + Removes all X's if no option is passed. Indexes may be found on the map, in the center of each X. + +## Examples + +* You find a loc on allakhazam, and decide to put a big red X on it: +```bash +/maploc -690 625 -153 +``` +* If you zoom in on the red X you just made, you can see its index number: 1. Now remove it, +```bash +/maploc remove 1 +``` +* Return the red X, and label the location with "treasure!" +```bash +/maploc -690 625 -153 label treasure! +``` +* Make a very big orange X, with a 100 hot-pink radius ring around it, placed on your current target, labeled "wander" +```bash +/maploc size 200 width 8 radius 100 color 255 128 0 rcolor 255 51 255 target label wander +``` diff --git a/plugins/core-plugins/map/mapnames.md b/plugins/core-plugins/map/mapnames.md new file mode 100644 index 000000000..83ab5a20a --- /dev/null +++ b/plugins/core-plugins/map/mapnames.md @@ -0,0 +1,53 @@ +--- +tags: + - command +--- +# /mapnames + +## Syntax + +```eqcommand +/mapnames {target | normal} <option> | reset +``` + +## Description + +Controls how spawn names are displayed on the map, from minimal information to a very log name with ID#, class, race, level, etc. With no arguments, /mapnames will display the current settings for _target_ and _normal_ (both are set to %N by default). + +## Options +* **target**: Changes the naming scheme of your target only. +* **normal**: Changes the naming scheme of all spawns except for your target. + +!!! note + It is important to note that names **are not** updated continually (except for your target if the target map filter is on). + +* You may use the following _options_ to customize the display string: + +| Option | Description | +| :----- | :------------------------------ | +| %n | Default unique name (a_coyote34) | +| %N | Cleaned up name (a coyote) | +| %h | Current HP percentage | +| %i | Spawn ID | +| %x | X coordinate | +| %y | Y coordinate | +| %z | Z coordinate | +| %R | Full race name (eg. Dwarf) | +| %r | 3-letter race code (eg. DWF) | +| %C | Class full name (eg. Shaman) | +| %c | 3-letter class code (eg. SHM) | +| %l | Level | +| %% | Literal "%" sign | + +## Examples + +```text +/mapnames normal [%l %R %C] %N - %h%% +``` + +Will display all spawns in the following format: + +```text +[40 Human Banker] Banker Tawler - 100% +[70 Wood Elf Ranger] BillyBob - 100% +``` diff --git a/plugins/core-plugins/map/mapshow.md b/plugins/core-plugins/map/mapshow.md new file mode 100644 index 000000000..97a51fc4a --- /dev/null +++ b/plugins/core-plugins/map/mapshow.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /mapshow + +## Syntax + +```eqcommand +/mapshow [<spawnsearch> | reset | repeat] +``` + +## Description + +This will show spawns on the map, using [Spawn search](../../../reference/general/spawn-search.md). Shown spawns are in effect until you reset /mapshow, or the mapped spawns are regenerated (such as changing certain map filters). Repeat will save the state and apply it to future sessions. diff --git a/plugins/core-plugins/map/tlo-mapspawn.md b/plugins/core-plugins/map/tlo-mapspawn.md new file mode 100644 index 000000000..2e78e5c01 --- /dev/null +++ b/plugins/core-plugins/map/tlo-mapspawn.md @@ -0,0 +1,17 @@ +--- +tags: + - tlo +--- +# `MapSpawn` + +Object that is created when your cursor hovers over a spawn on the map + +## Forms + +### {{ renderMember(type='spawn', name='MapSpawn') }} +: When your cursor hovers over a spawn, the spawn type is used. e.g. `/echo ${MapSpawn.Gender}` +### {{ renderMember(type='ground', name='MapSpawn') }} +: When your cursor hovers over a ground item, the ground type is used. e.g. `/invoke ${MapSpawn.Grab}` + +[spawn]: ../../../reference/data-types/datatype-spawn.md +[ground]: ../../../reference/data-types/datatype-ground.md diff --git a/plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaar.md b/plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaar.md deleted file mode 100644 index 2cdd06d02..000000000 --- a/plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaar.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -tags: - - datatype ---- -# DataType:bazaar - -## Members - -| | | -| :--- | :--- | -| [_bool_](../../../reference/data-types/datatype-bool.md) **Done** | Search complete? | -| [_int_](../../../reference/data-types/datatype-int.md) **Count** | Number of results | -| [_bazaaritem_](mq2bzsrch-datatype-bazaaritem.md) **Item\[**\#**\]** | Result info by index \(1-based\) | -| **To String** | Same as **Done** | diff --git a/plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaaritem.md b/plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaaritem.md deleted file mode 100644 index 52e55a826..000000000 --- a/plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaaritem.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -tags: - - datatype ---- -# DataType:bazaaritem - -## Members - -| | | -| :--- | :--- | -| [_string_]() **Name** | Item name | -| [_spawn_](../../../reference/data-types/datatype-spawn.md) **Trader** | The guy selling it | -| [_int_](../../../reference/data-types/datatype-int.md) **Price** | Price the guy is selling it for | -| [_int_](../../../reference/data-types/datatype-int.md) **Quantity** | Number of this item this guy has | -| [_int_](../../../reference/data-types/datatype-int.md) **ItemID** | The item's ID number | -| [_int_](../../../reference/data-types/datatype-int.md) **Value** | Value in the "Stat column" \(last column of the search window, eg. save vs fire, int, wis, etc\). **NOT** the value of the Item. Returns 0 if nothing is there. | -| **To String** | Same as **Name** | diff --git a/plugins/core-plugins/mq2bzsrch/mq2bzsrch-tlo-bazaar.md b/plugins/core-plugins/mq2bzsrch/mq2bzsrch-tlo-bazaar.md deleted file mode 100644 index 9a2b13a13..000000000 --- a/plugins/core-plugins/mq2bzsrch/mq2bzsrch-tlo-bazaar.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -tags: - - tlo ---- -# TLO:Bazaar - -## Description - -Object containing bazaar search data. - -## Forms - -* [_bazaar_](mq2bzsrch-datatype-bazaar.md) **Bazaar** - -## Access to Types - -* [_bazaar_](mq2bzsrch-datatype-bazaar.md) **bazaar** diff --git a/plugins/core-plugins/mq2chat.md b/plugins/core-plugins/mq2chat.md deleted file mode 100644 index 9053d3331..000000000 --- a/plugins/core-plugins/mq2chat.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2Chat - -## Description - -This plugin directs all of the MQ2 output to your main EQ chat window. **Be careful if doing a /report or /petition because MQ2 output will be visible in the /report lines that you send.** - -By default, MQ2 output is set to go to a separate MQ2 window, which is handled by the [MQ2ChatWnd](mq2chatwnd/) plugin. diff --git a/plugins/core-plugins/mq2chatwnd/README.md b/plugins/core-plugins/mq2chatwnd/README.md deleted file mode 100644 index 764282bd1..000000000 --- a/plugins/core-plugins/mq2chatwnd/README.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2ChatWnd - -This plugin adds an additional window to your UI which displays ALL information generated by MQ2. - -**Note:** Any information displayed or typed in this window will NOT go into your character log. It is invisible to EverQuest \(and invisible to /petitions and /reports too\). - -This plugin is setup by default and very much recommended. You can however use the [MQ2Chat](../mq2chat.md) plugin to force MQ2 information to the main EQ chat window if you wish to ignore this recommendation. - -## Commands - -* **/style \[!\]0xN** - -Set the style bit corresponding to 0xN or unset it if ! is supplied. See EQ documentation for further details about WindowStyle. - -* **/mqfont \#** - -Sets the font size on this window. **Note:** This is not the same as the EQ command /chatfontsize; /mqfont reduces the spacing between the lines of text within the window. - -* **/mqmin** - -Toggle the minimization of MQ2ChatWnd - -* **/mqclear** - -Clears the chat buffer of MQ2ChatWnd - -* **/mqchat reset** - -Resets the location and options for the MQ2 Chat window - -## Configuration - -MQ2ChatWnd stores a configuration file to the root MQ2 folder, _MQ2ChatWnd.ini_. This file stores the chat window position, color, title, and other settings for every character you create, by default. There are new user-configurable options that have been added: - -```text -[Settings] -AutoScroll=on -NoCharSelect=off -SaveByChar=on -``` - -* **AutoScroll** - - By default set to _on_, this automatically scrolls to the bottom of the chat window every time a new text line is displayed. If you set this option to _off_, the chat window will retain your current slider position rather than automatically scroll to the bottom. - -* **NoCharSelect** - - By default set to _off_, this displays the chat window at the character select screen. If you set this option to _on_, the chat window will only display when you have entered or re-entered the world. - -* **SaveByChar** - - By default set to _on_, this creates a new INI entry for every character that you log in so that each character uses its own window position and settings. If you set this option to _off_, a single \[Default\] section will be created and all characters will use the same window position and settings. - -## Key Binding - -MQ2 creates a key binding for MQ2ChatWnd by default \(the . key\). This entry is created in a similar manner to the /bind command, and will create an entry in your [MacroQuest.ini](../../../main/macroquest.ini.md) file under the \[Key Binds\] section. The default entry is given the name _MQ2CHAT\_Nrm_, and may be changed by the user prior to starting MQ2, or using the /bind command. diff --git a/plugins/core-plugins/mq2chatwnd/mqfont.md b/plugins/core-plugins/mq2chatwnd/mqfont.md deleted file mode 100644 index 9524731ff..000000000 --- a/plugins/core-plugins/mq2chatwnd/mqfont.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -tags: - - command ---- -# /mqfont - -## Syntax - -**/mqfont \#** - -## Description - -Changes the size of the font in the MQ2ChatWnd. - -**Notes** - -* The font sizes are not the same as EQ's chat window sizes -* Suggested use: numbers in the range of _-3_ to _2_ - diff --git a/plugins/core-plugins/mq2custombinds/README.md b/plugins/core-plugins/mq2custombinds/README.md deleted file mode 100644 index d3ee1ed28..000000000 --- a/plugins/core-plugins/mq2custombinds/README.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2CustomBinds - -This plugin allows you to specify custom commands that are executed when specific key combinations are pressed. - -You may specify a command for when the key is pressed \(down\), and another for when it is released \(up\). - -## Commands - -[/custombind](custombind.md) diff --git a/plugins/core-plugins/mq2hud/README.md b/plugins/core-plugins/mq2hud/README.md deleted file mode 100644 index fa326f03a..000000000 --- a/plugins/core-plugins/mq2hud/README.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2HUD - -This plugin provides a Heads Up Display for your EQ window, which can provide a large amount of information in a relatively small amount of space. The HUD acts as a transparent background layer, upon which any information can be displayed. Each element of the HUD gets parsed each time MQ2Data is displayed, so there is no need to reload the HUD after making changes to the .ini file, they are instantly available as soon as you save. - -The HUD is customized by entries in the MQ2HUD.ini file. The .ini file allows any number of HUDs to be created and saved within. Loading a new HUD from the .ini file can be done with `/loadhud`. The entry names are not case-sensitive. - -The default HUD entry is called \[Elements\] and can be loaded with the `/defaulthud` command. - -You can toggle the display of the HUD by using F11. - -## Commands - -* [/hud](hud.md) -* [/loadhud](loadhud.md) -* [/defaulthud](defaulthud.md) -* [/classhud](classhud.md) -* [/zonehud](zonehud.md) - -## Top-Level Objects - -* [_string_]() **HUD** - -Name of currently loaded HUD - -## INI File Format - -Entries in the MQ2HUD.ini file are in the following format: - -`[Elements]` -`TYPE,X,Y,RED,GREEN,BLUE,TEXT` - -* **TYPE** can be a combination of the following \(just add the numbers\): - * **1:** Display in non-fullscreen mode - * **2:** Display in fullscreen mode \("F10 mode"\) - * **4:** Based on cursor location - * **8:** Display at charselect - * **16:** Only parse if a macro IS running -* **X** and **Y** denote the location of the entry on the screen \(0,0 is the upper left of your screen\) -* **RED**, **GREEN** and **BLUE** are RGB values for the **TEXT** color \(255,255,255 is white; 0,0,0 is black\) -* **TEXT** is the MQ2Data you wish to display. As a tip, the [If](../../../reference/top-level-objects/tlo-if.md) TLO is very useful here. - -## Examples - -`[Elements]` -`TargetInfo=3,5,35,255,255,255,${Target}` -`GMIndicator=3,5,45,0,0,255,${Spawn[gm]}` -`CursorItemName=7,-15,-15,255,255,255,${If[${Cursor.ID},${Cursor},]}` -`ClickMeForFun=6,-25,-25,255,255,255,${If[!${Cursor.ID},click me,]}` -`MacroName=19,5,70,255,255,255,${If[${Bool[${Macro}]}, Current Macro Running - ${Macro},]}` - -In the above HUD, the _CursorItemName_ entry states that it will show the name of your cursor item in all modes. Using 6 as the **TYPE** will display the cursor in full-screen mode only. - -`/loadhud bard` - -This will load the \[bard\] section of the MQ2HUD.ini. - -## Code Segments - -This section contains code segments to help you customize your HUD. Please be sure to substitute the X, Y cords for the location you'd like to see them on your HUD. - -`//AAXP` -`AAXPText=3,X,Y,255,234,8,AAXP` -`AAXP=3,X,Y,255,234,8,${Me.PctAAExp}` - -`//AttackSpeed` -`AttackSpeedText=3,X,Y,255,234,8,AttackSpeed :` -`AttackSpeed=3,X,Y,255,234,8,${Me.AttackSpeed}` - -`//Date` -`Datetext=3,X,Y,255,234,8,Todays Date Is` -`Date=3,X,Y,255,234,8,${Time.Date}` - -`//Damage Absorb Left` -`DamageShieldText=3,X,Y,255,234,8,Dmg Abs. Left` -`DamageShield=3,X,Y,255,234,8,${Me.Dar}` - -`//Vet AA's` -`ThroneText=3,500,402,255,234,8,GL Port - - - -` -`ThroneReadyText=3,610,402,0,255,0,${If[${Me.AltAbilityReady[Throne Of Heroes]},Ready,]}` -`ThroneNotReady=3,610,402,255,0,0,${If[!${Me.AltAbilityReady[Throne Of Heroes]},${Me.AltAbilityTimer[Throne Of Heroes].TimeHMS},]}` - -`//what macro is currently running` -`Macro1=3,110,110,0,250,0,${If[${Macro.Name.NotEqual["NULL"]},${Macro.Name},]}` -`Macro2=3,10,110,225,250,225,MACRO RUNNING =` - -`//if the macro Raid Druid (Autobot) is currently paused` -`RDPauseInd1=3,10,122,225,250,225,RD PAUSED =` -`RDPauseInd2=3,85,122,225,0,0,${RDPause}` diff --git a/plugins/core-plugins/mq2hud/classhud.md b/plugins/core-plugins/mq2hud/classhud.md deleted file mode 100644 index 02857eece..000000000 --- a/plugins/core-plugins/mq2hud/classhud.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -tags: - - command ---- -# /classhud - -## Syntax - -**/classhud** - -## Description - -* Loads the HUD section for your class -* You must have a \[_class_\] section in MQ2HUD.ini diff --git a/plugins/core-plugins/mq2hud/loadhud.md b/plugins/core-plugins/mq2hud/loadhud.md deleted file mode 100644 index 2518ae453..000000000 --- a/plugins/core-plugins/mq2hud/loadhud.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -tags: - - command ---- -# /loadhud - -## Syntax - -**/loadhud** _**hudname**_ - -## Description - -Load the specified HUD defined in MQ2HUD.ini diff --git a/plugins/core-plugins/mq2hud/zonehud.md b/plugins/core-plugins/mq2hud/zonehud.md deleted file mode 100644 index eeb05f7fd..000000000 --- a/plugins/core-plugins/mq2hud/zonehud.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -tags: - - command ---- -# /zonehud - -## Syntax - -'''/zonehud - -## Description - -* Loads the HUD section for your current zone -* You must have a \[_zone_\] section in MQ2HUD.ini diff --git a/plugins/core-plugins/mq2itemdisplay/README.md b/plugins/core-plugins/mq2itemdisplay/README.md deleted file mode 100644 index 5a72a563c..000000000 --- a/plugins/core-plugins/mq2itemdisplay/README.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2ItemDisplay - -## Description - -This plugin shows spell and item data in the item display window. - -\(MQ2GearScore has since been merged with MQ2itemdisplay\) - -## Commands - -[**/inote**](inote.md) **"Comment"** Add/delete a note to a specific item number. This information will be displayed within the item info window, under all the other information. - -### - -## Top-Level Objects - -* [_item_](../../../reference/data-types/datatype-item.md) **DisplayItem** - -This references the last item display window that was opened. - -## INI File - -All the /inote information is stored in the MQ2ItemDisplay.ini file in the following format: - -```text -[Notes] -0019542=This is found on the Great Saprophyte in EC<nowiki><br></nowiki>Rarity is about 1 in 5 -``` - -The `<br>` tag can be used to insert a line break. Sometimes it is easier to edit the file itself rather than type the whole string from within the game \(also makes copying and pasting easier\). The INI file is re-read every time the item display window is opened, so changes take effect immediately. - -## Example - -In the following example, the line is broken into 4 for readability, in the MQ2ItemDisplay.ini file, it would all be 1 line. - -`0017910<br>Field.....Round....Large....Wood....16<br>Field.....Round....Medium.Wood...36<br>Field.....Parab.....Large....Wood...46<br>Field.....Round....Small...Wood....56<br>Field.....Round....Large...Bone.....68<br>Field.....Shield....Large...Wood....82<br>Hooked.Round....Large...Wood....102<br>Field.....Wood*...Large...Wood....122<br>Field.....Round....Large..Ceramic.135<br>Field.....Bone*....Large..Wood.....162<br>Silver....Round....Large..Wood.....182<br>Field....Ceramic*.Large..Wood.....202` - -The info displayed would look like this: -**Note: -Field.....Round....Large....Wood....16 -Field.....Round....Medium.Wood...36 -Field.....Parab.....Large....Wood...46 -Field.....Round....Small...Wood....56 -Field.....Round....Large...Bone.....68 -Field.....Shield....Large...Wood....82 -Hooked.Round....Large...Wood....102 -Field.....Wood\*...Large...Wood....122 -Field.....Round....Large..Ceramic.135 -Field.....Bone\*....Large..Wood.....162 -Silver....Round....Large..Wood.....182 -Field....Ceramic\*.Large..Wood.....202** - -See [here](https://macroquest2.com/phpBB3/viewtopic.php?t=11549) and [here](https://macroquest2.com/phpBB3/viewtopic.php?t=12022) \(VIP only\) for some user-contributed ini file entries. - diff --git a/plugins/core-plugins/mq2labels.md b/plugins/core-plugins/mq2labels.md deleted file mode 100644 index 61a6ddd16..000000000 --- a/plugins/core-plugins/mq2labels.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2Labels - -## Description - -This plugin allows you to use MQ2Data within your EQ UI. - -* It provides a number of EQTypes that can be used exactly as you use the built-in EQTypes. -* If there is not a suitable EQType for your use, you can use ToolTips to display custom information. - -## MQ EQTypes - -* **1000:** ${Me.CurrentMana} -* **1001:** ${Me.MaxMana} -* **1002:** ${Me.State} -* **1003:** ${Me.Speed} -* **1004:** ${Me.Heading} -* **1005:** ${Me.X} -* **1006:** ${Me.Y} -* **1007:** ${Me.Z} -* **1008:** ${Me.Dar} -* **1009:** ${Me.Cash} -* **1010:** ${Me.CashBank} -* **1011:** ${Me.Platinum} -* **1012:** ${Me.PlatinumShared} -* **1013:** ${Me.Gold} -* **1014:** ${Me.SilverBank} -* **1015:** ${Me.CopperBank} - -\* **2000:** ${Target.Level} - -* **2001:** ${Target.Class} -* **2002:** ${Target.Race} -* **2003:** ${Target.Distance} -* **2004:** _none_ -* **2005:** ${Target.State} -* **2006:** ${Target.X} -* **2007:** ${Target.Y} -* **2008:** ${Target.Z} -* **2009:** ${Target.Heading} -* **2010:** ${Target.Speed} -* **2011:** ${Target.ID} - -\* **3000:** ${Zone} - -* **3001:** _none_ -* **3002:** ${Me.Bound} -* **3003:** ${Time.Time24} -* **3004:** ${Time.Hour} -* **3005:** ${Time.Minute} -* **3006:** ${Time.Second} -* **3007:** ${Time.Date} -* **3008:** ${Time.Year} -* **3009:** ${Time.Month} -* **3010:** ${Time.Day} -* **3011:** ${If\[${Spawn\[gm\].ID},TRUE,FALSE\]} -* **3012:** ${Me.FreeInventory} - -### Example - -TargetLevel2000 2true243322140255255 **0**truefalsetruefalse - -## Using Tooltips - -Tooltips can be used to add any information \(even information from plugins or macros\) that doesn't have a built-in EQType. You add the EQType of 9999 and then add the MQ2Data string that gives you your required information within the - -tags.\`9999\`\`${variable}\` - -### Example - -Buff0Duration9999${Me.Buff1.Duration} 2true23315314255255 **255**truefalsefalse - -### Note about ToolTipReference - -There are certain characters that are used in XML Code that are reserved. If these characters are used in the tooltipreference they will cause errors and the UI will fail to load. The most notable of these characters is the "\<" symbol. The ">" symbol can still be used for comparisons. So In cases where you would use "\<", rephase the statement to use ">" instead. The "&" character also causes problems. In the case where you use a "&&" in your if statements use nested ifs to get around the problem. - -#### Example - -${If\[${Target.ID} && ${Target.Casting},${Target.CleanName} is casting.,\]} - -would become - -${If\[${Target.ID},${If\[${Target.Casting},${Target.CleanName} is casting.,\]},\]} diff --git a/plugins/core-plugins/mq2map/README.md b/plugins/core-plugins/mq2map/README.md deleted file mode 100644 index 0d124a564..000000000 --- a/plugins/core-plugins/mq2map/README.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -tags: - - plugin ---- -# MQ2Map - -## Description - -This plugin provides additional functionality to the in game map. - -## Commands - -* [/highlight](highlight.md) -* [/mapclick](mapclick.md) -* [/mapfilter](mapfilter.md) -* [/maphide](maphide.md) -* [/mapnames](mapnames.md) -* [/mapshow](mapshow.md) - -## Top-Level Objects - -* [_spawn_](../../../reference/data-types/datatype-spawn.md) **MapSpawn** - -Object that is created when your cursor hovers over a spawn on the map diff --git a/plugins/core-plugins/mq2map/highlight.md b/plugins/core-plugins/mq2map/highlight.md deleted file mode 100644 index e11f58d90..000000000 --- a/plugins/core-plugins/mq2map/highlight.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -tags: - - command ---- -# /highlight - -## Syntax - -**/highlight** _**spawnname**_ **\[color \# \# \#\] \[reset\]** - -## Description - -* Temporarily highlights _spawnname_ on the in-game map -* Color \# \# \# can be used to specify an RGB value for the highlighted spawn\(s\) -* **Note:** You can use [Spawn Search](../../../reference/general/spawn-search.md) filters in _spawnname_ - diff --git a/plugins/core-plugins/mq2map/mapclick.md b/plugins/core-plugins/mq2map/mapclick.md deleted file mode 100644 index 876808a5b..000000000 --- a/plugins/core-plugins/mq2map/mapclick.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -tags: - - command ---- -# /mapclick - -## Syntax - -**/mapclick \[ list \|** _**keycombo**_ **\| clear \]** _**command**_ - -## Description - -Allows you to define custom _commands_ to execute when right-clicking with a certain key combination on the in-game map. - -* List will show you the current mapclicks that have been defined. -* _Keycombo_ can be one or more of the following \(multiple keys must be specified with +\): - * ctrl - * lalt - * ralt - * shift -* The default mapclicks are the following: - -| | | | -| :--- | :--- | :--- | -| **ctrl** | /maphide id %i | Hides that spawn from the map | -| **lalt** | /highlight id %i | Highlights the clicked spawn | - -## Example - -```text -/mapclick lalt+shift /mycommand %i -``` - -When holding down the left alt, shift and then right-clicking a spawn on the map, "/mycommand %i" will be executed. diff --git a/plugins/core-plugins/mq2map/maphide.md b/plugins/core-plugins/mq2map/maphide.md deleted file mode 100644 index f0cc9f7df..000000000 --- a/plugins/core-plugins/mq2map/maphide.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -tags: - - command ---- -# /maphide - -## Syntax - -**/maphide** _**spawnname**_ **\[reset\]** - -## Description - -This will hide _spawnname_ from the map. Hidden spawns are in effect until you reset /maphide, or the mapped spawns are regenerated \(such as changing certain map filters\). - -## Examples - -* Re-generates the spawn list - - ```text - /maphide reset - ``` - -* Hides all spawns level 39 and below - - ```text - /maphide npc range 1-39 - ``` diff --git a/plugins/core-plugins/mq2map/mapnames.md b/plugins/core-plugins/mq2map/mapnames.md deleted file mode 100644 index 94e9bdcf2..000000000 --- a/plugins/core-plugins/mq2map/mapnames.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -tags: - - command ---- -# /mapnames - -## Syntax - -**/mapnames \[help\] \[ target\|normal** _**options**_ **\]** - -## Description - -Sets how spawn names will be displayed on the MQ2 map, for your target or all other spawns. -\*This command takes a parameter specifying normal/target, and then an optional custom string. - -* With no arguments, /mapnames will display the current settings for _target_ and _normal_ \(both are set to %N by - - default\). - -* The plugin will replace the %l %r %c %N _options_ with a piece of information. -* Each option is **case sensitive** and exactly one character in length. -* It is important to note that names **are not** updated continually \(except for your target if the target map filter - - is on\). - -* You may use the following _options_ to customize the display string: - -{\| border="1" cellpadding="2" cellspacing="0" \|**%n** \|The default unique "name" of the target, like "a\_coyote34" \|- \|**%N** \|The cleaned up name of the target, like "a coyote" \|- \|**%h\***\|Current HP percentage \|- \|**%i\*** \|Spawn ID \|- \|**%x\***\|X coordinate \|- \|**%y\*** \|Y coordinate \|- \|**%z\***\|Z coordinate \|- \|**%R\*** \|Full race name \(eg. Dwarf\) \|- \|**%r\***\|3-letter race code \(eg. DWF\) \|- \|**%C\*** \|Class full name \(eg. Shaman\) \|- \|**%c\***\|3-letter class code \(eg. SHM\) \|- \|**%l\*** \|Level \|- \|**%%**'' \|"%" sign \|} **Note:** All other characters will be displayed as normal. - -## Examples - -```text -/mapnames normal [%l %R %C] %N - %h%% -``` - -Will display all spawns in the following format: - -```text -[40 Human Banker] Banker Tawler - 100% -[70 Wood Elf Ranger] BillyBob - 100% -``` diff --git a/plugins/core-plugins/mq2map/mapshow.md b/plugins/core-plugins/mq2map/mapshow.md deleted file mode 100644 index 53ba57c1c..000000000 --- a/plugins/core-plugins/mq2map/mapshow.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -tags: - - command ---- -# /mapshow - -## Syntax - -**/mapshow** _**spawnname**_ **\[reset\]** - -## Description - -Explicitly shows _spawnname_ on the map. Only in effect until the mapped spawns are re-generated \(same as /maphide\) - -## Examples diff --git a/plugins/core-plugins/targetinfo/index.md b/plugins/core-plugins/targetinfo/index.md new file mode 100644 index 000000000..ebe201c5b --- /dev/null +++ b/plugins/core-plugins/targetinfo/index.md @@ -0,0 +1,54 @@ +--- +tags: + - plugin +--- +# TargetInfo + +## Description + +Distance, line of sight and place-holder info directly on target. + +## Commands + +{{ embedCommand('plugins/core-plugins/targetinfo/targetinfo.md') }} + +## Settings + +Example configuration: + +```ini title="mq2targetinfo.ini" +[Default] +UsePerCharSettings=0 +; Use unique settings for each character +ShowDistance=1 +; Show distance to target +DistanceLabelToolTip=Target Distance +; Customize the tooltip text when you hover over target distance +ShowTargetInfo=1 +; Show detailed target info +ShowPlaceholder=1 +; Show placeholder/named information +ShowSight=1 +; Toggle O/X based on line of sight + + +[UI_default] +Target_BuffWindow_TopOffset=76 +dTopOffset=60 +dBottomOffset=74 +dLeftOffset=50 + +CanSeeTopOffset=47 +CanSeeBottomOffset=61 + +TargetInfoWindowStyle=0 +TargetInfoAnchoredToRight=0 + +; These two labels are used as templates for distance. +Label1=Player_ManaLabel +Label2=Player_FatigueLabel + +TargetInfoLoc=34,48,0,40 +TargetDistanceLoc=34,48,90,0 +``` +Settings for additional UIs are included in the default ini, but not shown here as they frequently change. \ No newline at end of file diff --git a/plugins/core-plugins/targetinfo/targetinfo.md b/plugins/core-plugins/targetinfo/targetinfo.md new file mode 100644 index 000000000..25098545d --- /dev/null +++ b/plugins/core-plugins/targetinfo/targetinfo.md @@ -0,0 +1,26 @@ +--- +tags: + - command +--- +# /targetinfo + +## Syntax + +```eqcommand +/targetinfo [perchar | distance | info | placeholder | sight | reset | reload] [on|off] +``` + +## Description + +Toggle settings on the [Targetinfo plugin](index.md). + +## Options + +- **perchar [on|off]**: Use settings per character. +- **distance [on|off]**: Show distance to target. +- **info [on|off]**: Show detailed target info. +- **placeholder [on|off]**: Show placeholder/named information. +- **sight [on|off]**: Toggle O/X based on line of sight. +- **reset**: Resets the .ini to default, handy if you're using an old .ini from a previous version that was converted. +- **reload**: Reloads the settings from the .ini file. + diff --git a/plugins/core-plugins/xtarinfo/index.md b/plugins/core-plugins/xtarinfo/index.md new file mode 100644 index 000000000..74cb2eae6 --- /dev/null +++ b/plugins/core-plugins/xtarinfo/index.md @@ -0,0 +1,69 @@ +--- +tags: + - plugin +--- +# XTarInfo + +## Description + +XTarInfo adds distance and other information to the Extended Target Window + +## Commands + +{{ embedCommand('plugins/core-plugins/xtarinfo/xtarinfo.md') }} + +## Settings + +Example configuration: + +```ini title="MQ2XTarInfo.ini" +[Default] +UsePerCharSettings=0 + +ShowDistance=1 +DistanceLabelToolTip=XTarget Distance + +[UI_default] +UseExtLayoutBox=0 +ExtDistanceLoc=0,-20,70,0 +; This label is used as a template for distance. +LabelBaseXT=Player_ManaLabel + +[UI_Drakah] +; Custom settings built into plugin +ExtDistanceLoc=0,-20,80,0 +; End Built-In Settings + +[UI_Freq_SteelDragon] +; Custom settings built into plugin +ExtDistanceLoc=3,-10,70,28 +LabelBaseXT=PW_ManaLabel +; End Built-In Settings + +[UI_Melee] +; Custom settings built into plugin +ExtDistanceLoc=0,-20,90,0 +; End Built-In Settings + +[UI_RGInnerUI] +; Custom settings built into plugin +UseExtLayoutBox=1 +; End Built-In Settings + +[UI_sars] +; Custom settings built into plugin +UseExtLayoutBox=1 +ExtDistanceLoc=0,12,30,-20 +; End Built-In Settings + +[UI_Simple_SticeGroup] +; Can use defaults + +[UI_Sparxx] +; Custom settings built into plugin +ExtDistanceLoc=0,-10,80,0 +; End Built-In Settings + +[UI_zliz] +; Can use defaults +``` \ No newline at end of file diff --git a/plugins/core-plugins/xtarinfo/xtarinfo.md b/plugins/core-plugins/xtarinfo/xtarinfo.md new file mode 100644 index 000000000..117d25408 --- /dev/null +++ b/plugins/core-plugins/xtarinfo/xtarinfo.md @@ -0,0 +1,15 @@ +--- +tags: + - command +--- +# /xtarinfo + +## Syntax + +```eqcommand +/xtarinfo perchar [on | off] | distance [on | off] | reset | reload +``` + +## Description + +Toggle settings on the XTarInfo plugin. `perchar` will allow unique settings for each character, and `distance` will show distance to target. `reset` will reset the plugin to default settings, and `reload` will load settings from the plugin's config. From e19e8204f31385f852d4fb6be4c988f1e90772ce Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 26 Apr 2025 09:38:24 -0500 Subject: [PATCH 07/41] updating links and references to core plugins --- macros/README.md | 2 +- macros/beginners-guide-datatypes.md | 2 +- main/README.md | 8 +- main/features/custom-uis.md | 2 +- main/multiboxing.md | 2 +- mkdocs.yml | 124 +++++++++++------- plugins/README.md | 36 ++--- plugins/community-plugins/mq2eqbc/README.md | 6 +- plugins/community-plugins/mq2hudmove.md | 2 +- .../community-plugins/mq2moveutils/README.md | 4 +- reference/commands/README.md | 16 +-- reference/commands/spellslotinfo.md | 2 +- reference/data-types/datatype-item.md | 2 +- 13 files changed, 119 insertions(+), 89 deletions(-) diff --git a/macros/README.md b/macros/README.md index 38fa7e6ad..c5ce20531 100644 --- a/macros/README.md +++ b/macros/README.md @@ -1,6 +1,6 @@ # Macro Reference -The use of macros is what really makes MacroQuest extremely powerful. Additional in-game functionality like [the map](../plugins/core-plugins/mq2map/), cross-zone targeting, enhanced [/who](../reference/commands/who.md), custom binds, [the HUD](../plugins/core-plugins/mq2hud/) and [plugins](../plugins/README.md) are useful, but macroing is what **Macro**Quest is all about. +The use of macros is what really makes MacroQuest extremely powerful. Additional in-game functionality like [the map](../plugins/core-plugins/map/), cross-zone targeting, enhanced [/who](../reference/commands/who.md), custom binds, [the HUD](../plugins/core-plugins/hud/) and [plugins](../plugins/README.md) are useful, but macroing is what **Macro**Quest is all about. See [Getting Started](getting-started.md) for some introductory information about macros. This page is concerned primarily with all the relevant information required to create your own macros. diff --git a/macros/beginners-guide-datatypes.md b/macros/beginners-guide-datatypes.md index 0b6b6ccb0..5b5ddeb1c 100644 --- a/macros/beginners-guide-datatypes.md +++ b/macros/beginners-guide-datatypes.md @@ -10,7 +10,7 @@ In order to use these built-in variables, you need to pick a Top-Level Object to ### Example 1: Mana Percentage -Say you want to display your current Mana Percentage in a [HUD](../plugins/core-plugins/mq2hud/README.md) or use it in a macro. +Say you want to display your current Mana Percentage in a [HUD](../plugins/core-plugins/hud/README.md) or use it in a macro. * First off, you look through the [list of TLOs](../reference/top-level-objects/README.md) and pick one that best suits the information you're looking for. The [Me TLO](../reference/top-level-objects/tlo-me.md) looks like a good bet. * Opening that page, you see that the Me TLO has access to the [_character_](../reference/data-types/datatype-character.md) datatype and the [_spawn_](../reference/data-types/datatype-spawn.md) datatype. The _character_ datatype contains information about your own character, mostly things that only you will know (eg. how much mana you have, what spells you have loaded, etc). Since your character is also a spawn in the EQ world (ie. other people can see you and interact with you), you are also able to access the _spawn_ datatype, which gives information that other characters in the same zone may know (eg. your location, your race, your class, etc). diff --git a/main/README.md b/main/README.md index 35832fb5b..14c9b92ef 100644 --- a/main/README.md +++ b/main/README.md @@ -17,7 +17,7 @@ MacroQuest becomes part of EverQuest when you play, and anything you do inside o The following common EverQuest slash commands are enhanced by MacroQuest: * [/cast](../reference/commands/cast.md) -* [/charinfo](../reference/commands/charinfo.md) +* [/char](../reference/commands/char.md) * [/help](../reference/commands/help.md) * [/location](../reference/commands/location.md) * [/target](../reference/commands/mqtarget.md) @@ -38,7 +38,7 @@ The following commonly used slash commands are added by MacroQuest: * [/itemtarget](../reference/commands/itemtarget.md) * [/macro](../reference/commands/macro.md) * [/memspell](../reference/commands/memspell.md) -* [/mqfont](../plugins/core-plugins/mq2chatwnd/mqfont.md) +* [/mqfont](../plugins/core-plugins/chatwnd/mqfont.md) * [/mqpause](../reference/commands/mqpause.md) * [/multiline](../reference/commands/multiline.md) * [/popup](../reference/commands/popup.md) @@ -106,7 +106,7 @@ See the [Custom UIs](./features/custom-uis.md) page for further information on w ## HUDs -MacroQuest can enable a custom Heads Up Display to show almost any kind of data on top of your UI. Instructions for configuration as well as further information can be found on the [MQ2HUD](../plugins/core-plugins/mq2hud/) page. +MacroQuest can enable a custom Heads Up Display to show almost any kind of data on top of your UI. Instructions for configuration as well as further information can be found on the [HUD](../plugins/core-plugins/hud/) page. ## CFG Files @@ -118,7 +118,7 @@ See the [CFG Files](./features/cfg-files.md) section for further information. Chat window.\*\* -You need to load the [MQ2Map](../plugins/core-plugins/mq2map/) plugin using the command "/plugin MQ2Map" in-game. +You need to load the [Map](../plugins/core-plugins/map/) plugin using the command "/plugin Map" in-game. * **When you execute /mapfilter with any options, all layers that were previously visible disappear.** diff --git a/main/features/custom-uis.md b/main/features/custom-uis.md index 89a0e733f..40920a78a 100644 --- a/main/features/custom-uis.md +++ b/main/features/custom-uis.md @@ -4,7 +4,7 @@ MacroQuest has several built-in EQTypes that can be used to customize your UI. These EQTypes function the same as those in EQ, however allow you to display information in your UI that you normally would not be able to see. Alternatively, if there is no built-in EQType, you can use Tooltips to display custom MQ2 information (including data/variables from plugins). -See the [MQ2Labels](../../plugins/core-plugins/mq2labels.md) page for the EQType definitions and examples. +See the [Labels](../../plugins/core-plugins/labels/index.md) page for the EQType definitions and examples. ## List of Custom UIs diff --git a/main/multiboxing.md b/main/multiboxing.md index 79ee2d707..d18a9360a 100644 --- a/main/multiboxing.md +++ b/main/multiboxing.md @@ -28,4 +28,4 @@ Prior to MQ controlling bots was best handled by the creation of many specific h There are several ways that bots can communicate between EQ instances. You can set up a shared chat channel in EQ. One character can write a formatted message to the channel that bots can read and respond. You can also use [MQ2IRC](../plugins/discontinued/mq2irc/), [MQ2Telnet](../plugins/discontinued/mq2telnet/) or [MQ2EQBC](../plugins/community-plugins/mq2eqbc/) that all keep the communication outside of EQ. -Once your bots are setup and running you can use [Custom UIs](./features/custom-uis.md) or [MQ2HUD](../plugins/core-plugins/mq2hud/) to see information about each of your bots. You can use EQ HotKeys to send commands to your bots. +Once your bots are setup and running you can use [Custom UIs](./features/custom-uis.md) or [HUD](../plugins/core-plugins/hud/) to see information about each of your bots. You can use EQ HotKeys to send commands to your bots. diff --git a/mkdocs.yml b/mkdocs.yml index e5da7e8c4..c6bf53bc3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,49 +76,69 @@ nav: - Core Plugins: - plugins/core-plugins/README.md - - - AutoLogin: plugins/core-plugins/autologin/index.md - - MQ2Bzsrch: - - plugins/core-plugins/mq2bzsrch/README.md - - - TLO:Bazaar: plugins/core-plugins/mq2bzsrch/mq2bzsrch-tlo-bazaar.md - - DataType:bazaar: plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaar.md - - DataType:bazaaritem: plugins/core-plugins/mq2bzsrch/mq2bzsrch-datatype-bazaaritem.md - - MQ2Chat: plugins/core-plugins/mq2chat.md - - MQ2ChatWnd: - - plugins/core-plugins/mq2chatwnd/README.md - - - /mqclear: plugins/core-plugins/mq2chatwnd/mqclear.md - - /mqfont: plugins/core-plugins/mq2chatwnd/mqfont.md - - /mqmin: plugins/core-plugins/mq2chatwnd/mqmin.md - - MQ2CustomBinds: - - plugins/core-plugins/mq2custombinds/README.md - - - /custombind: plugins/core-plugins/mq2custombinds/custombind.md - - - MQ2EQBugFix: plugins/core-plugins/mq2eqbugfix.md - - MQ2HUD: - - plugins/core-plugins/mq2hud/README.md - - - /classhud: plugins/core-plugins/mq2hud/classhud.md - - /defaulthud: plugins/core-plugins/mq2hud/defaulthud.md - - /hud: plugins/core-plugins/mq2hud/hud.md - - /loadhud: plugins/core-plugins/mq2hud/loadhud.md - - /zonehud: plugins/core-plugins/mq2hud/zonehud.md - - MQ2ItemDisplay: - - plugins/core-plugins/mq2itemdisplay/README.md - - - /inote: plugins/core-plugins/mq2itemdisplay/inote.md - - MQ2Labels: plugins/core-plugins/mq2labels.md - - MQ2Map: - - plugins/core-plugins/mq2map/README.md - - - /highlight: plugins/core-plugins/mq2map/highlight.md - - /mapclick: plugins/core-plugins/mq2map/mapclick.md - - /mapfilter: plugins/core-plugins/mq2map/mapfilter.md - - /maphide: plugins/core-plugins/mq2map/maphide.md - - /mapnames: plugins/core-plugins/mq2map/mapnames.md - - /mapshow: plugins/core-plugins/mq2map/mapshow.md + - AutoBank: plugins/core-plugins/autobank/index.md + - AutoLogin: + - plugins/core-plugins/autologin/index.md + - DataType:AutoLogin: plugins/core-plugins/autologin/datatype-autologin.md + - DataType:LoginProfile: plugins/core-plugins/autologin/datatype-loginprofile.md + - TLO:AutoLogin: plugins/core-plugins/autologin/tlo-autologin.md + - /loginchar: plugins/core-plugins/autologin/loginchar.md + - /relog: plugins/core-plugins/autologin/relog.md + - /switchchar: plugins/core-plugins/autologin/switchchar.md + - /switchserver: plugins/core-plugins/autologin/switchserver.md + - Bzsrch: + - plugins/core-plugins/bzsrch/README.md + - /bzsrch: plugins/core-plugins/bzsrch/bzsrch.md + - /breset: plugins/core-plugins/bzsrch/breset.md + - /bzquery: plugins/core-plugins/bzsrch/bzquery.md + - TLO:Bazaar: plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md + - DataType:bazaar: plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md + - DataType:bazaaritem: plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md + - Chat: plugins/core-plugins/chat/index.md + - ChatWnd: + - plugins/core-plugins/chatwnd/README.md + - /mqchat: plugins/core-plugins/chatwnd/mqchat.md + - /mqclear: plugins/core-plugins/chatwnd/mqclear.md + - /mqfont: plugins/core-plugins/chatwnd/mqfont.md + - /mqmin: plugins/core-plugins/chatwnd/mqmin.md + - /setchattitle: plugins/core-plugins/chatwnd/setchattitle.md + - /style: plugins/core-plugins/chatwnd/style.md + - CustomBinds: + - plugins/core-plugins/custombinds/README.md + - /custombind: plugins/core-plugins/custombinds/custombind.md + - EQBugFix: plugins/core-plugins/eqbugfix/index.md + - HUD: + - plugins/core-plugins/hud/README.md + - /classhud: plugins/core-plugins/hud/classhud.md + - /defaulthud: plugins/core-plugins/hud/defaulthud.md + - /loadhud: plugins/core-plugins/hud/loadhud.md + - /zonehud: plugins/core-plugins/hud/zonehud.md + - /unloadhud: plugins/core-plugins/hud/unloadhud.md + - TLO:HUD: plugins/core-plugins/hud/tlo-hud.md + - ItemDisplay: + - plugins/core-plugins/itemdisplay/README.md + - /itemdisplay: plugins/core-plugins/itemdisplay/itemdisplay.md + - /inote: plugins/core-plugins/itemdisplay/inote.md + - Datatype:DisplayItem: plugins/core-plugins/itemdisplay/datatype-displayitem.md + - TLO:DisplayItem: plugins/core-plugins/itemdisplay/tlo-displayitem.md + - Labels: plugins/core-plugins/labels/index.md + - Map: + - plugins/core-plugins/map/README.md + - /highlight: plugins/core-plugins/map/highlight.md + - /mapactivelayer: plugins/core-plugins/map/mapactivelayer.md + - /mapclick: plugins/core-plugins/map/mapclick.md + - /mapfilter: plugins/core-plugins/map/mapfilter.md + - /maphide: plugins/core-plugins/map/maphide.md + - /maploc: plugins/core-plugins/map/maploc.md + - /mapnames: plugins/core-plugins/map/mapnames.md + - /mapshow: plugins/core-plugins/map/mapshow.md + - TLO:MapSpawn: plugins/core-plugins/map/tlo-mapspawn.md + - TargetInfo: + - plugins/core-plugins/targetinfo/index.md + - /targetinfo: plugins/core-plugins/targetinfo/targetinfo.md + - XTarInfo: + - plugins/core-plugins/xtarinfo/index.md + - /xtarinfo: plugins/core-plugins/xtarinfo/xtarinfo.md - Community Plugins: - plugins/community-plugins/README.md @@ -328,6 +348,7 @@ nav: - /getwintitle: reference/commands/getwintitle.md - /help: reference/commands/help.md - /hotbutton: reference/commands/hotbutton.md + - /hud: reference/commands/hud.md - /identify: reference/commands/identify.md - /insertaug: reference/commands/insertaug.md - /ini: reference/commands/ini.md @@ -435,10 +456,10 @@ nav: - /lootnodrop: reference/commands/eq/lootnodrop.md - Commands From Plugins: - - MQ2HUD: - - /hud: plugins/core-plugins/mq2hud/hud - - MQ2ChatWnd: - - /mqfont: plugins/core-plugins/mq2chatwnd/mqfont.md + - HUD: + - /loadhud: plugins/core-plugins/hud/loadhud.md + - ChatWnd: + - /mqfont: plugins/core-plugins/chatwnd/mqfont.md - Top Level Objects: - reference/top-level-objects/README.md @@ -636,6 +657,15 @@ plugins: 'main/submodule-quick-list.md': 'main/plugin-quick-list.md' 'reference/general/combatstate.md': 'reference/data-types/datatype-character#CombatState' 'plugins/core-plugins/mq2autologin.md': 'plugins/core-plugins/autologin/index.md' + 'plugins/core-plugins/mq2bzsrch/README.md': 'plugins/core-plugins/bzsrch/README.md' + 'plugins/core-plugins/mq2chat.md': 'plugins/core-plugins/chat/index.md' + 'plugins/core-plugins/mq2chatwnd/README.md': 'plugins/core-plugins/chatwnd/README.md' + 'plugins/core-plugins/mq2custombinds/README.md': 'plugins/core-plugins/custombinds/README.md' + 'plugins/core-plugins/mq2eqbugfix.md': 'plugins/core-plugins/eqbugfix/index.md' + 'plugins/core-plugins/mq2hud/README.md': 'plugins/core-plugins/hud/README.md' + 'plugins/core-plugins/mq2itemdisplay/README.md': 'plugins/core-plugins/itemdisplay/README.md' + 'plugins/core-plugins/mq2labels.md': 'plugins/core-plugins/labels/index.md' + 'plugins/core-plugins/mq2map.md': 'plugins/core-plugins/map/README.md' - tags: tags_file: tags.md diff --git a/plugins/README.md b/plugins/README.md index e6161f8ed..0270f54eb 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -100,17 +100,17 @@ See [/plugin](../reference/commands/plugin.md) for information on loading and un ## Plugins included with MacroQuest2 -* [MQ2Bzsrch](../plugins/core-plugins/mq2bzsrch/) -- a bazaar search plug-in -* [MQ2Chat](../plugins/core-plugins/mq2chat.md) -- Directs MQ2 output to the regular chat window -* [MQ2ChatWnd](../plugins/core-plugins/mq2chatwnd/) -- Directs MQ2 output to a special chat window (safer) -* [MQ2CustomBinds](../plugins/core-plugins/mq2custombinds/) -- Allows you to specify custom commands to execute on a key combination -* [MQ2EQBugFix](../plugins/core-plugins/mq2eqbugfix.md) -- Currently nothing, but reserved for fixing bugs in EQ itself +* [Bzsrch](../plugins/core-plugins/bzsrch/) -- a bazaar search plug-in +* [Chat](../plugins/core-plugins/chat/) -- Directs MQ2 output to the regular chat window +* [ChatWnd](../plugins/core-plugins/chatwnd/) -- Directs MQ2 output to a special chat window (safer) +* [CustomBinds](../plugins/core-plugins/custombinds/) -- Allows you to specify custom commands to execute on a key combination +* [EQBugFix](../plugins/core-plugins/eqbugfix/) -- Currently nothing, but reserved for fixing bugs in EQ itself * [MQ2EQIM](../plugins/discontinued/mq2eqim/) -- EQIM -* [MQ2HUD](../plugins/core-plugins/mq2hud/) -- Provides additional functionality to the HUD included with MQ2 +* [HUD](../plugins/core-plugins/hud/) -- Provides additional functionality to the HUD included with MQ2 * [MQ2IRC](../plugins/discontinued/mq2irc/) -- IRC plugin -* [MQ2ItemDisplay](../plugins/core-plugins/mq2itemdisplay/) -- Add extra data to item windows -* [MQ2Labels](../plugins/core-plugins/mq2labels.md) -- allows custom UI labels -* [MQ2Map](../plugins/core-plugins/mq2map/) -- enhanced map +* [ItemDisplay](../plugins/core-plugins/itemdisplay/) -- Add extra data to item windows +* [Labels](../plugins/core-plugins/labels/) -- allows custom UI labels +* [Map](../plugins/core-plugins/map/) -- enhanced map * [MQ2Telnet](../plugins/discontinued/mq2telnet/) -- act as a telnet server for macro output ## List of Plugins with wiki pages @@ -128,7 +128,7 @@ See [/plugin](../reference/commands/plugin.md) for information on loading and un </li> <li><a href="../plugins/community-plugins/mq2autogroup/">MQ2AutoGroup</a> </li> - <li><a href="../plugins/core-plugins/mq2autologin/">MQ2AutoLogin</a> + <li><a href="../plugins/core-plugins/autologin/">AutoLogin</a> </li> <li><a href="../plugins/community-plugins/mq2autosize/">MQ2AutoSize</a> </li> @@ -140,15 +140,15 @@ See [/plugin](../reference/commands/plugin.md) for information on loading and un </li> <li><a href="../plugins/community-plugins/mq2cast/">MQ2Cast</a> </li> - <li><a href="../plugins/core-plugins/mq2chat/">MQ2Chat</a> + <li><a href="../plugins/core-plugins/chat/">Chat</a> </li> <li><a href="../plugins/community-plugins/mq2chatevents/">MQ2ChatEvents</a> </li> - <li><a href="../plugins/core-plugins/mq2chatwnd/">MQ2ChatWnd</a> + <li><a href="../plugins/core-plugins/chatwnd/">ChatWnd</a> </li> <li><a href="../plugins/community-plugins/mq2cursor/">MQ2Cursor</a> </li> - <li><a href="../plugins/core-plugins/mq2custombinds/">MQ2CustomBinds</a> + <li><a href="../plugins/core-plugins/custombinds/">CustomBinds</a> </li> <li><a href="../plugins/community-plugins/mq2debuffs/">MQ2Debuffs</a> </li> @@ -160,7 +160,7 @@ See [/plugin](../reference/commands/plugin.md) for information on loading and un </th> <th style="text-align:left"> <ul> - <li><a href="../plugins/core-plugins/mq2eqbugfix/">MQ2EQBugFix</a> + <li><a href="../plugins/core-plugins/eqbugfix/">EQBugFix</a> </li> <li><a href="../plugins/discontinued/mq2eqim/">MQ2EQIM</a> </li> @@ -178,19 +178,19 @@ See [/plugin](../reference/commands/plugin.md) for information on loading and un </li> <li><a href="../plugins/community-plugins/mq2gmcheck/">MQ2GMCheck</a> </li> - <li><a href="../plugins/core-plugins/mq2hud/">MQ2HUD</a> + <li><a href="../plugins/core-plugins/hud/">HUD</a> </li> <li><a href="../plugins/community-plugins/mq2hudmove/">MQ2HUDMove</a> </li> <li><a href="../plugins/discontinued/mq2irc/">MQ2IRC</a> </li> - <li><a href="../plugins/core-plugins/mq2itemdisplay/">MQ2ItemDisplay</a> + <li><a href="../plugins/core-plugins/itemdisplay/">ItemDisplay</a> </li> - <li><a href="../plugins/core-plugins/mq2labels/">MQ2Labels</a> + <li><a href="../plugins/core-plugins/labels/">Labels</a> </li> <li><a href="../plugins/community-plugins/mq2linkdb/">MQ2Linkdb</a> </li> - <li><a href="../plugins/core-plugins/mq2map/">MQ2Map</a> + <li><a href="../plugins/core-plugins/map/">Map</a> </li> <li><a href="../plugins/community-plugins/mq2melee/">MQ2Melee</a> </li> diff --git a/plugins/community-plugins/mq2eqbc/README.md b/plugins/community-plugins/mq2eqbc/README.md index 358678f92..6516436f2 100644 --- a/plugins/community-plugins/mq2eqbc/README.md +++ b/plugins/community-plugins/mq2eqbc/README.md @@ -206,19 +206,19 @@ Send /command to all connected clients, _including_ the client you issued the co * **/bcfont** \# -Sets the font size of the UI window, similar to the [/mqfont](../../core-plugins/mq2chatwnd/mqfont.md) command +Sets the font size of the UI window, similar to the [/mqfont](../../core-plugins/chatwnd/mqfont.md) command #### /bcmin * **/bcmin** -Minimizes the UI window, similar to the [/mqmin](../../core-plugins/mq2chatwnd/mqmin.md) command +Minimizes the UI window, similar to the [/mqmin](../../core-plugins/chatwnd/mqmin.md) command #### /bcclear * **/bcclear** -Clears the buffer of the UI window, similar to the [/mqclear](../../core-plugins/mq2chatwnd/mqclear.md) command +Clears the buffer of the UI window, similar to the [/mqclear](../../core-plugins/chatwnd/mqclear.md) command ### Configuration File diff --git a/plugins/community-plugins/mq2hudmove.md b/plugins/community-plugins/mq2hudmove.md index 77fc9b251..f3915f28b 100644 --- a/plugins/community-plugins/mq2hudmove.md +++ b/plugins/community-plugins/mq2hudmove.md @@ -4,7 +4,7 @@ MQ2HUDMove by ieatacid allows you to move HUDs or sections of HUDs easily. The plugin can be downloaded [here](https://macroquest2.com/phpBB3/viewtopic.php?t=9087). -* It requires the [MQ2HUD](../core-plugins/mq2hud/) plugin +* It requires the [HUD](../core-plugins/hud/) plugin Features: diff --git a/plugins/community-plugins/mq2moveutils/README.md b/plugins/community-plugins/mq2moveutils/README.md index 52186faa5..554df7de0 100644 --- a/plugins/community-plugins/mq2moveutils/README.md +++ b/plugins/community-plugins/mq2moveutils/README.md @@ -80,11 +80,11 @@ _These parameters can be used from any of the four main plugin commands \('/stic \* **/stick min** -* * Minimizes custom user window similar to [/mqmin](../../core-plugins/mq2chatwnd/mqmin.md) +* * Minimizes custom user window similar to [/mqmin](../../core-plugins/chatwnd/mqmin.md) \* **/stick clear** -* * Clears custom user window buffer similar to [/mqclear](../../core-plugins/mq2chatwnd/mqclear.md) +* * Clears custom user window buffer similar to [/mqclear](../../core-plugins/chatwnd/mqclear.md) \* **/stick verbflags** diff --git a/reference/commands/README.md b/reference/commands/README.md index 56ca4ad78..68e898c58 100644 --- a/reference/commands/README.md +++ b/reference/commands/README.md @@ -6,7 +6,7 @@ | [/aa](aa) | [/advloot](advloot) | [/alert](alert) | [/alias](alias) | [/altkey](altkey) | [/banklist](banklist) | | [/beep](beep) | [/benchmark](benchmark) | [/beepontells](beepontells) | [/bind](bind) | [/buyitem](buyitem) | [/caption](caption) | | [/captioncolor](captioncolor) | [/cast](cast) | [/cecho](cecho) | [/cleanup](cleanup) | [/char](char) | [/click](click) | -| [/combine](combine) | [/ctrlkey](ctrlkey) | [/custombind](/plugins/core-plugins/mq2custombinds/custombind/) | [/destroy](destroy) | [/docommand](docommand) | [/doors](doors) | +| [/combine](combine) | [/ctrlkey](ctrlkey) | [/custombind](/plugins/core-plugins/custombinds/custombind/) | [/destroy](destroy) | [/docommand](docommand) | [/doors](doors) | | [/doortarget](doortarget) | [/dosocial](dosocial) | [/drop](drop) | [/dumpbinds](dumpbinds) | [/echo](echo) | [/eqtarget](eqtarget) | | [/exec](exec) | [/face](face) | [/filter](filter) | [/flashontells](flashontells) | [/foreground](foreground) | [/framelimiter](framelimiter) | | [/help](help) | [/hotbutton](hotbutton) | [/identify](identify) | [/ini](ini) | [/itemnotify](itemnotify) | [/items](items) | @@ -37,11 +37,11 @@ | [/vardata](vardata) | [/varset](varset) | [/while](while) | ## From Plugins -| [MQ2ChatWnd](/plugins/core-plugins/mq2chatwnd/) | [MQ2HUD](/plugins/core-plugins/mq2hud/) | [MQ2ItemDisplay](/plugins/core-plugins/mq2itemdisplay/) | [MQ2Map](/plugins/core-plugins/mq2map/) | +| [ChatWnd](/plugins/core-plugins/chatwnd/) | [HUD](/plugins/core-plugins/hud/) | [ItemDisplay](/plugins/core-plugins/itemdisplay/) | [Map](/plugins/core-plugins/map/) | | :--- | :--- | :--- | :--- | -| [/mqfont](/plugins/core-plugins/mq2chatwnd/mqfont) | [/hud](/plugins/core-plugins/mq2hud/hud) | [/inote](/plugins/core-plugins/mq2itemdisplay/inote) | [/highlight](/plugins/core-plugins/mq2map/highlight) | -| | [/defaulthud](/plugins/core-plugins/mq2hud/defaulthud) | | [/mapclick](/plugins/core-plugins/mq2map/mapclick) | -| | [/loadhud](/plugins/core-plugins/mq2hud/loadhud) | | [/mapfilter](/plugins/core-plugins/mq2map/mapfilter) | -| | [/classhud](/plugins/core-plugins/mq2hud/classhud) | | [/maphide](/plugins/core-plugins/mq2map/maphide) | -| | [/zonehud](/plugins/core-plugins/mq2hud/zonehud) | | [/mapnames](/plugins/core-plugins/mq2map/mapnames) | -| | | | [/mapshow](/plugins/core-plugins/mq2map/mapshow) | +| [/mqfont](/plugins/core-plugins/chatwnd/mqfont) | [/hud](/plugins/core-plugins/hud/hud) | [/inote](/plugins/core-plugins/itemdisplay/inote) | [/highlight](/plugins/core-plugins/map/highlight) | +| | [/defaulthud](/plugins/core-plugins/hud/defaulthud) | | [/mapclick](/plugins/core-plugins/map/mapclick) | +| | [/loadhud](/plugins/core-plugins/hud/loadhud) | | [/mapfilter](/plugins/core-plugins/map/mapfilter) | +| | [/classhud](/plugins/core-plugins/hud/classhud) | | [/maphide](/plugins/core-plugins/map/maphide) | +| | [/zonehud](/plugins/core-plugins/hud/zonehud) | | [/mapnames](/plugins/core-plugins/map/mapnames) | +| | | | [/mapshow](/plugins/core-plugins/map/mapshow) | diff --git a/reference/commands/spellslotinfo.md b/reference/commands/spellslotinfo.md index 45d03ff47..2cb769ff8 100644 --- a/reference/commands/spellslotinfo.md +++ b/reference/commands/spellslotinfo.md @@ -14,5 +14,5 @@ tags: You can use this to see the spell slot -Information for any spell without having to right-click display through the MQ2ItemDisplay plugin. +Information for any spell without having to right-click display through the ItemDisplay plugin. diff --git a/reference/data-types/datatype-item.md b/reference/data-types/datatype-item.md index 900b3d8e7..226177075 100644 --- a/reference/data-types/datatype-item.md +++ b/reference/data-types/datatype-item.md @@ -721,7 +721,7 @@ Contains the properties that describe an item. !!! warning - This section needs to be moved to the MQ2ItemDisplay article + This section needs to be moved to the ItemDisplay article **${DisplayItem}** now takes an index as an option parameter index can be 0-5 you can still just do ${DsiplayItem} and it will just pick whatever you inspected last. From 5874545f24da0e8cc49bd8a93e2b47ce49c3253c Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 26 Apr 2025 10:49:02 -0500 Subject: [PATCH 08/41] remove tests --- plugins/core-plugins/bzsrch/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/plugins/core-plugins/bzsrch/README.md b/plugins/core-plugins/bzsrch/README.md index bf7355784..c6d075701 100644 --- a/plugins/core-plugins/bzsrch/README.md +++ b/plugins/core-plugins/bzsrch/README.md @@ -20,5 +20,3 @@ This plugin adds bazaar search access and commands. {{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md') }} {{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md') }} -{{ embedMQType('plugins/core-plugins/autologin/datatype-loginprofile.md') }} -{{ embedMQType('reference/data-types/datatype-body.md') }} From e6677c768a9e8002560b605674c0ea7cbed552c9 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sun, 27 Apr 2025 11:50:05 -0500 Subject: [PATCH 09/41] updating embed macros --- main.py | 84 ++++++++++++++++++++++++++++++--------------------------- 1 file changed, 45 insertions(+), 39 deletions(-) diff --git a/main.py b/main.py index e61a069c4..3b0a5ce1a 100644 --- a/main.py +++ b/main.py @@ -108,9 +108,6 @@ def parse_command_file(command_file, page): content = file_result["content"] base_dir = file_result["base_dir"] - # This keeps track of how far down the file we've parsed for the has_more_content check - end_pos = 0 - # Syntax is in codeblocks syntax_match = re.search(SYNTAX_CODEBLOCK_PATTERN, content, re.DOTALL) if syntax_match: @@ -119,18 +116,16 @@ def parse_command_file(command_file, page): "lexer": syntax_match.group(1) or "", "syntax_content": syntax_match.group(2).strip() }) - end_pos = max(end_pos, syntax_match.end()) else: # Syntax if no codeblocks, we use extract_section for help. - syntax_content_nocode, syntax_end = extract_section(SYNTAX_NOCODE_PATTERN, content) + syntax_content_nocode = extract_section(SYNTAX_NOCODE_PATTERN, content) if syntax_content_nocode: data["syntax_content"] = syntax_content_nocode - end_pos = max(end_pos, syntax_end) else: data["syntax_content"] = "⚠️ Syntax missing" - description_text, desc_end = extract_section( - DESCRIPTION_PATTERN, + description_text = extract_section( + DESCRIPTION_PATTERN, content, clean_whitespace=True, convert_links=True, @@ -140,10 +135,9 @@ def parse_command_file(command_file, page): if description_text: data["full_description"] = description_text - end_pos = max(end_pos, desc_end) # else: # No need for else, default is "" - data["has_more_content"] = bool(re.search(r'\S', content[end_pos:].strip())) + data["has_more_content"] = check_for_extra_sections(content) return data @@ -169,37 +163,43 @@ def read_file(file_path, page): "error": str(e) } -# create a url that's relative to the embedding page +# create an mkdocs-style url that's relative to the embedding page def relative_link(target_file_path, embedding_page_src_uri, base_dir=None): - # i could only get this working with pureposixpath - target_path = PurePosixPath(base_dir) / target_file_path if base_dir else PurePosixPath(target_file_path) - embedding_dir = PurePosixPath(embedding_page_src_uri).parent + # Absolute path of the target markdown file + target_path = (PurePosixPath(base_dir) / target_file_path if base_dir else PurePosixPath(target_file_path)) - relative_path = target_path.relative_to(embedding_dir, walk_up=True) + embedding_file = PurePosixPath(embedding_page_src_uri) + if embedding_file.stem.lower() in ("readme", "index"): + # main/guide/README.md -> main/guide/ + output_dir = embedding_file.parent + else: + # main/foo.md -> main/foo/ + output_dir = embedding_file.parent / embedding_file.stem - # special case for index and readme files - if relative_path.name.lower() in ('index.md', 'readme.md'): - parent_dir = relative_path.parent - return './' if str(parent_dir) == '.' else f"{parent_dir}/" + # Relative path from the embedding page to the target file + relative_path = target_path.relative_to(output_dir, walk_up=True) - # otherwise, remove the .md extension and add a trailing slash + # strip .md, add trailing slash + if relative_path.name.lower() in ("index.md", "readme.md"): + parent_dir = relative_path.parent + return "./" if str(parent_dir) == "." else f"{parent_dir}/" return f"{relative_path.with_suffix('')}/" def extract_section(pattern, content, clean_whitespace=False, convert_links=False, base_dir=None, page=None): match = re.search(pattern, content, re.DOTALL) if not match: - return None, None - + return None + extracted = match.group(1).strip() - + if clean_whitespace: extracted = re.sub(r'\s*\n\s*', ' ', extracted) - + if convert_links and base_dir and page: extracted = rewrite_markdown_links(extracted, base_dir, page) - - return extracted, match.end() + + return extracted def parse_type_file(doc_file, page): NAME_PATTERN = r'# `(.+?)`' @@ -211,7 +211,7 @@ def parse_type_file(doc_file, page): # Initialize for clarity data = { - "doc_url": file_result["doc_url"], + "doc_url": file_result["doc_url"], "name": "Unknown Type", "full_description": "", "section_name": "", @@ -228,18 +228,13 @@ def parse_type_file(doc_file, page): content = file_result["content"] base_dir = file_result["base_dir"] - - # This keeps track of how far down the file we've parsed for the has_more_content check - end_pos = 0 # Name extraction name_match = re.search(NAME_PATTERN, content) if name_match: data["name"] = name_match.group(1) # Update data dict - # Update end_pos to the end of the name section if it's further - end_pos = max(end_pos, name_match.end()) - description_text, desc_end = extract_section( + description_text = extract_section( DESCRIPTION_PATTERN, content, clean_whitespace=True, @@ -250,7 +245,6 @@ def parse_type_file(doc_file, page): if description_text: data["full_description"] = description_text - end_pos = max(end_pos, desc_end) # Members section extraction section_match = re.search( @@ -261,19 +255,18 @@ def parse_type_file(doc_file, page): if section_match: data["section_name"] = section_match.group(1) # Forms or Members raw_content = section_match.group(2).strip() - data["members"] = parse_render_members(raw_content, base_dir, page) - end_pos = max(end_pos, section_match.end()) + data["members"] = parse_render_members(raw_content, base_dir, page) # Link reference extraction link_ref_matches = re.findall(LINK_REF_PATTERN, content, re.MULTILINE) - processed_link_refs = [] + processed_link_refs = [] for ref_name, ref_url in link_ref_matches: if ref_url.endswith('.md'): relative_ref_url = relative_link(ref_url, page.file.src_uri, base_dir=base_dir) processed_link_refs.append((ref_name, relative_ref_url)) data["link_refs"] = processed_link_refs - data["has_more_content"] = bool(re.search(r'\S', content[end_pos:].strip())) + data["has_more_content"] = check_for_extra_sections(content) return data @@ -301,7 +294,7 @@ def parse_render_members(raw_content, base_dir, page): }) return members -def rewrite_markdown_links(content, base_dir, page): +def rewrite_markdown_links(content, base_dir, page): MARKDOWN_LINK_PATTERN = r'\[([^\]]+)\]\(([^\)]+\.md)\)' def replace_link(match): @@ -315,6 +308,19 @@ def replace_link(match): content ) +def check_for_extra_sections(content): + SECTION_HEADER_PATTERN = r'^##\s+(.+?)\s*$' + allowed_sections = {"Forms", "Members", "Syntax", "Description"} + allowed_prefix = "Associated" + + headers = re.findall(SECTION_HEADER_PATTERN, content, re.MULTILINE) + + for header in headers: + header_stripped = header.strip() + if header_stripped not in allowed_sections and not header_stripped.startswith(allowed_prefix): + return True + return False + # a nice little markdown table def render_members_table(members, link_refs): lines = [ From bcb88a514f3b0c45245bd2cb03522962d2574d33 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sun, 27 Apr 2025 11:51:44 -0500 Subject: [PATCH 10/41] using macros to replace repeated information --- main/features/framelimiter.md | 75 +------------------ .../top-level-objects/tlo-framelimiter.md | 47 +----------- 2 files changed, 7 insertions(+), 115 deletions(-) diff --git a/main/features/framelimiter.md b/main/features/framelimiter.md index 2e69b52ec..6c8d41fef 100644 --- a/main/features/framelimiter.md +++ b/main/features/framelimiter.md @@ -11,79 +11,12 @@ Frame lmiter settings can be modified in the MacroQuest Settings window. ## Commands -`/framelimiter [COMMAND] {OPTIONS}` - -Frame limiter tool: allows adjusting internal frame limiter settings. - -```text -enable -- turn the framelimiter on (background) -on -- turn the framelimiter on (background) -disable -- turn the rendering client off -off -- turn the rendering client off -toggle -- set/toggle the framelimiter functionality -enablefg -- turn the framelimiter on (foreground) -onfg -- turn the framelimiter on (foreground) -disablefg -- turn the framelimiter off (foreground) -offfg -- turn the framelimiter off (foreground) -togglefg -- set/toggle the framelimiter (foreground) -savebychar -- set/toggle saving settings by character -bgrender -- set/toggle rendering when client is in background -imguirender -- set/toggle rendering ImGui when rendering is otherwise disabled -uirender -- set/toggle rendering the UI when rendering is otherwise disabled -clearscreen -- set/toggle clearing (blanking) the screen when rendering is disabled -bgfps -- set the FPS rate for the background process -fgfps -- set the FPS rate for the foreground process -simfps -- sets the minimum FPS the simulation will run -reloadsettings -- reload settings from ini --h, -?, help -- displays this help text -``` +{{ embedCommand('reference/commands/framelimiter.md') }} ## Top-Level Objects -### [FrameLimiter](reference\top-level-objects\tlo-framelimiter.md) - -## Members - -### {{ renderMember(type='float', name='BackgroundFPS') }} - -: Value of the target background fps setting. - -### {{ renderMember(type='bool', name='ClearScreen') }} - -: Value of the clear screen when not rendering setting. - -### {{ renderMember(type='float', name='CPU') }} - -: Current CPU usage as % - -### {{ renderMember(type='bool', name='Enabled') }} - -: TRUE if the frame limiter feature is currently active. - -### {{ renderMember(type='float', name='ForegroundFPS') }} - -: Value of the target foreground fps setting. - -### {{ renderMember(type='float', name='MinSimulationFPS') }} - -: Value of the minimum simualtion rate setting. - -### {{ renderMember(type='float', name='RenderFPS') }} - -: Current graphics scene frame rate (visible fps). - -### {{ renderMember(type='bool', name='SaveByChar') }} - -: TRUE if settings for the frame limiter are being saved by character. - -### {{ renderMember(type='float', name='SimulationFPS') }} - -: Current simulation frame rate (game updates per second). - -### {{ renderMember(type='string', name='Status') }} +{{ embedMQType('reference/top-level-objects/tlo-framelimiter.md') }} -: Either "Foreground" or "Background". +## Associated DataTypes -[bool]: datatype-bool.md -[float]: datatype-float.md -[string]: datatype-string.md +{{ embedMQType('reference/data-types/datatype-framelimiter.md') }} diff --git a/reference/top-level-objects/tlo-framelimiter.md b/reference/top-level-objects/tlo-framelimiter.md index 56932aa99..7baea6fab 100644 --- a/reference/top-level-objects/tlo-framelimiter.md +++ b/reference/top-level-objects/tlo-framelimiter.md @@ -13,50 +13,9 @@ The FrameLimiter TLO provides access to the [frame limiter](../../main/features/ : The frame limiter object -## datatype `framelimiter` - -Represents the state of the frame limiter - -### {{ renderMember(type='float', name='BackgroundFPS') }} - -: Value of the target background fps setting. - -### {{ renderMember(type='bool', name='ClearScreen') }} - -: Value of the clear screen when not rendering setting. - -### {{ renderMember(type='float', name='CPU') }} - -: Current CPU usage as % - -### {{ renderMember(type='bool', name='Enabled') }} - -: TRUE if the frame limiter feature is currently active. - -### {{ renderMember(type='float', name='ForegroundFPS') }} - -: Value of the target foreground fps setting. - -### {{ renderMember(type='float', name='MinSimulationFPS') }} - -: Value of the minimum simualtion rate setting. - -### {{ renderMember(type='float', name='RenderFPS') }} - -: Current graphics scene frame rate (visible fps). - -### {{ renderMember(type='bool', name='SaveByChar') }} - -: TRUE if settings for the frame limiter are being saved by character. - -### {{ renderMember(type='float', name='SimulationFPS') }} - -: Current simulation frame rate (game updates per second). - -### {{ renderMember(type='string', name='Status') }} - -: Either "Foreground" or "Background". +## Associated DataTypes +{{ embedMQType('reference/data-types/datatype-framelimiter.md') }} ## Usage @@ -69,4 +28,4 @@ Indicates that the frame limiter is enabled: [bool]: ../data-types/datatype-bool.md [string]: ../data-types/datatype-string.md [float]: ../data-types/datatype-float.md -[framelimiter]: #datatype-framelimiter \ No newline at end of file +[framelimiter]: ../data-types/datatype-framelimiter.md \ No newline at end of file From 2bbf6a025e20154a2cc190c17ad595ddd1109e0a Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 7 May 2025 21:07:34 -0500 Subject: [PATCH 11/41] add mkdocs-include-markdown-plugin --- mkdocs.yml | 1 + requirements.txt | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index c6bf53bc3..adc48fa71 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -650,6 +650,7 @@ theme: # Plugins plugins: - search + - include-markdown - macros - same-dir - redirects: diff --git a/requirements.txt b/requirements.txt index aa589bc28..3296502f2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,9 @@ material mkdocs mkdocs-gen-files -mkdocs-gen-files mkdocs-macros-plugin mkdocs-material mkdocs-redirects mkdocs-same-dir -python-markdown-math \ No newline at end of file +python-markdown-math +mkdocs-include-markdown-plugin \ No newline at end of file From 2587b7d4f6aa2ddf72322f8080e127929fae8ce4 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 7 May 2025 21:20:26 -0500 Subject: [PATCH 12/41] removing embed macros --- main.py | 329 +++++++------------------------------------------------- 1 file changed, 36 insertions(+), 293 deletions(-) diff --git a/main.py b/main.py index 3b0a5ce1a..e3226d1bc 100644 --- a/main.py +++ b/main.py @@ -1,5 +1,4 @@ import re -import textwrap from pathlib import Path, PurePosixPath def define_env(env): @@ -21,125 +20,22 @@ def renderMember(name, type=None, params=None, toc_label=None): return f"{type_str} `{name}{params_str}` {{ #{toc_label} data-toc-label='{toc_label}' }}" @env.macro - def embedCommand(command_file): + def readMore(doc_file): + """Outputs 'Read more' link if file has sections beyond Members/Forms/Description""" page = env.variables.page - data = parse_command_file(command_file, page) - - doc_url = data.get("doc_url", "#") - syntax_content = data.get("syntax_content") - is_codeblock = data.get("is_codeblock", False) - lexer = data.get("lexer", "") - full_description = data.get("full_description", "") - has_more_content = data.get("has_more_content", False) - - # we use html links here because markdown wasn't able to link a codeblock. - syntax = f'<a href="{doc_url}">⚠️ Syntax missing</a>' - if syntax_content: - if is_codeblock: - lexer_str = lexer or '' - syntax = f'<a href="{doc_url}">\n```{lexer_str}\n{syntax_content}\n```\n</a>' - else: - syntax = f'<a href="{doc_url}">{syntax_content}</a>' - - formatted_description = truncate_description( - full_description, - doc_url, - has_more_content - ) - - return f"{syntax}\n: {formatted_description}\n" - - @env.macro - def embedMQType(doc_file): - page = env.variables.page - data = parse_type_file(doc_file, page) - - doc_url = data.get("doc_url", "#") # the default URL is a same page link - name = data.get("name", "Unknown Type") - description = data.get("description", "No description available.") - members = data.get("members", []) - link_refs = data.get("link_refs", []) - - members_table = "" - if members: - members_table = "\n\n" + render_members_table(members, link_refs) + "\n\n" - - # Unified truncation using shared helper - formatted_desc = truncate_description( - data.get("full_description", data.get("description", "")), - doc_url, - data.get("has_more_content", False) - ) - - result = ( - f"### [`{name}`]({doc_url})\n\n" - f"{formatted_desc}\n\n" # Use processed description - f"{members_table}" - ) - - return result - -# == Helper functions == - -# Parse for syntax and description. -def parse_command_file(command_file, page): - SYNTAX_CODEBLOCK_PATTERN = r'## Syntax\s*\n\s*```(\w+)?\s*\n(.*?)\n```' - SYNTAX_NOCODE_PATTERN = r'## Syntax\s+\n+(.+?)(?=\n\n|\n##)' - DESCRIPTION_PATTERN = r'## Description\s*\n(.*?)(?=\n\n\*\*|\n##|$)' - - file_result = read_file(command_file, page) - - # Initialize for clarity - data = { - "doc_url": file_result["doc_url"], - "syntax_content": None, - "lexer": "", - "is_codeblock": False, - "full_description": "", - "has_more_content": False - } - - # return on error - if not file_result["success"]: - data["syntax_content"] = f"Error: {file_result['error']}" - data["full_description"] = "Documentation file could not be loaded" - return data - - content = file_result["content"] - base_dir = file_result["base_dir"] - - # Syntax is in codeblocks - syntax_match = re.search(SYNTAX_CODEBLOCK_PATTERN, content, re.DOTALL) - if syntax_match: - data.update({ - "is_codeblock": True, - "lexer": syntax_match.group(1) or "", - "syntax_content": syntax_match.group(2).strip() - }) - else: - # Syntax if no codeblocks, we use extract_section for help. - syntax_content_nocode = extract_section(SYNTAX_NOCODE_PATTERN, content) - if syntax_content_nocode: - data["syntax_content"] = syntax_content_nocode - else: - data["syntax_content"] = "⚠️ Syntax missing" - - description_text = extract_section( - DESCRIPTION_PATTERN, - content, - clean_whitespace=True, - convert_links=True, - base_dir=base_dir, - page=page - ) - - if description_text: - data["full_description"] = description_text - # else: # No need for else, default is "" - - data["has_more_content"] = check_for_extra_sections(content) + file_result = read_file(doc_file, page) + + if not file_result["success"]: + return "" + + has_extra = has_extra_sections(file_result["content"]) + doc_url = file_result["doc_url"] + + if has_extra: + return f'[:material-book-arrow-right-outline:]({doc_url} "Full documentation")' + return '' - return data +# == Helper Functions == def read_file(file_path, page): try: @@ -167,8 +63,8 @@ def read_file(file_path, page): def relative_link(target_file_path, embedding_page_src_uri, base_dir=None): # Absolute path of the target markdown file target_path = (PurePosixPath(base_dir) / target_file_path if base_dir else PurePosixPath(target_file_path)) - embedding_file = PurePosixPath(embedding_page_src_uri) + if embedding_file.stem.lower() in ("readme", "index"): # main/guide/README.md -> main/guide/ output_dir = embedding_file.parent @@ -185,181 +81,28 @@ def relative_link(target_file_path, embedding_page_src_uri, base_dir=None): return "./" if str(parent_dir) == "." else f"{parent_dir}/" return f"{relative_path.with_suffix('')}/" -def extract_section(pattern, content, clean_whitespace=False, convert_links=False, base_dir=None, page=None): - match = re.search(pattern, content, re.DOTALL) - - if not match: - return None - - extracted = match.group(1).strip() - - if clean_whitespace: - extracted = re.sub(r'\s*\n\s*', ' ', extracted) - - if convert_links and base_dir and page: - extracted = rewrite_markdown_links(extracted, base_dir, page) - - return extracted - -def parse_type_file(doc_file, page): - NAME_PATTERN = r'# `(.+?)`' - DESCRIPTION_PATTERN = r'# `.+?`\s*\n+(.*?)(?=\n\n|\n##|$)' - SECTION_PATTERN = r'## (Forms|Members)\s*\n+(.*?)(?=\n##(?!#)|$)' - LINK_REF_PATTERN = r'^\[([^\]]+)\]:\s*(.+?)(?:\s*)$' - - file_result = read_file(doc_file, page) - - # Initialize for clarity - data = { - "doc_url": file_result["doc_url"], - "name": "Unknown Type", - "full_description": "", - "section_name": "", - "members": [], - "link_refs": [], - "has_more_content": False, - } - - # return on error - if not file_result["success"]: - data["name"] = "Error loading type" - data["full_description"] = f"Error: {file_result['error']}" - return data - - content = file_result["content"] - base_dir = file_result["base_dir"] - - # Name extraction - name_match = re.search(NAME_PATTERN, content) - if name_match: - data["name"] = name_match.group(1) # Update data dict - - description_text = extract_section( - DESCRIPTION_PATTERN, - content, - clean_whitespace=True, - convert_links=True, - base_dir=base_dir, - page=page - ) - - if description_text: - data["full_description"] = description_text - - # Members section extraction - section_match = re.search( - SECTION_PATTERN, - content, re.DOTALL - ) - - if section_match: - data["section_name"] = section_match.group(1) # Forms or Members - raw_content = section_match.group(2).strip() - data["members"] = parse_render_members(raw_content, base_dir, page) - - # Link reference extraction - link_ref_matches = re.findall(LINK_REF_PATTERN, content, re.MULTILINE) - processed_link_refs = [] - for ref_name, ref_url in link_ref_matches: - if ref_url.endswith('.md'): - relative_ref_url = relative_link(ref_url, page.file.src_uri, base_dir=base_dir) - processed_link_refs.append((ref_name, relative_ref_url)) - data["link_refs"] = processed_link_refs - - data["has_more_content"] = check_for_extra_sections(content) - - return data - -# parse renderMember macro calls -def parse_render_members(raw_content, base_dir, page): - MEMBER_PATTERN = r"###\s*\{\{\s*renderMember\s*\((.*?)\)\s*\}\}(?:\s*\n\s*\:\s*(.*?))?(?=\n\n|\n###|\Z)" - KV_PAIR_PATTERN = r"(\w+)\s*=\s*'([^']+)'" - - matches = re.findall(MEMBER_PATTERN, raw_content, re.DOTALL) - members = [] - for params_str, description in matches: - kv_pairs = re.findall(KV_PAIR_PATTERN, params_str) - params_dict = {k: v for k, v in kv_pairs} - - member_name = params_dict.get("name", "").strip() - member_type = params_dict.get("type", "").strip() - member_params = params_dict.get("params", "").strip() - # convert any links in the description - cleaned_description = rewrite_markdown_links(description.strip(), base_dir, page) if description else "" - members.append({ - "name": member_name, - "type": member_type, - "params": member_params, - "description": cleaned_description - }) - return members - -def rewrite_markdown_links(content, base_dir, page): - MARKDOWN_LINK_PATTERN = r'\[([^\]]+)\]\(([^\)]+\.md)\)' - - def replace_link(match): - name = match.group(1) - rel_path = match.group(2) - return f"[{name}]({relative_link(rel_path, page.file.src_uri, base_dir=base_dir)})" - - return re.sub( - MARKDOWN_LINK_PATTERN, - replace_link, - content - ) - -def check_for_extra_sections(content): - SECTION_HEADER_PATTERN = r'^##\s+(.+?)\s*$' - allowed_sections = {"Forms", "Members", "Syntax", "Description"} - allowed_prefix = "Associated" - - headers = re.findall(SECTION_HEADER_PATTERN, content, re.MULTILINE) - - for header in headers: - header_stripped = header.strip() - if header_stripped not in allowed_sections and not header_stripped.startswith(allowed_prefix): - return True - return False - -# a nice little markdown table -def render_members_table(members, link_refs): - lines = [ - "| Type | Member | Description |", - "| ---- | ------ | ----------- |" - ] - link_dict = {ref_name: ref_url for ref_name, ref_url in link_refs} - for m in members: - type_val = m["type"] - if type_val in link_dict: # does it match a link ref? - type_rendered = f"[{type_val}]({link_dict[type_val]})" - elif type_val: - type_rendered = f"`{type_val}`" - else: - type_rendered = '' - - member_name = m['name'] - member_params = m.get('params') - if member_params: - member_name_rendered = f"`{member_name}[{member_params}]`" - else: - member_name_rendered = f"`{member_name}`" - - lines.append(f"| {type_rendered} | {member_name_rendered} | {m['description']} |") - return "\n".join(lines) - -def truncate_description(description_text, doc_url, has_more_content, max_length=280): - if not description_text: - return "" - - read_more_link = f' [:material-book-arrow-right-outline:]({doc_url})' - max_desc_length = max(max_length - len(read_more_link), 0) +def has_extra_sections(content): + """Check if content has sections beyond Members, Forms, or Description""" + SECTION_PATTERN = r'^##\s+(.+?)\s*$' + target_sections = {"Members", "Forms", "Description"} - shortened = textwrap.shorten(description_text, width=max_desc_length, break_long_words=False, placeholder='...') + lines = content.split('\n') + sections = [] - if has_more_content: - return f"{shortened}{read_more_link}" + # Find all section headers and their positions + for i, line in enumerate(lines): + match = re.match(SECTION_PATTERN, line) + if match: + sections.append((i, match.group(1).strip())) - if len(shortened) < len(description_text): - return f"{shortened}{read_more_link}" + # Find last occurrence of target sections + last_target_index = -1 + for idx, (line_num, section) in enumerate(sections): + if section in target_sections: + last_target_index = idx - return description_text \ No newline at end of file + # Check if there are sections after the last target section + if last_target_index != -1 and len(sections) > last_target_index + 1: + return True + + return False \ No newline at end of file From eacec2ee760073e81fb27755fe8bc753fb2b4e4c Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 10 May 2025 18:12:46 -0500 Subject: [PATCH 13/41] include-markdown for core-plugins --- main.py | 4 +- mkdocs.yml | 2 +- plugins/core-plugins/autobank/index.md | 2 + .../autologin/datatype-autologin.md | 9 +- .../autologin/datatype-loginprofile.md | 9 +- plugins/core-plugins/autologin/index.md | 129 +++++++++++++++-- plugins/core-plugins/autologin/loginchar.md | 8 +- plugins/core-plugins/autologin/relog.md | 8 +- plugins/core-plugins/autologin/switchchar.md | 6 +- .../core-plugins/autologin/switchserver.md | 8 +- .../core-plugins/autologin/tlo-autologin.md | 9 +- plugins/core-plugins/bzsrch/README.md | 109 +++++++++++++- plugins/core-plugins/bzsrch/breset.md | 8 +- plugins/core-plugins/bzsrch/bzquery.md | 8 +- .../bzsrch/bzsrch-datatype-bazaar.md | 11 +- .../bzsrch/bzsrch-datatype-bazaaritem.md | 10 +- .../core-plugins/bzsrch/bzsrch-tlo-bazaar.md | 10 +- plugins/core-plugins/bzsrch/bzsrch.md | 6 +- plugins/core-plugins/chat/index.md | 3 +- plugins/core-plugins/chatwnd/README.md | 86 ++++++++++- plugins/core-plugins/chatwnd/mqchat.md | 9 +- plugins/core-plugins/chatwnd/mqclear.md | 8 +- plugins/core-plugins/chatwnd/mqfont.md | 8 +- plugins/core-plugins/chatwnd/mqmin.md | 7 +- plugins/core-plugins/chatwnd/setchattitle.md | 8 +- plugins/core-plugins/chatwnd/style.md | 7 +- plugins/core-plugins/custombinds/README.md | 18 ++- .../core-plugins/custombinds/custombind.md | 7 +- plugins/core-plugins/eqbugfix/index.md | 3 +- plugins/core-plugins/hud/README.md | 94 ++++++++++-- plugins/core-plugins/hud/classhud.md | 5 +- plugins/core-plugins/hud/defaulthud.md | 6 +- plugins/core-plugins/hud/loadhud.md | 6 +- plugins/core-plugins/hud/tlo-hud.md | 9 +- plugins/core-plugins/hud/unloadhud.md | 6 +- plugins/core-plugins/hud/zonehud.md | 7 +- plugins/core-plugins/itemdisplay/README.md | 72 +++++++++- .../itemdisplay/datatype-displayitem.md | 10 +- plugins/core-plugins/itemdisplay/inote.md | 6 +- .../core-plugins/itemdisplay/itemdisplay.md | 6 +- .../itemdisplay/tlo-displayitem.md | 8 +- plugins/core-plugins/labels/index.md | 4 +- plugins/core-plugins/map/README.md | 135 ++++++++++++++++-- plugins/core-plugins/map/highlight.md | 8 +- plugins/core-plugins/map/mapactivelayer.md | 8 +- plugins/core-plugins/map/mapclick.md | 7 +- plugins/core-plugins/map/mapfilter.md | 7 +- plugins/core-plugins/map/maphide.md | 7 +- plugins/core-plugins/map/maploc.md | 7 +- plugins/core-plugins/map/mapnames.md | 7 +- plugins/core-plugins/map/mapshow.md | 6 +- plugins/core-plugins/map/tlo-mapspawn.md | 8 +- plugins/core-plugins/targetinfo/index.md | 19 ++- plugins/core-plugins/targetinfo/targetinfo.md | 23 +-- plugins/core-plugins/xtarinfo/index.md | 18 ++- plugins/core-plugins/xtarinfo/xtarinfo.md | 6 +- 56 files changed, 836 insertions(+), 189 deletions(-) diff --git a/main.py b/main.py index e3226d1bc..742948665 100644 --- a/main.py +++ b/main.py @@ -19,9 +19,9 @@ def renderMember(name, type=None, params=None, toc_label=None): return f"{type_str} `{name}{params_str}` {{ #{toc_label} data-toc-label='{toc_label}' }}" + # output a read more link if the file has sections beyond Members/Forms/Description @env.macro def readMore(doc_file): - """Outputs 'Read more' link if file has sections beyond Members/Forms/Description""" page = env.variables.page file_result = read_file(doc_file, page) @@ -81,8 +81,8 @@ def relative_link(target_file_path, embedding_page_src_uri, base_dir=None): return "./" if str(parent_dir) == "." else f"{parent_dir}/" return f"{relative_path.with_suffix('')}/" +# extra sections beyond Members/Forms/Description def has_extra_sections(content): - """Check if content has sections beyond Members, Forms, or Description""" SECTION_PATTERN = r'^##\s+(.+?)\s*$' target_sections = {"Members", "Forms", "Description"} diff --git a/mkdocs.yml b/mkdocs.yml index adc48fa71..85a1533f0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -650,8 +650,8 @@ theme: # Plugins plugins: - search - - include-markdown - macros + - include-markdown - same-dir - redirects: redirect_maps: diff --git a/plugins/core-plugins/autobank/index.md b/plugins/core-plugins/autobank/index.md index 73fd85830..788d0d683 100644 --- a/plugins/core-plugins/autobank/index.md +++ b/plugins/core-plugins/autobank/index.md @@ -3,9 +3,11 @@ tags: - plugin --- # AutoBank +<!--desc-start--> AutoBank adds a context menu to the AutoBank button in EQ's bank window. It allows you to automatically remove or add items to the bank with Tradeskill, Collectible, or Quest tags on it. Additionally, in the case of tradeskill items you can filter if you should or shouldn't move items with skill mods (Trophies). More feature to be considered/added in the future. +<!--desc-end--> ## Getting Started diff --git a/plugins/core-plugins/autologin/datatype-autologin.md b/plugins/core-plugins/autologin/datatype-autologin.md index b803d32fd..2643b562d 100644 --- a/plugins/core-plugins/autologin/datatype-autologin.md +++ b/plugins/core-plugins/autologin/datatype-autologin.md @@ -4,10 +4,11 @@ tags: --- # `AutoLogin` +<!--dt-desc-start--> Datatype providing access to AutoLogin status and profile information. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Active')}} : True when actively performing automated login @@ -15,6 +16,7 @@ Datatype providing access to AutoLogin status and profile information. ### {{ renderMember(type='LoginProfile', name='Profile')}} : Displays autologin profile information, also provides access to current profile information ([LoginProfile] type) +<!--dt-members-end--> ## Examples @@ -22,6 +24,7 @@ Datatype providing access to AutoLogin status and profile information. /echo ${AutoLogin.Active} # Check if autologin is running /echo ${AutoLogin.Profile.Account} # Show account name from profile ``` - +<!--dt-linkrefs-start--> [bool]: ../../../reference/data-types/datatype-bool.md [LoginProfile]: datatype-loginprofile.md +<!--dt-linkrefs-end--> diff --git a/plugins/core-plugins/autologin/datatype-loginprofile.md b/plugins/core-plugins/autologin/datatype-loginprofile.md index 364e783e7..13f6ed03f 100644 --- a/plugins/core-plugins/autologin/datatype-loginprofile.md +++ b/plugins/core-plugins/autologin/datatype-loginprofile.md @@ -4,10 +4,11 @@ tags: --- # `LoginProfile` +<!--dt-desc-start--> Datatype providing access to AutoLogin profile information. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Account')}} : Account name associated with the profile @@ -43,6 +44,7 @@ Datatype providing access to AutoLogin profile information. ### {{ renderMember(type='string', name='ToString') }} : Returns formatted profile info as "Profile: Character (Server)" +<!--dt-members-end--> ## Examples @@ -52,7 +54,8 @@ Datatype providing access to AutoLogin profile information. /echo ${AutoLogin.Profile} # Show formatted profile info e.g. "MyProfile: MyCharacter (MyServer)" /echo ${AutoLogin.Profile.Profile} # Show profile name only ``` - +<!--dt-linkrefs-start--> [string]: ../../../reference/data-types/datatype-string.md [int]: ../../../reference/data-types/datatype-int.md [class]: ../../../reference/data-types/datatype-class.md +<!--dt-linkrefs-end--> diff --git a/plugins/core-plugins/autologin/index.md b/plugins/core-plugins/autologin/index.md index bd7ac07ec..2cd42b70e 100644 --- a/plugins/core-plugins/autologin/index.md +++ b/plugins/core-plugins/autologin/index.md @@ -3,8 +3,9 @@ tags: - plugin --- # AutoLogin - +<!--desc-start--> AutoLogin is a plugin that automatically logs in your characters. It can also switch characters, servers and login new accounts via commandline. It was originally made by [ieatacid](https://macroquest2.com/phpBB3/viewtopic.php?f=50&t=16427). +<!--desc-end--> ## Setting up profiles via tray icon @@ -27,14 +28,57 @@ You'll be asked to enter nine fields: Upon clicking "Save", your profile will be encrypted and saved in MQ2AutoLogin.ini ## Commands - -{{ embedCommand('plugins/core-plugins/autologin/loginchar.md') }} - -{{ embedCommand('plugins/core-plugins/autologin/relog.md') }} - -{{ embedCommand('plugins/core-plugins/autologin/switchchar.md') }} - -{{ embedCommand('plugins/core-plugins/autologin/switchserver.md') }} +<a href="loginchar/"> +{% + include-markdown "plugins/core-plugins/autologin/loginchar.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/autologin/loginchar.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/loginchar.md') }} + +<a href="relog/"> +{% + include-markdown "plugins/core-plugins/autologin/relog.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/autologin/relog.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/relog.md') }} + +<a href="switchchar/"> +{% + include-markdown "plugins/core-plugins/autologin/switchchar.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/autologin/switchchar.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/switchchar.md') }} + +<a href="switchserver/"> +{% + include-markdown "plugins/core-plugins/autologin/switchserver.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/autologin/switchserver.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/switchserver.md') }} `END` and `HOME` : Pressing the "END" key at the character select screen will pause autologin, "HOME" will unpause. @@ -196,11 +240,66 @@ This helps export and import login profiles, which are otherwise hard to decrypt Launch single sessions without logging in. ## Top-Level Objects - -{{ embedMQType('plugins/core-plugins/autologin/tlo-autologin.md') }} +## [AutoLogin](tlo-autologin.md) +{% + include-markdown "plugins/core-plugins/autologin/tlo-autologin.md" + start="<!--tlo-desc-start-->" + end="<!--tlo-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/autologin/tlo-autologin.md') }} + +<h2>Forms</h2> +{% + include-markdown "plugins/core-plugins/autologin/tlo-autologin.md" + start="<!--tlo-forms-start-->" + end="<!--tlo-forms-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/autologin/tlo-autologin.md" + start="<!--tlo-linkrefs-start-->" + end="<!--tlo-linkrefs-end-->" +%} ## Datatypes - -{{ embedMQType('plugins/core-plugins/autologin/datatype-autologin.md') }} - -{{ embedMQType('plugins/core-plugins/autologin/datatype-loginprofile.md') }} \ No newline at end of file +## [AutoLogin](datatype-autologin.md) +{% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/autologin/datatype-autologin.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [LoginProfile](datatype-loginprofile.md) +{% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/autologin/datatype-loginprofile.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} \ No newline at end of file diff --git a/plugins/core-plugins/autologin/loginchar.md b/plugins/core-plugins/autologin/loginchar.md index 83dd9e1b6..ef5e3acfd 100644 --- a/plugins/core-plugins/autologin/loginchar.md +++ b/plugins/core-plugins/autologin/loginchar.md @@ -5,16 +5,18 @@ tags: # /loginchar ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /loginchar [server:character|profile_server:character|server^login^character^password|server^login^password] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Launches a new EverQuest instance and logs in the specified character. e.g. `/loginchar vox:aradune` +<!--cmd-desc-end--> -**Examples** +## Examples ```text /loginchar vox:aradune /loginchar drinal^user123^aradune^mypass123 diff --git a/plugins/core-plugins/autologin/relog.md b/plugins/core-plugins/autologin/relog.md index 28ecd707e..0768ab828 100644 --- a/plugins/core-plugins/autologin/relog.md +++ b/plugins/core-plugins/autologin/relog.md @@ -5,11 +5,13 @@ tags: # /relog ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /relog [<#>s|<#>m] ``` +<!--cmd-syntax-end--> ## Description - -Logs out the current character and automatically logs back in after 10 seconds or specified delay. e.g. `/relog 5m` for 5 minutes. \ No newline at end of file +<!--cmd-desc-start--> +Logs out the current character and automatically logs back in after 10 seconds or specified delay. e.g. `/relog 5m` for 5 minutes. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/autologin/switchchar.md b/plugins/core-plugins/autologin/switchchar.md index 9e2203b27..af221a8da 100644 --- a/plugins/core-plugins/autologin/switchchar.md +++ b/plugins/core-plugins/autologin/switchchar.md @@ -5,11 +5,13 @@ tags: # /switchchar ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /switchchar <name> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Logs out of the current character and logs back into the specified character on the same server and account. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/autologin/switchserver.md b/plugins/core-plugins/autologin/switchserver.md index 776b87c08..746b18340 100644 --- a/plugins/core-plugins/autologin/switchserver.md +++ b/plugins/core-plugins/autologin/switchserver.md @@ -5,11 +5,13 @@ tags: # /switchserver ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /switchserver <server short name> <character name> ``` +<!--cmd-syntax-end--> ## Description - -Logs out of the current character and logs back into the specified server and character using the same account credentials. \ No newline at end of file +<!--cmd-desc-start--> +Logs out of the current character and logs back into the specified server and character using the same account credentials. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/autologin/tlo-autologin.md b/plugins/core-plugins/autologin/tlo-autologin.md index dde273022..5a9e56a66 100644 --- a/plugins/core-plugins/autologin/tlo-autologin.md +++ b/plugins/core-plugins/autologin/tlo-autologin.md @@ -4,18 +4,21 @@ tags: --- # `AutoLogin` +<!--tlo-desc-start--> Returns "AutoLogin" string when plugin is loaded, provides access to AutoLogin functionality. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='AutoLogin', name='AutoLogin') }} : Returns "AutoLogin" string when plugin is loaded +<!--tlo-forms-end--> ## Example ```text /echo ${AutoLogin} # Outputs "AutoLogin" ``` - +<!--tlo-linkrefs-start--> [AutoLogin]: datatype-autologin.md +<!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/bzsrch/README.md b/plugins/core-plugins/bzsrch/README.md index c6d075701..9dbb45951 100644 --- a/plugins/core-plugins/bzsrch/README.md +++ b/plugins/core-plugins/bzsrch/README.md @@ -3,20 +3,115 @@ tags: - plugin --- # Bzsrch - +<!--desc-start--> This plugin adds bazaar search access and commands. +<!--desc-end--> ## Commands -{{ embedCommand('plugins/core-plugins/bzsrch/bzsrch.md') }} -{{ embedCommand('plugins/core-plugins/bzsrch/breset.md') }} -{{ embedCommand('plugins/core-plugins/bzsrch/bzquery.md') }} +<a href="bzsrch/"> +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/bzsrch/bzsrch.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/bzsrch/bzsrch.md') }} + +<a href="breset/"> +{% + include-markdown "plugins/core-plugins/bzsrch/breset.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/bzsrch/breset.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/bzsrch/breset.md') }} + +<a href="bzquery/"> +{% + include-markdown "plugins/core-plugins/bzsrch/bzquery.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/bzsrch/bzquery.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/bzsrch/bzquery.md') }} ## Top-Level Objects -{{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md') }} +## [Bazaar](bzsrch-tlo-bazaar.md) +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md" + start="<!--tlo-desc-start-->" + end="<!--tlo-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md') }} + +<h2>Forms</h2> +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md" + start="<!--tlo-forms-start-->" + end="<!--tlo-forms-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md" + start="<!--tlo-linkrefs-start-->" + end="<!--tlo-linkrefs-end-->" +%} ## Datatypes -{{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md') }} -{{ embedMQType('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md') }} +## [bazaar](bzsrch-datatype-bazaar.md) +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [bazaaritem](bzsrch-datatype-bazaaritem.md) +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} diff --git a/plugins/core-plugins/bzsrch/breset.md b/plugins/core-plugins/bzsrch/breset.md index d228b1aa7..b4074036a 100644 --- a/plugins/core-plugins/bzsrch/breset.md +++ b/plugins/core-plugins/bzsrch/breset.md @@ -5,11 +5,13 @@ tags: # /breset ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /breset ``` +<!--cmd-syntax-end--> ## Description - -Stops and resets the current bazaar search. \ No newline at end of file +<!--cmd-desc-start--> +Stops and resets the current bazaar search. +<!--cmd-desc-end--> \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzquery.md b/plugins/core-plugins/bzsrch/bzquery.md index 9169ad4d6..809ef2376 100644 --- a/plugins/core-plugins/bzsrch/bzquery.md +++ b/plugins/core-plugins/bzsrch/bzquery.md @@ -5,11 +5,13 @@ tags: # /bzquery ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /bzquery ``` +<!--cmd-syntax-end--> ## Description - -The same as clicking the "find items" button on the bazaar window. \ No newline at end of file +<!--cmd-desc-start--> +The same as clicking the "find items" button on the bazaar window. +<!--cmd-desc-end--> \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md index f1b7b1bfa..973d2c69b 100644 --- a/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md +++ b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md @@ -4,10 +4,12 @@ tags: --- # `bazaar` -Datatype providing access to bazaar search results and status information.Datatype providing access to bazaar search results and status information. +<!--dt-desc-start--> +Datatype providing access to bazaar search results and status information. +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Count') }} : Number of search results available @@ -19,7 +21,10 @@ Datatype providing access to bazaar search results and status information.Dataty ### {{ renderMember(type='bazaaritem', name='SortedItem', params='#') }} : Returns the name of the item at the specified index from a sorted list, as you'd see it in the GUI. +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bazaaritem]: bzsrch-datatype-bazaaritem.md [bool]: ../../../reference/data-types/datatype-bool.md -[int]: ../../../reference/data-types/datatype-int.md \ No newline at end of file +[int]: ../../../reference/data-types/datatype-int.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md index e1acac88b..e8e725e4f 100644 --- a/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md +++ b/plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md @@ -4,10 +4,12 @@ tags: --- # `bazaaritem` +<!--dt-desc-start--> Represents an individual item in bazaar search results, providing access to item details and trader information. +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Name') }} : The name of the item. @@ -25,6 +27,7 @@ Represents an individual item in bazaar search results, providing access to item ### {{ renderMember(type='int', name='ItemID') }} : EQ item ID number +<!--dt-members-end--> ## Methods @@ -56,6 +59,7 @@ Represents an individual item in bazaar search results, providing access to item mq.TLO.Bazaar.Item(1).Select() print(mq.TLO.Bazaar.Item(3).FullName()) ``` - +<!--dt-linkrefs-start--> [int]: ../../../reference/data-types/datatype-int.md -[string]: ../../../reference/data-types/datatype-string.md \ No newline at end of file +[string]: ../../../reference/data-types/datatype-string.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md index b2f87a44e..3c1a25622 100644 --- a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md +++ b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md @@ -3,13 +3,17 @@ tags: - tlo --- # `Bazaar` - +<!--tlo-desc-start--> Provides access to bazaar search functionality and results. +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='bazaar', name='Bazaar') }} : TRUE if there are search results +<!--tlo-forms-end--> -[bazaar]: bzsrch-datatype-bazaar.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[bazaar]: bzsrch-datatype-bazaar.md +<!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/bzsrch/bzsrch.md b/plugins/core-plugins/bzsrch/bzsrch.md index fb653c0ef..bfa4e1166 100644 --- a/plugins/core-plugins/bzsrch/bzsrch.md +++ b/plugins/core-plugins/bzsrch/bzsrch.md @@ -5,14 +5,16 @@ tags: # /bzsrch ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /bzsrch [params] [name] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Searches the bazaar for items matching the specified criteria. Parameters mirror the bazaar window. +<!--cmd-desc-end--> ## Parameters diff --git a/plugins/core-plugins/chat/index.md b/plugins/core-plugins/chat/index.md index 028a66e25..d3b22cd81 100644 --- a/plugins/core-plugins/chat/index.md +++ b/plugins/core-plugins/chat/index.md @@ -3,8 +3,9 @@ tags: - plugin --- # Chat - +<!--desc-start--> This plugin directs MQ output to your main EQ chat window. +<!--desc-end--> !!! warning "MQ Output in Reports" Be careful if doing a /report or /petition because MQ output will be visible in the /report lines that you send. diff --git a/plugins/core-plugins/chatwnd/README.md b/plugins/core-plugins/chatwnd/README.md index 89bee5ae6..87d972c3d 100644 --- a/plugins/core-plugins/chatwnd/README.md +++ b/plugins/core-plugins/chatwnd/README.md @@ -3,17 +3,89 @@ tags: - plugin --- # ChatWnd - +<!--desc-start--> An additional window that displays all output from MacroQuest. Anything you type into this window will avoid your character log. +<!--desc-end--> ## Commands -{{ embedCommand('plugins/core-plugins/chatwnd/mqchat.md') }} -{{ embedCommand('plugins/core-plugins/chatwnd/style.md') }} -{{ embedCommand('plugins/core-plugins/chatwnd/mqfont.md') }} -{{ embedCommand('plugins/core-plugins/chatwnd/mqmin.md') }} -{{ embedCommand('plugins/core-plugins/chatwnd/mqclear.md') }} -{{ embedCommand('plugins/core-plugins/chatwnd/setchattitle.md') }} +<a href="mqchat/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqchat.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/chatwnd/mqchat.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqchat.md') }} + +<a href="style/"> +{% + include-markdown "plugins/core-plugins/chatwnd/style.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/chatwnd/style.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/style.md') }} + +<a href="mqfont/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqfont.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/chatwnd/mqfont.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqfont.md') }} + +<a href="mqmin/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqmin.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/chatwnd/mqmin.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqmin.md') }} + +<a href="mqclear/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqclear.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/chatwnd/mqclear.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqclear.md') }} + +<a href="setchattitle/"> +{% + include-markdown "plugins/core-plugins/chatwnd/setchattitle.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/chatwnd/setchattitle.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/setchattitle.md') }} ## Configuration diff --git a/plugins/core-plugins/chatwnd/mqchat.md b/plugins/core-plugins/chatwnd/mqchat.md index 2b8335d92..90b525759 100644 --- a/plugins/core-plugins/chatwnd/mqchat.md +++ b/plugins/core-plugins/chatwnd/mqchat.md @@ -5,15 +5,16 @@ tags: # /mqchat ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqchat [reset | ui | autoscroll {on|off} | NoCharSelect {on|off} | SaveByChar {on|off}] ``` +<!--cmd-syntax-end--> ## Description - -Configure and manage mqchatwnd's settings. - +<!--cmd-desc-start--> +Configure and manage mqchatwnd's settings. +<!--cmd-desc-end--> ## Options - **reset**: Resets window and INI settings. diff --git a/plugins/core-plugins/chatwnd/mqclear.md b/plugins/core-plugins/chatwnd/mqclear.md index 5a69f0775..a4bc8b913 100644 --- a/plugins/core-plugins/chatwnd/mqclear.md +++ b/plugins/core-plugins/chatwnd/mqclear.md @@ -5,11 +5,13 @@ tags: # /mqclear ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /breset ``` +<!--cmd-syntax-end--> ## Description - -Clears the chat buffer in the ChatWnd. \ No newline at end of file +<!--cmd-desc-start--> +Clears the chat buffer in the ChatWnd. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/chatwnd/mqfont.md b/plugins/core-plugins/chatwnd/mqfont.md index c204ed914..0d15bd07f 100644 --- a/plugins/core-plugins/chatwnd/mqfont.md +++ b/plugins/core-plugins/chatwnd/mqfont.md @@ -5,11 +5,13 @@ tags: # /mqfont ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqfont <#> ``` +<!--cmd-syntax-end--> ## Description - -Sets the font size in the MQ window, from 1 to 10. Default is 4. \ No newline at end of file +<!--cmd-desc-start--> +Sets the font size in the MQ window, from 1 to 10. Default is 4. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/chatwnd/mqmin.md b/plugins/core-plugins/chatwnd/mqmin.md index f89a75989..c1acfff28 100644 --- a/plugins/core-plugins/chatwnd/mqmin.md +++ b/plugins/core-plugins/chatwnd/mqmin.md @@ -5,12 +5,13 @@ tags: # /mqmin ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqmin ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Minimizes the ChatWnd. - +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/chatwnd/setchattitle.md b/plugins/core-plugins/chatwnd/setchattitle.md index 96e101965..9010d16fd 100644 --- a/plugins/core-plugins/chatwnd/setchattitle.md +++ b/plugins/core-plugins/chatwnd/setchattitle.md @@ -5,11 +5,13 @@ tags: # /setchattitle ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /setchattitle <title> ``` +<!--cmd-syntax-end--> ## Description - -Sets the title of the ChatWnd. By default, it's "MQ". \ No newline at end of file +<!--cmd-desc-start--> +Sets the title of the ChatWnd. By default, it's "MQ". +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/chatwnd/style.md b/plugins/core-plugins/chatwnd/style.md index 49c647c12..3b774d767 100644 --- a/plugins/core-plugins/chatwnd/style.md +++ b/plugins/core-plugins/chatwnd/style.md @@ -5,12 +5,13 @@ tags: # /style ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /style [!]0xN ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Set the style bit corresponding to 0xN or unset it if ! is supplied. See EQ documentation for further details about WindowStyle. - +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/custombinds/README.md b/plugins/core-plugins/custombinds/README.md index 1e86a4eaf..cae1af5a6 100644 --- a/plugins/core-plugins/custombinds/README.md +++ b/plugins/core-plugins/custombinds/README.md @@ -3,14 +3,24 @@ tags: - plugin --- # CustomBinds - +<!--desc-start--> Custom commands that are executed when key combinations are pressed. - You may specify a command for when the key is pressed (down), and another for when it is released (up). - +<!--desc-end--> ## Commands -{{ embedCommand('plugins/core-plugins/custombinds/custombind.md') }} +<a href="custombind/"> +{% + include-markdown "plugins/core-plugins/custombinds/custombind.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/custombinds/custombind.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/custombinds/custombind.md') }} ## Examples diff --git a/plugins/core-plugins/custombinds/custombind.md b/plugins/core-plugins/custombinds/custombind.md index 2da3038ae..7ca983463 100644 --- a/plugins/core-plugins/custombinds/custombind.md +++ b/plugins/core-plugins/custombinds/custombind.md @@ -5,15 +5,16 @@ tags: # /custombind ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /custombind [ list ] | [add|delete] <bindname> | [set|clear] <bindname>[-down|-up] [command] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This command is used to add, delete, list or change custom key bindings. See [/bind](../../../reference/commands/bind.md) and [/dumpbinds](../../../reference/commands/dumpbinds.md). - +<!--cmd-desc-end--> ## Parameters | Parameter | Description | diff --git a/plugins/core-plugins/eqbugfix/index.md b/plugins/core-plugins/eqbugfix/index.md index 9022810fd..0fc7a0657 100644 --- a/plugins/core-plugins/eqbugfix/index.md +++ b/plugins/core-plugins/eqbugfix/index.md @@ -3,5 +3,6 @@ tags: - plugin --- # EQBugFix - +<!--desc-start--> This plugin is used to correct bugs in EQ. +<!--desc-end--> diff --git a/plugins/core-plugins/hud/README.md b/plugins/core-plugins/hud/README.md index 10846810f..692a337a0 100644 --- a/plugins/core-plugins/hud/README.md +++ b/plugins/core-plugins/hud/README.md @@ -3,9 +3,9 @@ tags: - plugin --- # HUD - +<!--desc-start--> This plugin provides a Heads Up Display for your EQ window, which can provide a large amount of information in a relatively small amount of space. The HUD acts as a transparent background layer, upon which any information can be displayed. Each element of the HUD gets parsed each time MQ2Data is displayed, so there is no need to reload the HUD after making changes to the .ini file, they are instantly available as soon as you save. - +<!--desc-end--> The HUD is customized by entries in the MQ2HUD.ini file. The .ini file allows any number of HUDs to be created and saved within. Loading a new HUD from the .ini file can be done with `/loadhud`. The entry names are not case-sensitive. The default HUD entry is called [Elements] and can be loaded with the `/defaulthud` command. @@ -14,11 +14,70 @@ You can toggle the display of the HUD by using F11. ## Commands -{{ embedCommand('plugins/core-plugins/hud/loadhud.md') }} -{{ embedCommand('plugins/core-plugins/hud/defaulthud.md') }} -{{ embedCommand('plugins/core-plugins/hud/classhud.md') }} -{{ embedCommand('plugins/core-plugins/hud/zonehud.md') }} -{{ embedCommand('plugins/core-plugins/hud/unloadhud.md') }} +<a href="loadhud/"> +{% + include-markdown "plugins/core-plugins/hud/loadhud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/hud/loadhud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/loadhud.md') }} + +<a href="defaulthud/"> +{% + include-markdown "plugins/core-plugins/hud/defaulthud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/hud/defaulthud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/defaulthud.md') }} + +<a href="classhud/"> +{% + include-markdown "plugins/core-plugins/hud/classhud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/hud/classhud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/classhud.md') }} + +<a href="zonehud/"> +{% + include-markdown "plugins/core-plugins/hud/zonehud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/hud/zonehud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/zonehud.md') }} + +<a href="unloadhud/"> +{% + include-markdown "plugins/core-plugins/hud/unloadhud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/hud/unloadhud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/unloadhud.md') }} ## INI File Format @@ -105,4 +164,23 @@ RDPauseInd2=3,85,122,225,0,0,${RDPause} ## Top-Level Objects -{{ embedMQType('plugins/core-plugins/hud/tlo-hud.md') }} +## [HUD](tlo-hud.md) +{% + include-markdown "plugins/core-plugins/hud/tlo-hud.md" + start="<!--tlo-desc-start-->" + end="<!--tlo-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/hud/tlo-hud.md') }} + +<h2>Forms</h2> +{% + include-markdown "plugins/core-plugins/hud/tlo-hud.md" + start="<!--tlo-forms-start-->" + end="<!--tlo-forms-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/hud/tlo-hud.md" + start="<!--tlo-linkrefs-start-->" + end="<!--tlo-linkrefs-end-->" +%} diff --git a/plugins/core-plugins/hud/classhud.md b/plugins/core-plugins/hud/classhud.md index 0808547ca..15819cf45 100644 --- a/plugins/core-plugins/hud/classhud.md +++ b/plugins/core-plugins/hud/classhud.md @@ -5,10 +5,13 @@ tags: # /classhud ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /classhud {on|off} ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Loads the HUD section for your class. You must have a `[Class]` section in `MQ2HUD.ini`. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/hud/defaulthud.md b/plugins/core-plugins/hud/defaulthud.md index f27946531..a6df4bc11 100644 --- a/plugins/core-plugins/hud/defaulthud.md +++ b/plugins/core-plugins/hud/defaulthud.md @@ -5,11 +5,13 @@ tags: # /defaulthud ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /defaulthud ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Loads the default HUD. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/hud/loadhud.md b/plugins/core-plugins/hud/loadhud.md index c6930e915..be95014b4 100644 --- a/plugins/core-plugins/hud/loadhud.md +++ b/plugins/core-plugins/hud/loadhud.md @@ -5,11 +5,13 @@ tags: # /loadhud ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /loadhud <HUDName> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Load the specified HUD from the configuration file. e.g. `/loadhud elements` +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/hud/tlo-hud.md b/plugins/core-plugins/hud/tlo-hud.md index 8248f138d..ba04d61d8 100644 --- a/plugins/core-plugins/hud/tlo-hud.md +++ b/plugins/core-plugins/hud/tlo-hud.md @@ -4,18 +4,21 @@ tags: --- # `HUD` +<!--tlo-desc-start--> Returns the current HUD name. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='string', name='HUD') }} : Returns the current HUD name +<!--tlo-forms-end--> ## Example ```text /echo ${HUD} # Outputs "elements" ``` - +<!--tlo-linkrefs-start--> [string]: ../../../reference/data-types/datatype-string.md +<!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/hud/unloadhud.md b/plugins/core-plugins/hud/unloadhud.md index 1f565fd7b..691b0a885 100644 --- a/plugins/core-plugins/hud/unloadhud.md +++ b/plugins/core-plugins/hud/unloadhud.md @@ -5,11 +5,13 @@ tags: # /unloadhud ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /unloadhud <HUDName> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Unload the specified HUD from the configuration file. e.g. `/unloadhud elements` +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/hud/zonehud.md b/plugins/core-plugins/hud/zonehud.md index 9b593a809..cf113da6c 100644 --- a/plugins/core-plugins/hud/zonehud.md +++ b/plugins/core-plugins/hud/zonehud.md @@ -5,10 +5,13 @@ tags: # /zonehud ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /zonehud {on|off} ``` +<!--cmd-syntax-end--> ## Description -Toggles loading the HUD section for the current zone. You must have a `[zone]` section in `MQ2HUD.ini`, long names are used. +<!--cmd-desc-start--> +Toggles loading the HUD section for the current zone. You must have a `[zone]` section in `MQ2HUD.ini`, long names are used. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/itemdisplay/README.md b/plugins/core-plugins/itemdisplay/README.md index 831e4adea..f4551658d 100644 --- a/plugins/core-plugins/itemdisplay/README.md +++ b/plugins/core-plugins/itemdisplay/README.md @@ -3,13 +3,37 @@ tags: - plugin --- # ItemDisplay - +<!--desc-start--> This plugin shows spell information and item data in their respective display windows. It can also show custom notes. +<!--desc-end--> ## Commands -{{ embedCommand('plugins/core-plugins/itemdisplay/itemdisplay.md') }} -{{ embedCommand('plugins/core-plugins/itemdisplay/inote.md') }} +<a href="itemdisplay/"> +{% + include-markdown "plugins/core-plugins/itemdisplay/itemdisplay.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/itemdisplay/itemdisplay.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/itemdisplay/itemdisplay.md') }} + +<a href="inote/"> +{% + include-markdown "plugins/core-plugins/itemdisplay/inote.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/itemdisplay/inote.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/itemdisplay/inote.md') }} ## INI File @@ -33,8 +57,46 @@ ShowSpellsInfoOnItems=0 ## Top-Level Objects -{{ embedMQType('plugins/core-plugins/itemdisplay/tlo-displayitem.md') }} +## [DisplayItem](tlo-displayitem.md) +{% + include-markdown "plugins/core-plugins/itemdisplay/tlo-displayitem.md" + start="<!--tlo-desc-start-->" + end="<!--tlo-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/itemdisplay/tlo-displayitem.md') }} + +<h2>Forms</h2> +{% + include-markdown "plugins/core-plugins/itemdisplay/tlo-displayitem.md" + start="<!--tlo-forms-start-->" + end="<!--tlo-forms-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/itemdisplay/tlo-displayitem.md" + start="<!--tlo-linkrefs-start-->" + end="<!--tlo-linkrefs-end-->" +%} ## Datatypes -{{ embedMQType('plugins/core-plugins/itemdisplay/datatype-displayitem.md') }} +## [displayitem](datatype-displayitem.md) +{% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/itemdisplay/datatype-displayitem.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} diff --git a/plugins/core-plugins/itemdisplay/datatype-displayitem.md b/plugins/core-plugins/itemdisplay/datatype-displayitem.md index 533c4b97d..b6e71bf0f 100644 --- a/plugins/core-plugins/itemdisplay/datatype-displayitem.md +++ b/plugins/core-plugins/itemdisplay/datatype-displayitem.md @@ -4,10 +4,11 @@ tags: --- # `displayitem` +<!--dt-desc-start--> Holds members that can control and return status on item display windows. This datatype inherits all members from the **[item]** datatype. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Info') }} : Returns details from the item. Note that this is different from the "Information" member. @@ -41,10 +42,13 @@ Holds members that can control and return status on item display windows. This d : Gives access to the **[item]** datatype, although its members are already inherited. e.g. `/echo ${DisplayItem[2].Item.HP}` ### {{ renderMember(type='DisplayItem', name='Next') }} +<!--dt-members-end--> +<!--dt-linkrefs-start--> [DisplayItem]: datatype-displayitem.md [bool]: ../../../reference/data-types/datatype-bool.md [int]: ../../../reference/data-types/datatype-int.md [item]: ../../../reference/data-types/datatype-item.md [string]: ../../../reference/data-types/datatype-string.md -[window]: ../../../reference/data-types/datatype-window.md \ No newline at end of file +[window]: ../../../reference/data-types/datatype-window.md +<!--dt-linkrefs-end--> diff --git a/plugins/core-plugins/itemdisplay/inote.md b/plugins/core-plugins/itemdisplay/inote.md index d894e7c16..5d0ec67f3 100644 --- a/plugins/core-plugins/itemdisplay/inote.md +++ b/plugins/core-plugins/itemdisplay/inote.md @@ -5,14 +5,16 @@ tags: # /inote ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /inote <add|del> <itemno> <comment> ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Adds a note to the display window for a the specified item. The _comment_ can contain html `<br>` tags to break the line of text. - +<!--cmd-desc-end--> ## Example ```text diff --git a/plugins/core-plugins/itemdisplay/itemdisplay.md b/plugins/core-plugins/itemdisplay/itemdisplay.md index 94a105799..fa3b8c1ef 100644 --- a/plugins/core-plugins/itemdisplay/itemdisplay.md +++ b/plugins/core-plugins/itemdisplay/itemdisplay.md @@ -5,11 +5,13 @@ tags: # /itemdisplay ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /itemdisplay [LootButton|LucyButton] [on|off] | reload ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Controls display of the advanced loot buttons and lucy button on the item display and spell windows. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/itemdisplay/tlo-displayitem.md b/plugins/core-plugins/itemdisplay/tlo-displayitem.md index 1cf72df2d..a04cf90eb 100644 --- a/plugins/core-plugins/itemdisplay/tlo-displayitem.md +++ b/plugins/core-plugins/itemdisplay/tlo-displayitem.md @@ -4,10 +4,11 @@ tags: --- # `DisplayItem` +<!--tlo-desc-start--> Gives information on item windows - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='DisplayItem', name='DisplayItem') }} ### {{ renderMember(type='DisplayItem', name='DisplayItem', params='x') }} @@ -15,5 +16,8 @@ Gives information on item windows ### {{ renderMember(type='DisplayItem', name='DisplayItem', params='<itemname>') }} : Return the Item display window for the specified item name, if one exists. +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [DisplayItem]: datatype-displayitem.md +<!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/labels/index.md b/plugins/core-plugins/labels/index.md index 66c4fe59a..c02d7e982 100644 --- a/plugins/core-plugins/labels/index.md +++ b/plugins/core-plugins/labels/index.md @@ -3,9 +3,9 @@ tags: - plugin --- # Labels - +<!--desc-start--> This plugin allows you to use MQ2Data within your EQ UI. - +<!--desc-end--> * It provides a number of EQTypes that can be used exactly as you use the built-in EQTypes. * If there is not a suitable EQType for your use, you can use ToolTips to display custom information. diff --git a/plugins/core-plugins/map/README.md b/plugins/core-plugins/map/README.md index f245e06b2..9a2e51349 100644 --- a/plugins/core-plugins/map/README.md +++ b/plugins/core-plugins/map/README.md @@ -5,20 +5,133 @@ tags: # Map ## Description - +<!--desc-start--> This plugin provides additional functionality to the in game map. - +<!--desc-end--> ## Commands -{{ embedCommand('plugins/core-plugins/map/highlight.md') }} -{{ embedCommand('plugins/core-plugins/map/mapclick.md') }} -{{ embedCommand('plugins/core-plugins/map/mapfilter.md') }} -{{ embedCommand('plugins/core-plugins/map/maphide.md') }} -{{ embedCommand('plugins/core-plugins/map/mapnames.md') }} -{{ embedCommand('plugins/core-plugins/map/mapshow.md') }} -{{ embedCommand('plugins/core-plugins/map/mapactivelayer.md') }} -{{ embedCommand('plugins/core-plugins/map/maploc.md') }} +<a href="highlight/"> +{% + include-markdown "plugins/core-plugins/map/highlight.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/highlight.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/highlight.md') }} + +<a href="mapclick/"> +{% + include-markdown "plugins/core-plugins/map/mapclick.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/mapclick.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapclick.md') }} + +<a href="mapfilter/"> +{% + include-markdown "plugins/core-plugins/map/mapfilter.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/mapfilter.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapfilter.md') }} + +<a href="maphide/"> +{% + include-markdown "plugins/core-plugins/map/maphide.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/maphide.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/maphide.md') }} + +<a href="mapnames/"> +{% + include-markdown "plugins/core-plugins/map/mapnames.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/mapnames.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapnames.md') }} + +<a href="mapshow/"> +{% + include-markdown "plugins/core-plugins/map/mapshow.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/mapshow.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapshow.md') }} + +<a href="mapactivelayer/"> +{% + include-markdown "plugins/core-plugins/map/mapactivelayer.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/mapactivelayer.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapactivelayer.md') }} + +<a href="maploc/"> +{% + include-markdown "plugins/core-plugins/map/maploc.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/map/maploc.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/maploc.md') }} ## Top-Level Objects +## [MapSpawn](tlo-mapspawn.md) +{% + include-markdown "plugins/core-plugins/map/tlo-mapspawn.md" + start="<!--tlo-desc-start-->" + end="<!--tlo-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/map/tlo-mapspawn.md') }} -{{ embedMQType('plugins/core-plugins/map/tlo-mapspawn.md') }} \ No newline at end of file +<h2>Forms</h2> +{% + include-markdown "plugins/core-plugins/map/tlo-mapspawn.md" + start="<!--tlo-forms-start-->" + end="<!--tlo-forms-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/map/tlo-mapspawn.md" + start="<!--tlo-linkrefs-start-->" + end="<!--tlo-linkrefs-end-->" +%} diff --git a/plugins/core-plugins/map/highlight.md b/plugins/core-plugins/map/highlight.md index 5b0e16237..0fbab5d9d 100644 --- a/plugins/core-plugins/map/highlight.md +++ b/plugins/core-plugins/map/highlight.md @@ -5,11 +5,13 @@ tags: # /highlight ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /highlight [reset | <spawnfilter> | size | pulse | [color # # #]] ``` +<!--cmd-syntax-end--> ## Description - -Highlights the specified spawn(s) on the in-game map. Accepts partial names or any terms from [Spawn search](../../../reference/general/spawn-search.md). You can also specify a color, font size, and pulse for the highlight. \ No newline at end of file +<!--cmd-desc-start--> +Highlights the specified spawn(s) on the in-game map. Accepts partial names or any terms from [Spawn search](../../../reference/general/spawn-search.md). You can also specify a color, font size, and pulse for the highlight. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/map/mapactivelayer.md b/plugins/core-plugins/map/mapactivelayer.md index c1904c8fc..6986c7323 100644 --- a/plugins/core-plugins/map/mapactivelayer.md +++ b/plugins/core-plugins/map/mapactivelayer.md @@ -5,11 +5,13 @@ tags: # /mapactivelayer ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mapactivelayer [0 | 1 | 2 | 3] ``` +<!--cmd-syntax-end--> ## Description - -Changes active map layer. +<!--cmd-desc-start--> +Changes active map layer. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/map/mapclick.md b/plugins/core-plugins/map/mapclick.md index f59dd0f59..c226e3bdc 100644 --- a/plugins/core-plugins/map/mapclick.md +++ b/plugins/core-plugins/map/mapclick.md @@ -5,15 +5,16 @@ tags: # /mapclick ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mapclick [left] {list|<key[+key[...]]> {clear|<command>}} ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Define custom commands to execute when clicking on an in-game map object while holding down a specific key combination. - +<!--cmd-desc-end--> ## Options * `left` - Left-click (default is right-click) * `list` - List the current mapclicks that have been defined. diff --git a/plugins/core-plugins/map/mapfilter.md b/plugins/core-plugins/map/mapfilter.md index 8683163a2..87d5ade83 100644 --- a/plugins/core-plugins/map/mapfilter.md +++ b/plugins/core-plugins/map/mapfilter.md @@ -5,15 +5,16 @@ tags: # Mapfilter ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mapfilter <filter> [show|hide] [color <R# G# B#>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This controls what appears or does not appear on the in-game map. There's a nice GUI for these filters in [/mqsettings](../../../reference/commands/mqsettings.md). - +<!--cmd-desc-end--> ## Options * **`help`** will show all current settings. diff --git a/plugins/core-plugins/map/maphide.md b/plugins/core-plugins/map/maphide.md index 569aa9bf8..b78a25056 100644 --- a/plugins/core-plugins/map/maphide.md +++ b/plugins/core-plugins/map/maphide.md @@ -5,15 +5,16 @@ tags: # /maphide ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /maphide [<spawnsearch> | reset | repeat] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This will hide spawns from the map, using [Spawn search](../../../reference/general/spawn-search.md). Hidden spawns are in effect until you reset /maphide, or the mapped spawns are regenerated (such as changing certain map filters). - +<!--cmd-desc-end--> ## Examples * Re-generates the spawn list diff --git a/plugins/core-plugins/map/maploc.md b/plugins/core-plugins/map/maploc.md index d843a57d7..d9fed2a14 100644 --- a/plugins/core-plugins/map/maploc.md +++ b/plugins/core-plugins/map/maploc.md @@ -5,15 +5,16 @@ tags: # /maploc ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /maploc <x> <y> [<z>] [options] | [options] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Places a big X on a location or target. Helpful when you're given a loc and want to see it on the map. It's as simple as `/maploc 1 2 3` - +<!--cmd-desc-end--> ## Options * **size `<10-200>`** diff --git a/plugins/core-plugins/map/mapnames.md b/plugins/core-plugins/map/mapnames.md index 83ab5a20a..e68478c1b 100644 --- a/plugins/core-plugins/map/mapnames.md +++ b/plugins/core-plugins/map/mapnames.md @@ -5,15 +5,16 @@ tags: # /mapnames ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mapnames {target | normal} <option> | reset ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Controls how spawn names are displayed on the map, from minimal information to a very log name with ID#, class, race, level, etc. With no arguments, /mapnames will display the current settings for _target_ and _normal_ (both are set to %N by default). - +<!--cmd-desc-end--> ## Options * **target**: Changes the naming scheme of your target only. * **normal**: Changes the naming scheme of all spawns except for your target. diff --git a/plugins/core-plugins/map/mapshow.md b/plugins/core-plugins/map/mapshow.md index 97a51fc4a..ad832d932 100644 --- a/plugins/core-plugins/map/mapshow.md +++ b/plugins/core-plugins/map/mapshow.md @@ -5,11 +5,13 @@ tags: # /mapshow ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mapshow [<spawnsearch> | reset | repeat] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This will show spawns on the map, using [Spawn search](../../../reference/general/spawn-search.md). Shown spawns are in effect until you reset /mapshow, or the mapped spawns are regenerated (such as changing certain map filters). Repeat will save the state and apply it to future sessions. +<!--cmd-desc-end--> diff --git a/plugins/core-plugins/map/tlo-mapspawn.md b/plugins/core-plugins/map/tlo-mapspawn.md index 2e78e5c01..ee68ff57a 100644 --- a/plugins/core-plugins/map/tlo-mapspawn.md +++ b/plugins/core-plugins/map/tlo-mapspawn.md @@ -4,14 +4,18 @@ tags: --- # `MapSpawn` +<!--tlo-desc-start--> Object that is created when your cursor hovers over a spawn on the map - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='spawn', name='MapSpawn') }} : When your cursor hovers over a spawn, the spawn type is used. e.g. `/echo ${MapSpawn.Gender}` ### {{ renderMember(type='ground', name='MapSpawn') }} : When your cursor hovers over a ground item, the ground type is used. e.g. `/invoke ${MapSpawn.Grab}` +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [spawn]: ../../../reference/data-types/datatype-spawn.md [ground]: ../../../reference/data-types/datatype-ground.md +<!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/targetinfo/index.md b/plugins/core-plugins/targetinfo/index.md index ebe201c5b..99ded3b41 100644 --- a/plugins/core-plugins/targetinfo/index.md +++ b/plugins/core-plugins/targetinfo/index.md @@ -5,12 +5,23 @@ tags: # TargetInfo ## Description - -Distance, line of sight and place-holder info directly on target. - +<!--desc-start--> +Distance, line of sight and place-holder info directly on target. +<!--desc-end--> ## Commands -{{ embedCommand('plugins/core-plugins/targetinfo/targetinfo.md') }} +<a href="targetinfo/"> +{% + include-markdown "plugins/core-plugins/targetinfo/targetinfo.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/targetinfo/targetinfo.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/targetinfo/targetinfo.md') }} ## Settings diff --git a/plugins/core-plugins/targetinfo/targetinfo.md b/plugins/core-plugins/targetinfo/targetinfo.md index 25098545d..ba97cc576 100644 --- a/plugins/core-plugins/targetinfo/targetinfo.md +++ b/plugins/core-plugins/targetinfo/targetinfo.md @@ -5,22 +5,23 @@ tags: # /targetinfo ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /targetinfo [perchar | distance | info | placeholder | sight | reset | reload] [on|off] ``` +<!--cmd-syntax-end--> ## Description - -Toggle settings on the [Targetinfo plugin](index.md). - +<!--cmd-desc-start--> +Toggle settings on the TargetInfo plugin. +<!--cmd-desc-end--> ## Options -- **perchar [on|off]**: Use settings per character. -- **distance [on|off]**: Show distance to target. -- **info [on|off]**: Show detailed target info. -- **placeholder [on|off]**: Show placeholder/named information. -- **sight [on|off]**: Toggle O/X based on line of sight. -- **reset**: Resets the .ini to default, handy if you're using an old .ini from a previous version that was converted. -- **reload**: Reloads the settings from the .ini file. +- `perchar [on|off]`: Use settings per character. +- `distance [on|off]`: Show distance to target. +- `info [on|off]`: Show detailed target info. +- `placeholder [on|off]`: Show placeholder/named information. +- `sight [on|off]`: Toggle O/X based on line of sight. +- `reset`: Resets the .ini to default, handy if you're using an old .ini from a previous version that was converted. +- `reload`: Reloads the settings from the .ini file. diff --git a/plugins/core-plugins/xtarinfo/index.md b/plugins/core-plugins/xtarinfo/index.md index 74cb2eae6..0b7888e61 100644 --- a/plugins/core-plugins/xtarinfo/index.md +++ b/plugins/core-plugins/xtarinfo/index.md @@ -5,12 +5,24 @@ tags: # XTarInfo ## Description - +<!--desc-start--> XTarInfo adds distance and other information to the Extended Target Window - +<!--desc-end--> ## Commands -{{ embedCommand('plugins/core-plugins/xtarinfo/xtarinfo.md') }} +<a href="xtarinfo/"> +{% + include-markdown "plugins/core-plugins/xtarinfo/xtarinfo.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "plugins/core-plugins/xtarinfo/xtarinfo.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/xtarinfo/xtarinfo.md') }} + ## Settings diff --git a/plugins/core-plugins/xtarinfo/xtarinfo.md b/plugins/core-plugins/xtarinfo/xtarinfo.md index 117d25408..426d9dd03 100644 --- a/plugins/core-plugins/xtarinfo/xtarinfo.md +++ b/plugins/core-plugins/xtarinfo/xtarinfo.md @@ -5,11 +5,13 @@ tags: # /xtarinfo ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /xtarinfo perchar [on | off] | distance [on | off] | reset | reload ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Toggle settings on the XTarInfo plugin. `perchar` will allow unique settings for each character, and `distance` will show distance to target. `reset` will reset the plugin to default settings, and `reload` will load settings from the plugin's config. +<!--cmd-desc-end--> From 951f3cc77beb6178783bbfc49e406317d219ad57 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 10 May 2025 18:13:38 -0500 Subject: [PATCH 14/41] include-markdown markup for commands --- reference/commands/aa.md | 7 +- reference/commands/advloot.md | 7 +- reference/commands/alert.md | 7 +- reference/commands/alias.md | 6 +- reference/commands/altkey.md | 10 +- reference/commands/banklist.md | 7 +- reference/commands/beep.md | 7 +- reference/commands/beepontells.md | 7 +- reference/commands/benchmark.md | 7 +- reference/commands/bind.md | 7 +- reference/commands/break.md | 8 +- reference/commands/buyitem.md | 7 +- reference/commands/cachedbuffs.md | 6 +- reference/commands/call.md | 12 +- reference/commands/caption.md | 7 +- reference/commands/captioncolor.md | 7 +- reference/commands/cast.md | 7 +- reference/commands/cecho.md | 6 +- reference/commands/char.md | 9 +- reference/commands/cleanup.md | 6 +- reference/commands/clearerrors.md | 6 +- reference/commands/click.md | 7 +- reference/commands/combine.md | 7 +- reference/commands/comparecmd.py | 37 ++++++ reference/commands/comparemqcommand.py | 176 +++++++++++++++++++++++++ reference/commands/continue.md | 7 +- reference/commands/convertitem.md | 6 +- reference/commands/crash.md | 6 +- reference/commands/ctrlkey.md | 7 +- reference/commands/declare.md | 6 +- reference/commands/delay.md | 7 +- reference/commands/deletevar.md | 6 +- reference/commands/destroy.md | 7 +- reference/commands/doability.md | 8 +- reference/commands/docommand.md | 7 +- reference/commands/doevents.md | 7 +- reference/commands/doors.md | 7 +- reference/commands/doortarget.md | 7 +- reference/commands/dosocial.md | 7 +- reference/commands/drop.md | 7 +- reference/commands/dumpbinds.md | 7 +- reference/commands/dumpstack.md | 7 +- reference/commands/echo.md | 7 +- reference/commands/endmacro.md | 9 +- reference/commands/engine.md | 5 +- reference/commands/eqtarget.md | 9 +- reference/commands/exec.md | 7 +- reference/commands/executelink.md | 7 +- reference/commands/face.md | 7 +- reference/commands/filter.md | 7 +- reference/commands/flashontells.md | 7 +- reference/commands/for.md | 11 +- reference/commands/foreground.md | 6 +- reference/commands/framelimiter.md | 47 ++++--- reference/commands/getwintitle.md | 6 +- reference/commands/goto.md | 7 +- reference/commands/help.md | 8 +- reference/commands/hotbutton.md | 7 +- reference/commands/hud.md | 7 +- reference/commands/identify.md | 7 +- reference/commands/if.md | 7 +- reference/commands/ini.md | 7 +- reference/commands/insertaug.md | 9 +- reference/commands/invoke.md | 7 +- reference/commands/itemnotify.md | 7 +- reference/commands/items.md | 7 +- reference/commands/itemslots.md | 9 +- reference/commands/itemtarget.md | 6 +- reference/commands/keepkeys.md | 7 +- reference/commands/keypress.md | 5 +- reference/commands/listmacros.md | 7 +- reference/commands/loadcfg.md | 7 +- reference/commands/loadspells.md | 5 +- reference/commands/location.md | 9 +- reference/commands/loginname.md | 6 +- reference/commands/look.md | 7 +- reference/commands/lootall.md | 7 +- reference/commands/macro.md | 7 +- reference/commands/makemevisible.md | 7 +- reference/commands/memspell.md | 7 +- reference/commands/mercswitch.md | 7 +- reference/commands/mouseto.md | 8 +- reference/commands/mqanon.md | 6 +- reference/commands/mqconsole.md | 9 +- reference/commands/mqcopylayout.md | 7 +- reference/commands/mqlistmodules.md | 7 +- reference/commands/mqlistprocesses.md | 7 +- reference/commands/mqlog.md | 7 +- reference/commands/mqoverlay.md | 9 +- reference/commands/mqpause.md | 7 +- reference/commands/mqsettings.md | 7 +- reference/commands/mqtarget.md | 7 +- reference/commands/msgbox.md | 8 +- reference/commands/multiline.md | 7 +- reference/commands/netstatusxpos.md | 7 +- reference/commands/netstatusypos.md | 7 +- reference/commands/next.md | 6 +- reference/commands/no.md | 10 +- reference/commands/nomodkey.md | 6 +- reference/commands/noparse.md | 7 +- reference/commands/notify.md | 7 +- reference/commands/pet.md | 7 +- reference/commands/pickzone.md | 7 +- reference/commands/plugin.md | 7 +- reference/commands/popcustom.md | 7 +- reference/commands/popup.md | 7 +- reference/commands/popupecho.md | 7 +- reference/commands/profile.md | 7 +- reference/commands/quit.md | 8 +- reference/commands/ranged.md | 8 +- reference/commands/reloadui.md | 7 +- reference/commands/removeaug.md | 8 +- reference/commands/removeaura.md | 7 +- reference/commands/removebuff.md | 7 +- reference/commands/removelev.md | 7 +- reference/commands/removepetbuff.md | 7 +- reference/commands/return.md | 7 +- reference/commands/screenmode.md | 9 +- reference/commands/selectitem.md | 7 +- reference/commands/sellitem.md | 7 +- reference/commands/setautorun.md | 6 +- reference/commands/seterror.md | 6 +- reference/commands/setprio.md | 7 +- reference/commands/setwintitle.md | 8 +- reference/commands/shiftkey.md | 7 +- reference/commands/skills.md | 7 +- reference/commands/spellslotinfo.md | 7 +- reference/commands/spew.md | 7 +- reference/commands/squelch.md | 7 +- reference/commands/syntaxconvert.py | 68 ++++++++++ reference/commands/target.md | 7 +- reference/commands/taskquit.md | 6 +- reference/commands/timed.md | 7 +- reference/commands/timestamp.md | 5 +- reference/commands/tloc.md | 8 +- reference/commands/unload.md | 7 +- reference/commands/useitem.md | 8 +- reference/commands/usercamera.md | 7 +- reference/commands/varcalc.md | 7 +- reference/commands/vardata.md | 7 +- reference/commands/varset.md | 7 +- reference/commands/where.md | 7 +- reference/commands/while.md | 7 +- reference/commands/who.md | 7 +- reference/commands/whofilter.md | 6 +- reference/commands/whotarget.md | 6 +- reference/commands/windows.md | 7 +- reference/commands/windowstate.md | 8 +- reference/commands/yes.md | 7 +- 149 files changed, 923 insertions(+), 436 deletions(-) create mode 100644 reference/commands/comparecmd.py create mode 100644 reference/commands/comparemqcommand.py create mode 100644 reference/commands/syntaxconvert.py diff --git a/reference/commands/aa.md b/reference/commands/aa.md index 8186ca8d1..b7bf9479a 100644 --- a/reference/commands/aa.md +++ b/reference/commands/aa.md @@ -5,15 +5,16 @@ tags: # /aa ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /aa [list (all | timers)] [info <abilityname> ] [act <abilityname> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Used to retrieve information on AA Abilities, or to activate an AA ability. - +<!--cmd-desc-end--> ## Examples | | | diff --git a/reference/commands/advloot.md b/reference/commands/advloot.md index f5b09967a..5d2be792d 100644 --- a/reference/commands/advloot.md +++ b/reference/commands/advloot.md @@ -5,15 +5,16 @@ tags: # /advloot ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /advloot {personal | shared} {set | <"item name"> | <#index> } <window option> [ <quantity> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Extends EverQuest's `/advloot` command to allow control of the advloot window, including item-specific control. - +<!--cmd-desc-end--> ### Personal Loot Window diff --git a/reference/commands/alert.md b/reference/commands/alert.md index 5d926a12b..9330bb132 100644 --- a/reference/commands/alert.md +++ b/reference/commands/alert.md @@ -5,15 +5,16 @@ tags: # /alert ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /alert { add | remove | clear | list } <#list> [ <Spawn Search> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Used to manipulate alert lists which "watch" for spawns. Uses [Spawn Search](../general/spawn-search.md). - +<!--cmd-desc-end--> ## Options | Option | Description | diff --git a/reference/commands/alias.md b/reference/commands/alias.md index 6c1ba3279..9476e5ad3 100644 --- a/reference/commands/alias.md +++ b/reference/commands/alias.md @@ -5,14 +5,16 @@ tags: # /alias ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /alias <aliasname> <command> | [list | reload | <aliasname> delete] ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Creates custom command shortcuts. Aliases are saved in MacroQuest.ini and persist between sessions. - +<!--cmd-desc-end--> ## Examples | Command | Description | diff --git a/reference/commands/altkey.md b/reference/commands/altkey.md index a6f607d07..d21ecdc53 100644 --- a/reference/commands/altkey.md +++ b/reference/commands/altkey.md @@ -5,15 +5,21 @@ tags: # /altkey ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /altkey <command> ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> +Execute _command_ while telling the window manager that the alt key is pressed. +<!--cmd-desc-end--> -Execute _command_ while telling the window manager that the alt key is pressed. Can also be used together with [/ctrlkey](ctrlkey.md) , [/shiftkey](shiftkey.md) , or both as in: +## Note +Can also be used together with [/ctrlkey](ctrlkey.md) , [/shiftkey](shiftkey.md) , or both as in: ```text /ctrlkey /altkey /shiftkey command ``` + diff --git a/reference/commands/banklist.md b/reference/commands/banklist.md index 7e356f82f..f8bca6a85 100644 --- a/reference/commands/banklist.md +++ b/reference/commands/banklist.md @@ -5,13 +5,14 @@ tags: # /banklist ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /banklist ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Displays an inventory of the currently logged in character in this format: ```text @@ -20,4 +21,4 @@ Bankslot#:Typeofcontainer -Containerslot2:Item -etc ``` - +<!--cmd-desc-end--> diff --git a/reference/commands/beep.md b/reference/commands/beep.md index bedc5053d..2866142cc 100644 --- a/reference/commands/beep.md +++ b/reference/commands/beep.md @@ -5,13 +5,14 @@ tags: # /beep ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /beep [ <filename> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Invokes a system beep (beep from the built-in PC speaker). Adding _filename_ will play a .wav file located in your Everquest directory. This function uses the In-game sound so while a normal /beep will sound if you have EQ muted, this will not. @@ -19,4 +20,4 @@ Adding _filename_ will play a .wav file located in your Everquest directory. Thi If you prefer you can play the sounds in the Everquest "sounds" directory by using something like /beep sounds/_filename_ - +<!--cmd-desc-end--> diff --git a/reference/commands/beepontells.md b/reference/commands/beepontells.md index 1496983f5..d680f5954 100644 --- a/reference/commands/beepontells.md +++ b/reference/commands/beepontells.md @@ -5,15 +5,16 @@ tags: # /beepontells ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /beepontells [on|off] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Beeps when you receive a tell from another player. If no parameter is provided, it toggles the current setting. - +<!--cmd-desc-end--> ## Notes - The setting is saved in MacroQuest.ini under the [MacroQuest] section as `BeepOnTells=1` or `BeepOnTells=0` diff --git a/reference/commands/benchmark.md b/reference/commands/benchmark.md index 053f2d2b1..65b1f143f 100644 --- a/reference/commands/benchmark.md +++ b/reference/commands/benchmark.md @@ -5,15 +5,16 @@ tags: # /benchmark ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /benchmark [<command>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Produces a list of all active benchmarks, or times the execution of a command. - +<!--cmd-desc-end--> ## Examples | Command | Description | | :--- | :--- | diff --git a/reference/commands/bind.md b/reference/commands/bind.md index da78aa02a..79537e5ef 100644 --- a/reference/commands/bind.md +++ b/reference/commands/bind.md @@ -5,15 +5,16 @@ tags: # /bind ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /bind [~]<name> [ <keycombo> | clear] | [list | eqlist] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Bind a key combination to a specific key. - +<!--cmd-desc-end--> | | | | :--- | :--- | | **/bind list** | Lists all MQ binds | diff --git a/reference/commands/break.md b/reference/commands/break.md index d45d0cfce..cbd57b184 100644 --- a/reference/commands/break.md +++ b/reference/commands/break.md @@ -5,14 +5,16 @@ tags: # /break ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /break ``` +<!--cmd-syntax-end--> -## **Description** - +## Description +<!--cmd-desc-start--> End a /for or /while loop immediately. +<!--cmd-desc-end--> ## Example diff --git a/reference/commands/buyitem.md b/reference/commands/buyitem.md index 1f9c901e2..3ec933d57 100644 --- a/reference/commands/buyitem.md +++ b/reference/commands/buyitem.md @@ -5,15 +5,16 @@ tags: # /buyitem ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /buyitem [<quantity>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Purchases the currently selected item from a merchant window. You must have an item selected in the merchant window for this command to work. - +<!--cmd-desc-end--> ## Examples - `/buyitem 20` - Buys 20 of the currently selected item diff --git a/reference/commands/cachedbuffs.md b/reference/commands/cachedbuffs.md index 367322ac2..da41fe999 100644 --- a/reference/commands/cachedbuffs.md +++ b/reference/commands/cachedbuffs.md @@ -6,11 +6,13 @@ tags: # /cachedbuffs ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /cachedbuffs [cleartarget|reset] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Clear cached buffs for your current target (cleartarget) or all cached buffs (reset). +<!--cmd-desc-end--> diff --git a/reference/commands/call.md b/reference/commands/call.md index 48deada60..d5a7104e2 100644 --- a/reference/commands/call.md +++ b/reference/commands/call.md @@ -5,18 +5,18 @@ tags: # /call ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /call <subroutine> [Param0... [Param#]] ``` - -### Description - +<!--cmd-syntax-end--> +## Description +<!--cmd-desc-start--> Calls _subroutine_ (defined later in the macro by "Sub _subroutine_"). - +<!--cmd-desc-end--> (_See_ [_Subroutines_](../../macros/subroutines.md) _for detailed information_) -### Examples +## Examples | \*\*\*\* | | | :--- | :--- | diff --git a/reference/commands/caption.md b/reference/commands/caption.md index 175fbf9c4..138c02eb0 100644 --- a/reference/commands/caption.md +++ b/reference/commands/caption.md @@ -5,15 +5,16 @@ tags: # /caption ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /caption list | update <#> | MQCaptions [on|off] | reload | <type> <value> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Customize spawn captions (names, titles, linkdead, etc.). You can also limit how many captions are processed to improve performance. - +<!--cmd-desc-end--> ## Options * **list** - List custom captions diff --git a/reference/commands/captioncolor.md b/reference/commands/captioncolor.md index 691434e0f..73b7a11f2 100644 --- a/reference/commands/captioncolor.md +++ b/reference/commands/captioncolor.md @@ -5,17 +5,18 @@ tags: # /captioncolor ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /captioncolor list | <"name"> [ off | on | <r g b> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Allows you to change the color of the captions that appear above the heads of PCs and NPCs, based on various factors. **Note:** raid class colors can only be set through the raid options window. - +<!--cmd-desc-end--> ## Settings Below are the default settings for each of the possible Caption Colors: diff --git a/reference/commands/cast.md b/reference/commands/cast.md index 58a857a2c..842a49dbd 100644 --- a/reference/commands/cast.md +++ b/reference/commands/cast.md @@ -5,15 +5,16 @@ tags: # /cast ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /cast [ list | <"spellname"> | item <"itemname"> ] [ loc <x y z> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> MacroQuest adds additional functionality to EverQuest's `/cast #` (gem number) command: cast by spell name, use items that have a "click" spell effect, and cast splash spells at a specific location. - +<!--cmd-desc-end--> ## Options - **list** - List of spells currently memorized and their gems diff --git a/reference/commands/cecho.md b/reference/commands/cecho.md index 05ebfb61a..048e6469c 100644 --- a/reference/commands/cecho.md +++ b/reference/commands/cecho.md @@ -5,11 +5,13 @@ tags: # /cecho ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /cecho <text> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Echoes the provided text verbatim. Escape codes are not supported. +<!--cmd-desc-end--> diff --git a/reference/commands/char.md b/reference/commands/char.md index 19cf6af96..d64ac81cc 100644 --- a/reference/commands/char.md +++ b/reference/commands/char.md @@ -5,15 +5,16 @@ tags: # /char ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /char ``` +<!--cmd-syntax-end--> ## Description - -Extends EverQuest's `/charinfo` to display character bind points. The alias `/char` must be used if you want MacroQuest's information included. - +<!--cmd-desc-start--> +Extends EverQuest's `/charinfo` to display character bind points. The alias `/char` must be used if you want MacroQuest's information included. +<!--cmd-desc-end--> ## Note Uses _Y, X, Z_ location to match the convention used by EQ (Rather than _X, Y, Z_ used by the rest of the world and MQ internally). diff --git a/reference/commands/cleanup.md b/reference/commands/cleanup.md index 427b42e70..407ebcf06 100644 --- a/reference/commands/cleanup.md +++ b/reference/commands/cleanup.md @@ -5,11 +5,13 @@ tags: # /cleanup ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /cleanup ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Closes all open windows and then opens inventory window. +<!--cmd-desc-end--> diff --git a/reference/commands/clearerrors.md b/reference/commands/clearerrors.md index 9b6de8875..33b75f424 100644 --- a/reference/commands/clearerrors.md +++ b/reference/commands/clearerrors.md @@ -5,15 +5,17 @@ tags: # /clearerrors ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /clearerrors ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Clears each of the last errors in the [_macroquest_](../../reference/data-types/datatype-macroquest.md) type: * **${MacroQuest.Error}** * **${MacroQuest.MQ2DataError}** * **${MacroQuest.SyntaxError}** +<!--cmd-desc-end--> diff --git a/reference/commands/click.md b/reference/commands/click.md index 339d8a234..952ba6a78 100644 --- a/reference/commands/click.md +++ b/reference/commands/click.md @@ -5,15 +5,16 @@ tags: # /click ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /click [ left | right ] [ target | item | door | switch | center | <x> <y> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes a left or right mouse button click on targets or specific screen location. - +<!--cmd-desc-end--> ### Click targets - **target**: Clicks your current target (PC, NPC) diff --git a/reference/commands/combine.md b/reference/commands/combine.md index a5752272a..4cffa28d0 100644 --- a/reference/commands/combine.md +++ b/reference/commands/combine.md @@ -5,15 +5,16 @@ tags: # /combine ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /combine pack<#> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Activates the Combine button of pack\# - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/comparecmd.py b/reference/commands/comparecmd.py new file mode 100644 index 000000000..e997c61f4 --- /dev/null +++ b/reference/commands/comparecmd.py @@ -0,0 +1,37 @@ +#lets find out if we have all the commands in the README.md file +import os +import re + +# Configuration +commands_dir = "D:/Users/Trevor/Dropbox/work/scripts/readguides/docs/projects/macroquest/reference/commands" +readme_path = "D:/Users/Trevor/Dropbox/work/scripts/readguides/docs/projects/macroquest/reference/commands/README.md" + + + + +# Get list of command files (excluding README.md) +command_files = set() +for f in os.listdir(commands_dir): + if f.endswith(".md") and f != "README.md": + command_files.add(f[:-3].lower()) # Remove .md extension and normalize case + +# Parse README.md for listed commands +with open(readme_path, "r", encoding="utf-8") as f: + readme_content = f.read() + +# Find all command links in format [/command](command) +listed_commands = set(re.findall(r"\[/(\w+)\]\([\w/.-]+\)", readme_content, re.IGNORECASE)) + +# Compare sets +missing_in_readme = command_files - listed_commands +extra_in_readme = listed_commands - command_files + +# Print results +print("Commands missing from README.md:") +print("\n".join(sorted(missing_in_readme)) or "None") + +print("\nCommands in README but missing documentation files:") +print("\n".join(sorted(extra_in_readme)) or "None") + +# Print summary +print(f"\nDocumentation coverage: {len(command_files & listed_commands)}/{len(command_files)} commands documented") \ No newline at end of file diff --git a/reference/commands/comparemqcommand.py b/reference/commands/comparemqcommand.py new file mode 100644 index 000000000..40abcea5b --- /dev/null +++ b/reference/commands/comparemqcommand.py @@ -0,0 +1,176 @@ +import os +import re + +# Get list of existing command files (excluding index.md) +command_files = [f for f in os.listdir() if f.endswith(".md") and f != "index.md"] + +# Extract command names from C++ array +cpp_commands = """ + // Add MQ commands... + struct { const char* szCommand; MQCommandHandler pFunc; bool Parse; bool InGame; } NewCommands[] = { + { "/aa", AltAbility, true, true }, +#if HAS_ADVANCED_LOOT + { "/advloot", AdvLootCmd, true, true }, +#endif + { "/alert", Alert, true, true }, + { "/alias", Alias, false, false }, + { "/altkey", DoAltCmd, false, false }, + { "/assist", AssistCmd, true, true }, + { "/banklist", BankList, true, true }, + { "/beep", MacroBeep, true, false }, + { "/bind", MQ2KeyBindCommand, true, false }, + { "/break", Break, true, false }, + { "/buyitem", BuyItem, true, true }, + { "/cachedbuffs", CachedBuffsCommand, true, true }, + { "/call", Call, true, false }, + { "/cast", Cast, true, true }, + { "/cecho", EchoClean, true, false }, + { "/char", CharInfo, true, true }, + { "/cleanup", Cleanup, true, false }, + { "/clearerrors", ClearErrorsCmd, true, false }, + { "/click", Click, true, false }, + { "/combine", CombineCmd, true, true }, + { "/continue", Continue, true, false }, +#if HAS_ITEM_CONVERT_BUTTON + { "/convertitem", ConvertItemCmd, true, true }, +#endif + { "/ctrlkey", DoCtrlCmd, false, false }, + { "/declare", DeclareVar, true, false }, + { "/delay", Delay, false, false }, // do not parse + { "/deletevar", DeleteVarCmd, true, false }, + { "/destroy", EQDestroyHeldItemOrMoney, true, true }, + { "/doability", DoAbility, true, true }, + { "/docommand", DoCommandCmd, true, false }, + { "/doevents", DoEvents, true, false }, + { "/doors", Doors, true, true }, + { "/doortarget", DoorTarget, true, true }, + { "/dosocial", DoSocial, true, true }, + { "/drop", DropCmd, true, true }, + { "/dumpbinds", DumpBindsCommand, true, false }, + { "/dumpstack", DumpStack, true, false }, + { "/echo", Echo, true, false }, + { "/endmacro", EndMacro, true, false }, + { "/engine", EngineCommand, true, false }, + { "/exec", Exec, true, false }, + { "/executelink", ExecuteLinkCommand, true, true }, + { "/face", Face, true, true }, + { "/filter", Filter, true, false }, + { "/for", For, true, false }, + { "/foreground", ForeGroundCmd, true, false }, + { "/getwintitle", GetWinTitle, true, false }, + { "/goto", Goto, true, false }, + { "/help", Help, true, false }, + { "/hotbutton", DoHotButton, true, true }, + { "/hud", HudCmd, true, false }, + { "/identify", Identify, true, true }, + { "/if", MacroIfCmd, true, false }, + { "/ini", IniOutput, true, false }, + { "/insertaug", InsertAugCmd, true, true }, + { "/invoke", InvokeCmd, true, false }, + { "/items", Items, true, true }, + { "/itemtarget", ItemTarget, true, true }, + { "/keepkeys", KeepKeys, true, false }, + { "/keypress", DoMappable, true, false }, + { "/listmacros", ListMacros, true, false }, + { "/loadcfg", LoadCfgCommand, true, false }, + { "/loadspells", LoadSpells, true, true }, + { "/location", Location, true, true }, + { "/loginname", DisplayLoginName, true, false }, + { "/look", Look, true, true }, + { "/lootall", LootAll, true, false }, + { "/macro", Macro, true, false }, + { "/makemevisible", MakeMeVisible, false, true }, + { "/memspell", MemSpell, true, true }, + { "/mercswitch", MercSwitchCmd, true, true }, + { "/mouseto", MouseTo, true, false }, + { "/mqcopylayout", MQCopyLayout, true, false }, + { "/mqlistmodules", ListModulesCommand, false, false }, + { "/mqlistprocesses", ListProcessesCommand, false, false }, + { "/mqlog", MacroLog, true, false }, + { "/mqpause", MacroPause, true, false }, + { "/mqtarget", Target, true, true }, + { "/msgbox", MQMsgBox, true, false }, + { "/multiline", MultilineCommand, false, false }, + { "/next", Next, true, false }, + { "/nomodkey", NoModKeyCmd, false, false }, + { "/noparse", NoParseCmd, false, false }, + { "/pet", PetCmd, true, true }, + { "/pickzone", PickZoneCmd, true, true }, + { "/popcustom", PopupTextCustom, true, true }, + { "/popup", PopupText, true, true }, + { "/popupecho", PopupTextEcho, true, true }, + { "/profile", ProfileCmd, true, false }, + { "/quit", QuitCmd, true, false }, + { "/ranged", RangedCmd, true, true }, + { "/reloadui", ReloadUICmd, true, true }, + { "/removeaug", RemoveAugCmd, true, true }, + { "/removeaura", RemoveAura, true, true }, + { "/removebuff", RemoveBuff, true, true }, + { "/removelev", RemoveLevCmd, true, false }, + { "/removepetbuff", RemovePetBuff, true, true }, + { "/return", Return, true, false }, + { "/screenmode", ScreenModeCmd, true, false }, + { "/selectitem", SelectItem, true, true }, + { "/sellitem", SellItem, true, true }, + { "/setautorun", SetAutoRun, false, true }, + { "/seterror", SetError, true, false }, + { "/setprio", SetProcessPriority, true, false }, + { "/setwintitle", SetWinTitle, true, false }, + { "/shiftkey", DoShiftCmd, false, false }, + { "/skills", Skills, true, true }, + { "/spellslotinfo", SpellSlotInfo, true, true }, + { "/spewfile", DebugSpewFile, true, false }, + { "/squelch", SquelchCommand, true, false }, + { "/target", Target, true, true }, // TODO: Deprecate /target in favor of /mqtarget so that /target is the actual EQ Command. See #298 + { "/taskquit", TaskQuitCmd, true, true }, + { "/timed", DoTimedCmd, false, false }, + { "/unload", Unload, true, false }, + { "/useitem", UseItemCmd, true, true }, + { "/usercamera", UserCameraCmd, true, false }, + { "/varcalc", VarCalcCmd, true, false }, + { "/vardata", VarDataCmd, true, false }, + { "/varset", VarSetCmd, true, false }, + { "/where", Where, true, true }, + { "/while", MacroWhileCmd, true, false }, + { "/who", SuperWho, true, true }, + { "/whofilter", SWhoFilter, true, true }, + { "/whotarget", SuperWhoTarget, true, true }, + { "/windowstate", WindowState, true, false }, +""".splitlines() + +# Extract command names using regex +command_names = [] +pattern = re.compile(r'\{\s+"(/[^"]+)"') +for line in cpp_commands: + match = pattern.search(line) + if match: + command = match.group(1).lstrip('/') # Remove leading slash + command_names.append(command) + +# Compare files vs commands +existing_docs = [] +missing_docs = [] +extra_docs = [] + +# Check which commands have documentation +for cmd in command_names: + if f"{cmd}.md" in command_files: + existing_docs.append(cmd) + else: + missing_docs.append(cmd) + +# Check for extra documentation files +for f in command_files: + base = f[:-3] # Remove .md extension + if base not in command_names: + extra_docs.append(f) + +# Print results +print("Commands with documentation:") +print("\n".join(existing_docs)) + +print("\nCommands missing documentation:") +print("\n".join(missing_docs)) + +print("\nExtra documentation files (not in command list):") +print("\n".join(extra_docs)) \ No newline at end of file diff --git a/reference/commands/continue.md b/reference/commands/continue.md index 19c36a53c..55d82630f 100644 --- a/reference/commands/continue.md +++ b/reference/commands/continue.md @@ -5,15 +5,16 @@ tags: # /continue ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /continue ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> When in a /for or /while loop try the next iteration. - +<!--cmd-desc-end--> ## Example ```text diff --git a/reference/commands/convertitem.md b/reference/commands/convertitem.md index ad5a1b719..0f6db578f 100644 --- a/reference/commands/convertitem.md +++ b/reference/commands/convertitem.md @@ -5,13 +5,15 @@ tags: # /convertitem ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /convertitem <"item name"> ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Triggers convert on the item. - +<!--cmd-desc-end--> ## Examples `/convertitem "Wishing Lamp"` \ No newline at end of file diff --git a/reference/commands/crash.md b/reference/commands/crash.md index 5348d7edf..87b3e47a3 100644 --- a/reference/commands/crash.md +++ b/reference/commands/crash.md @@ -5,14 +5,16 @@ tags: # /crash ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /crash [force] ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Create a synthetic crash for debugging purposes. - +<!--cmd-desc-end--> ## Examples - `/crash` - Creates a synthetic crash dump - `/crash force` - Forces an immediate access violation crash diff --git a/reference/commands/ctrlkey.md b/reference/commands/ctrlkey.md index 57b54ec6e..d332a35bd 100644 --- a/reference/commands/ctrlkey.md +++ b/reference/commands/ctrlkey.md @@ -5,17 +5,18 @@ tags: # /ctrlkey ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /ctrlkey <command> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Execute _command_ while telling the window manager that the ctrl key is pressed. Can also be used together with [/altkey](altkey.md) , [/shiftkey](shiftkey.md) , or both in this format: /ctrlkey /altkey /shiftkey _/command_ - +<!--cmd-desc-end--> ## Examples `/ctrlkey /itemnotify pack1 leftmouseup` diff --git a/reference/commands/declare.md b/reference/commands/declare.md index cd373895a..0929b7858 100644 --- a/reference/commands/declare.md +++ b/reference/commands/declare.md @@ -5,13 +5,14 @@ tags: # /declare ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /declare <varname> | <varname[array extents]> [ <type> ] [ local | global | outer ] [ <defaultvalue> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This creates a variable or array of a particular type with a particular scope, and a default value if desired. The parameters must be given in order, but any after _varname_ may be skipped to use the defaults. **Notes** @@ -21,3 +22,4 @@ This creates a variable or array of a particular type with a particular scope, a * The default value is nothing (empty string, or 0) These variables can be of any type that exist in MQ2DataVars. The variable will then have access to the members of that type. +<!--cmd-desc-end--> diff --git a/reference/commands/delay.md b/reference/commands/delay.md index 2e85cc0d1..06410a42f 100644 --- a/reference/commands/delay.md +++ b/reference/commands/delay.md @@ -5,17 +5,18 @@ tags: # /delay ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /delay <#deciseconds>[s|m] [ <condition> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Fully pauses the macro for the amount of time specified, or until _condition_ is met. Time can be specified in 10ths of a second (a number by itself) or in seconds (number followed by an "s") or minutes (number followed by "m"). - +<!--cmd-desc-end--> ## Examples * Simple examples: diff --git a/reference/commands/deletevar.md b/reference/commands/deletevar.md index 6a91e08c0..264d34754 100644 --- a/reference/commands/deletevar.md +++ b/reference/commands/deletevar.md @@ -5,11 +5,13 @@ tags: # /deletevar ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /deletevar <varname> [* global] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Deletes the variable _varname_. Using `* global` will delete all global variables. +<!--cmd-desc-end--> diff --git a/reference/commands/destroy.md b/reference/commands/destroy.md index 99b13f52d..d7097cfea 100644 --- a/reference/commands/destroy.md +++ b/reference/commands/destroy.md @@ -5,15 +5,16 @@ tags: # /destroy ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /destroy ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Destroys whatever you have on your cursor with no confirmation, **even if you have "Destroy Confirmation" enabled in your EQ options**. **Use with care.** - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/doability.md b/reference/commands/doability.md index 310ace542..4316fe09a 100644 --- a/reference/commands/doability.md +++ b/reference/commands/doability.md @@ -5,14 +5,16 @@ tags: # /doability ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /doability [list | <ability>] ``` +<!--cmd-syntax-end--> ## Description -Extends EverQuest's doability command (/doability 1-10) to list available abilities and perform them by name or ID. - +<!--cmd-desc-start--> +Extends EverQuest's doability command (/doability 1-10) to list available abilities and perform them by name or ID. +<!--cmd-desc-end--> ## Options * **list** - List all available abilities. diff --git a/reference/commands/docommand.md b/reference/commands/docommand.md index 326174341..fa47c1722 100644 --- a/reference/commands/docommand.md +++ b/reference/commands/docommand.md @@ -5,15 +5,16 @@ tags: # /docommand ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /docommand <command> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes _command_, parsing [MQ2Data](../../macros/mqdata.md) first. This is useful for executing commands using MQ2Data that do not parse immediately, as well as executing a command stored in a variable. - +<!--cmd-desc-end--> ## Examples * A simple example that echoes "sitting" if sitting, and "not sitting" if not diff --git a/reference/commands/doevents.md b/reference/commands/doevents.md index eb3d29951..ae853426e 100644 --- a/reference/commands/doevents.md +++ b/reference/commands/doevents.md @@ -5,15 +5,16 @@ tags: # /doevents ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /doevents [ flush ] [ <specificevent> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Runs the first event of any type in the queue, flushes all queued events, or runs/flushes just the _specificevent_ event. - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/doors.md b/reference/commands/doors.md index c22a8fb6c..db4c39b85 100644 --- a/reference/commands/doors.md +++ b/reference/commands/doors.md @@ -5,12 +5,13 @@ tags: # /doors ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /doors [ <filter> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Lists all doors in the zone, or those that match _filter_. - +<!--cmd-desc-end--> diff --git a/reference/commands/doortarget.md b/reference/commands/doortarget.md index f353f77d3..6020eab1b 100644 --- a/reference/commands/doortarget.md +++ b/reference/commands/doortarget.md @@ -5,15 +5,16 @@ tags: # /doortarget ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /doortarget [ clear | id <#> | <name> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> "Targets" a door or Switch for further manipulation (eg. /face door). The targeting of doors, switches will not show up in the target window, however MQ will show indication of your /doortarget. Can target by ID or name. - +<!--cmd-desc-end--> ## Examples | | | diff --git a/reference/commands/dosocial.md b/reference/commands/dosocial.md index 3dfed3f22..12f4b0737 100644 --- a/reference/commands/dosocial.md +++ b/reference/commands/dosocial.md @@ -5,16 +5,17 @@ tags: # /dosocial ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /dosocial [ list | <social name> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This command allows you to list all your current socials, by name and number, or activate them by name. It is useful in that you could activate a social by name as long as it is in your social window without having to change hotbar pages, or call a social by name from a macro. - +<!--cmd-desc-end--> ## Examples ### list parameter diff --git a/reference/commands/drop.md b/reference/commands/drop.md index 2205a5ef0..f80ef0f29 100644 --- a/reference/commands/drop.md +++ b/reference/commands/drop.md @@ -5,12 +5,13 @@ tags: # /drop ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /drop ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Drops the item currently on the cursor. - +<!--cmd-desc-end--> diff --git a/reference/commands/dumpbinds.md b/reference/commands/dumpbinds.md index 3d80125f8..7bc247533 100644 --- a/reference/commands/dumpbinds.md +++ b/reference/commands/dumpbinds.md @@ -5,15 +5,16 @@ tags: # /dumpbinds ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /dumpbinds [ <filename> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Dumps all current keybinds to a file in the Configs directory. - +<!--cmd-desc-end--> ## Examples `/dumpbinds` → Creates `Configs/binds.cfg` diff --git a/reference/commands/dumpstack.md b/reference/commands/dumpstack.md index 09462ce66..148f2b781 100644 --- a/reference/commands/dumpstack.md +++ b/reference/commands/dumpstack.md @@ -5,10 +5,13 @@ tags: # /dumpstack ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /dumpstack ``` +<!--cmd-syntax-end--> ## Description -For debugging macroscript, outputs the current macro call stack \ No newline at end of file +<!--cmd-desc-start--> +For debugging macroscript, outputs the current macro call stack +<!--cmd-desc-end--> diff --git a/reference/commands/echo.md b/reference/commands/echo.md index d42fa3b7a..482b03b8c 100644 --- a/reference/commands/echo.md +++ b/reference/commands/echo.md @@ -5,15 +5,16 @@ tags: # /echo ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /echo <text> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Echoes the specified text (or variables) to the MQ Console window. - +<!--cmd-desc-end--> ## Examples **Colorized usage** diff --git a/reference/commands/endmacro.md b/reference/commands/endmacro.md index ba9067f81..a7e48ad2e 100644 --- a/reference/commands/endmacro.md +++ b/reference/commands/endmacro.md @@ -5,14 +5,13 @@ tags: # /endmacro ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /endmacro ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Stops the current macro. - - - +<!--cmd-desc-end--> diff --git a/reference/commands/engine.md b/reference/commands/engine.md index da3c763ee..8c7aef2bb 100644 --- a/reference/commands/engine.md +++ b/reference/commands/engine.md @@ -5,10 +5,13 @@ tags: # /engine ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /engine <type version> [noauto] ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Allows for switching engines. Full documentation at [https://gitlab.com/Knightly1/mq2-parser-changes](https://gitlab.com/Knightly1/mq2-parser-changes) +<!--cmd-desc-end--> diff --git a/reference/commands/eqtarget.md b/reference/commands/eqtarget.md index 5bc0c27b3..9a1b3354e 100644 --- a/reference/commands/eqtarget.md +++ b/reference/commands/eqtarget.md @@ -5,15 +5,16 @@ tags: # /eqtarget ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /eqtarget <name> | group <1-6> ``` +<!--cmd-syntax-end--> ## Description - -Functions identically to how `/target` worked prior to loading MacroQuest, targets `<name>` or group member `<#>`. - +<!--cmd-desc-start--> +Functions identically to how `/target` worked prior to loading MacroQuest, targets `<name>` or group member `<#>`. +<!--cmd-desc-end--> ## Options * _name_ - Name to target diff --git a/reference/commands/exec.md b/reference/commands/exec.md index 9db3ef80c..e4f871654 100644 --- a/reference/commands/exec.md +++ b/reference/commands/exec.md @@ -5,17 +5,18 @@ tags: # /exec ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /exec <command> [ <parameters> | bg] [bg] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes the specified command as if from the command line. If parameters are passed in, it will execute those parameters. If "bg" is passed as either the second or third parameter, it will execute the program in the background, otherwise it executes in the foreground. The Application Paths section in the MacroQuest.ini file allows you to specify aliases for applications, but it's not necessary for usage. - +<!--cmd-desc-end--> ## Ini Example MacroQuest.ini diff --git a/reference/commands/executelink.md b/reference/commands/executelink.md index 6e6720a06..91e6152ce 100644 --- a/reference/commands/executelink.md +++ b/reference/commands/executelink.md @@ -5,10 +5,13 @@ tags: # /executelink ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /executelink <link text> ``` +<!--cmd-syntax-end--> ## Description -Simulates clicking on formatted link text. \ No newline at end of file +<!--cmd-desc-start--> +Simulates clicking on formatted link text. +<!--cmd-desc-end--> diff --git a/reference/commands/face.md b/reference/commands/face.md index e1762a6d5..53446c7d0 100644 --- a/reference/commands/face.md +++ b/reference/commands/face.md @@ -5,15 +5,16 @@ tags: # /face ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /face [predict] [fast] [nolook] [away] [ loc <y,x[,z]> | heading <angle> | item | door|switch | id <#> | <Spawn Search> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Turns your character in the specified direction. - +<!--cmd-desc-end--> ## Options | Option | Description | diff --git a/reference/commands/filter.md b/reference/commands/filter.md index 7c43eaa64..30c6e5c8c 100644 --- a/reference/commands/filter.md +++ b/reference/commands/filter.md @@ -5,13 +5,14 @@ tags: # /filter ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /filter [macros {all|enhanced|none}] [skills {all|increase|none}] [target|money|food|encumber|debug {on|off}] [name {add|remove} <text> ] [zrange <#> ] [mq {on|off}] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Extends the EverQuest command to allow filtering many types of messages, such as the annoying "You are out of food and drink" alert. | **Command** | Description | @@ -30,7 +31,7 @@ Extends the EverQuest command to allow filtering many types of messages, such as Filters added through `/filter` are excluded from EverQuest's logging (`/log`) system. **Important:** Overly broad filters may capture unintended messages. For example, filtering out `A rat` will also hide messages containing that exact phrase, such as /con messages. - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/flashontells.md b/reference/commands/flashontells.md index c36734516..464f1e03f 100644 --- a/reference/commands/flashontells.md +++ b/reference/commands/flashontells.md @@ -5,17 +5,18 @@ tags: # /flashontells ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /flashontells [on|off] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> * You can use it to turn flashing of the eq window on or off when you recieve a tell. * On/Off enables or disables * using just "/flashontells" will toggle the setting * Or just set it in MacroQuest.ini to FlashOnTells=1 in the [MacroQuest] section. NOTE: You have to have tell windows enabled in options for this to work. - +<!--cmd-desc-end--> diff --git a/reference/commands/for.md b/reference/commands/for.md index 5f92aec24..3efc26c13 100644 --- a/reference/commands/for.md +++ b/reference/commands/for.md @@ -5,19 +5,19 @@ tags: # /for ### Syntax - +<!--cmd-syntax-start--> ```eqcommand /for <varname> <initial-value> to|downto <final-value> [step <interval>] /next <varname> ``` - - +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This runs all commands between the /for line and the /next line, after which it increments/decrements the _varname_ number (#1) by _step_ number (#3) \(default is 1) before running through the commands again. It will keep doing this until the _varname_ number equals #2. You can end a /for loop immediately with /break or try the next iteration with /continue. +<!--cmd-desc-end--> -### Examples +## Examples **Simplest** @@ -85,3 +85,4 @@ This runs all commands between the /for line and the /next line, after which it | 4 | 5 ``` + diff --git a/reference/commands/foreground.md b/reference/commands/foreground.md index c47cf9ab4..6db8fedfb 100644 --- a/reference/commands/foreground.md +++ b/reference/commands/foreground.md @@ -5,11 +5,13 @@ tags: # /foreground ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /foreground ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Brings the EverQuest game window that entered the command to the front of your desktop. Useful when switching between multiple EQ windows or other applications. +<!--cmd-desc-end--> diff --git a/reference/commands/framelimiter.md b/reference/commands/framelimiter.md index 5a280dafb..dff8028e4 100644 --- a/reference/commands/framelimiter.md +++ b/reference/commands/framelimiter.md @@ -5,27 +5,38 @@ tags: # /framelimiter ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /framelimiter [COMMAND] {OPTIONS} ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Frame limiter tool: allows adjusting internal frame limiter settings. - -## Examples - -| | | -| :--- | :--- | -| **/framelimiter enable** | turn the framelimiter on (background) | -| **/framelimiter on** | turn the framelimiter on (background) | -| **/framelimiter disable** | turn the rendering client off | -| **/framelimiter off** | turn the rendering client off | -| **/framelimiter toggle** | set/toggle the framelimiter functionality | -| **/framelimiter enablefg** | turn the framelimiter on (foreground) | -| **/framelimiter onfg** | turn the framelimiter on (foreground) | -| **/framelimiter disablefg** | turn the framelimiter off (foreground) | -| **/framelimiter offfg** | turn the framelimiter off (foreground) | -| **/framelimiter togglefg** | set/toggle the framelimiter (foreground) | -| **/framelimiter savebychar** | set/toggle saving settings by character | +<!--cmd-desc-end--> +## Options +<!--cmd-options-start--> +```text +enable -- turn the framelimiter on (background) +on -- turn the framelimiter on (background) +disable -- turn the rendering client off +off -- turn the rendering client off +toggle -- set/toggle the framelimiter functionality +enablefg -- turn the framelimiter on (foreground) +onfg -- turn the framelimiter on (foreground) +disablefg -- turn the framelimiter off (foreground) +offfg -- turn the framelimiter off (foreground) +togglefg -- set/toggle the framelimiter (foreground) +savebychar -- set/toggle saving settings by character +bgrender -- set/toggle rendering when client is in background +imguirender -- set/toggle rendering ImGui when rendering is otherwise disabled +uirender -- set/toggle rendering the UI when rendering is otherwise disabled +clearscreen -- set/toggle clearing (blanking) the screen when rendering is disabled +bgfps -- set the FPS rate for the background process +fgfps -- set the FPS rate for the foreground process +simfps -- sets the minimum FPS the simulation will run +reloadsettings -- reload settings from ini +-h, -?, help -- displays this help text +``` +<!--cmd-options-end--> diff --git a/reference/commands/getwintitle.md b/reference/commands/getwintitle.md index bbae440e4..02d1ca0ca 100644 --- a/reference/commands/getwintitle.md +++ b/reference/commands/getwintitle.md @@ -5,11 +5,13 @@ tags: # /getwintitle ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /getwintitle ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Retrieves and displays the current window title of the EverQuest client window. This is useful for debugging title changes made with [/setwintitle](setwintitle.md). +<!--cmd-desc-end--> diff --git a/reference/commands/goto.md b/reference/commands/goto.md index 308bd68b1..858892e50 100644 --- a/reference/commands/goto.md +++ b/reference/commands/goto.md @@ -5,15 +5,16 @@ tags: # /goto ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /goto :<labelname> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This moves the macro execution to the location of _:labelname_ in the macro. - +<!--cmd-desc-end--> ## Example ```text diff --git a/reference/commands/help.md b/reference/commands/help.md index c60e8aac8..420e0fbf0 100644 --- a/reference/commands/help.md +++ b/reference/commands/help.md @@ -5,11 +5,13 @@ tags: # /help ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /help macro ``` +<!--cmd-syntax-end--> ## Description - -Extends the EverQuest command to add the "macro" parameter, which lists all MacroQuest commands available to the client. \ No newline at end of file +<!--cmd-desc-start--> +Extends the EverQuest command to add the "macro" parameter, which lists all MacroQuest commands available to the client. +<!--cmd-desc-end--> diff --git a/reference/commands/hotbutton.md b/reference/commands/hotbutton.md index 606e5045f..ff30576e2 100644 --- a/reference/commands/hotbutton.md +++ b/reference/commands/hotbutton.md @@ -5,15 +5,16 @@ tags: # /hotbutton ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /hotbutton <name> [<color>] [<line>:][<cursor>:]<text>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Extends the built in /hotbutton command with multiple lines support, cursor attachment, and "names with spaces" (in quotes) support. - +<!--cmd-desc-end--> ## Examples | | | diff --git a/reference/commands/hud.md b/reference/commands/hud.md index b246146d8..3097c184c 100644 --- a/reference/commands/hud.md +++ b/reference/commands/hud.md @@ -5,15 +5,16 @@ tags: # /hud ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /hud [ normal | underui | always ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Defines how the HUD is displayed. - +<!--cmd-desc-end--> ## Options - **Normal** diff --git a/reference/commands/identify.md b/reference/commands/identify.md index 6f89f7b9c..46302bed9 100644 --- a/reference/commands/identify.md +++ b/reference/commands/identify.md @@ -5,12 +5,13 @@ tags: # /identify ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /identify ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Displays further information about the item on the cursor, similar to the spell _Identify_ and item lore displayed by MQ in the item stats UI window. - +<!--cmd-desc-end--> diff --git a/reference/commands/if.md b/reference/commands/if.md index 3111f3f27..1127664c4 100644 --- a/reference/commands/if.md +++ b/reference/commands/if.md @@ -5,7 +5,7 @@ tags: # /if ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /if ( <formula> ) { <commands> @@ -13,11 +13,12 @@ tags: <...> } ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This will run all _commands_ between the braces ( {} ) if _formula_ evaluates to something other than 0. - +<!--cmd-desc-end--> * _Formulas_ are numeric operations ONLY. You must use MQ2Data string comparison to turn strings comparisons into numeric operations (eg. Using .Equal or .NotEqual). diff --git a/reference/commands/ini.md b/reference/commands/ini.md index a3fe7ef8e..02b325049 100644 --- a/reference/commands/ini.md +++ b/reference/commands/ini.md @@ -5,15 +5,16 @@ tags: # /ini ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /ini "filename" "keyname" "valuename" "value" ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This is used to write data to an ini file. Currently there is no way to delete an ini file entry. - +<!--cmd-desc-end--> ## Example _Stuff.ini_ contains the following data: diff --git a/reference/commands/insertaug.md b/reference/commands/insertaug.md index f725ca69a..c39e0d738 100644 --- a/reference/commands/insertaug.md +++ b/reference/commands/insertaug.md @@ -5,15 +5,16 @@ tags: # /insertaug ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /insertaug [ <itemID> | <"Item Name"> | <slot1> <slot2> ] ``` +<!--cmd-syntax-end--> ## Description - -Inserts an augment from your cursor into a target item. Requires an augment item on cursor, and automatically finds first available valid augment slot. It will bypass confirmation dialogs for attuneable items and solvents. - +<!--cmd-desc-start--> +Inserts an augment from your cursor into a target item. Requires an augment item on cursor, and automatically finds first available valid augment slot. It will bypass confirmation dialogs for attuneable items and solvents. +<!--cmd-desc-end--> ## Examples `/insertaug 41302` - insters the aug into item ID 41302 diff --git a/reference/commands/invoke.md b/reference/commands/invoke.md index ee0a62157..42dbe6306 100644 --- a/reference/commands/invoke.md +++ b/reference/commands/invoke.md @@ -5,15 +5,18 @@ tags: # /invoke ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /invoke ${TLO.[XXX].Action} ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This will invoke the action portion of some of the new TLO additions. This has the potential to shorten macros and make them more powerful. +<!--cmd-desc-end--> +## Methods The current methods that are available for use and testing are: For the Task TLO: diff --git a/reference/commands/itemnotify.md b/reference/commands/itemnotify.md index c63bbd59e..06e3f0cdb 100644 --- a/reference/commands/itemnotify.md +++ b/reference/commands/itemnotify.md @@ -5,15 +5,16 @@ tags: # /itemnotify ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /itemnotify [ <slotname> | <#> | in <bag> <slot#> | <itemname> ] <notification> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Simulates inventory interactions. Similar to [/click](click.md) without the mouse click. - +<!--cmd-desc-end--> ## Parameters * _slotname_ - any one of the equipment [Slot Names](../../reference/general/slot-names.md). diff --git a/reference/commands/items.md b/reference/commands/items.md index 823cbfada..bda79a985 100644 --- a/reference/commands/items.md +++ b/reference/commands/items.md @@ -5,13 +5,14 @@ tags: # /items ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /items [<filter>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> * Lists all ground spawns and environmental containers in the zone that match _filter_ * All items will be listed if no filter is supplied - +<!--cmd-desc-end--> diff --git a/reference/commands/itemslots.md b/reference/commands/itemslots.md index bc85b4162..fec8d4ef7 100644 --- a/reference/commands/itemslots.md +++ b/reference/commands/itemslots.md @@ -5,13 +5,16 @@ tags: # /itemslots ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /itemslots ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Lists available item slots, including equipped, inventory, bank, shared, current container, and so on. Output is in the following format: - +```text [index]: [container location] [slot numbers] [item name] +``` +<!--cmd-desc-end--> diff --git a/reference/commands/itemtarget.md b/reference/commands/itemtarget.md index 13226d600..3b74e4ce3 100644 --- a/reference/commands/itemtarget.md +++ b/reference/commands/itemtarget.md @@ -5,11 +5,13 @@ tags: # /itemtarget ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /itemtarget "<itemname>" ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> "Targets" a ground spawn or environmental container. The item targeted will not show up in the target window. +<!--cmd-desc-end--> diff --git a/reference/commands/keepkeys.md b/reference/commands/keepkeys.md index d0dec75e7..e7ad71f35 100644 --- a/reference/commands/keepkeys.md +++ b/reference/commands/keepkeys.md @@ -5,12 +5,13 @@ tags: # /keepkeys ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /keepkeys [off|on] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Keeps keys that were pressed with [/keypress](keypress.md), in their current state when a macro ends. /keepkeys with no arguments displays the current on/off state. - +<!--cmd-desc-end--> diff --git a/reference/commands/keypress.md b/reference/commands/keypress.md index dca210910..ba31ba4e3 100644 --- a/reference/commands/keypress.md +++ b/reference/commands/keypress.md @@ -5,15 +5,18 @@ tags: # /keypress ## Syntax +<!--cmd-syntax-start--> ```eqcommand /keypress <name> [hold|chat] ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Simulates key presses for keybinds (e.g. "jump", "forward"), virtual keyboard (e.g. "shift+b"), or direct chat window input. Does not physically press keys, making it safe for background operation. Note: /keypress usage outside of a script is not recommended nor consistent. - +<!--cmd-desc-end--> ## Parameters | Parameter | Description | |-----------|-------------| diff --git a/reference/commands/listmacros.md b/reference/commands/listmacros.md index 701e38e36..876d4cef8 100644 --- a/reference/commands/listmacros.md +++ b/reference/commands/listmacros.md @@ -5,13 +5,14 @@ tags: # /listmacros ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /listmacros [<filter>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> * Lists all files in the "Macros" directory that match _filter_ * Results are sorted alphabetically - +<!--cmd-desc-end--> diff --git a/reference/commands/loadcfg.md b/reference/commands/loadcfg.md index d5d0b4598..6bae758e2 100644 --- a/reference/commands/loadcfg.md +++ b/reference/commands/loadcfg.md @@ -5,15 +5,16 @@ tags: # /loadcfg ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /loadcfg <filename> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Loads the specified .cfg file. To use .cfg files, [see this guide](../../main/features/cfg-files.md). - +<!--cmd-desc-end--> ## Notes * Plugins can use LoadCfgFile(filename) diff --git a/reference/commands/loadspells.md b/reference/commands/loadspells.md index 190dfed51..575966e72 100644 --- a/reference/commands/loadspells.md +++ b/reference/commands/loadspells.md @@ -5,13 +5,16 @@ tags: # /loadspells ## Syntax +<!--cmd-syntax-start--> ```eqcommand /loadspells [list|<"name">] ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Loads or lists saved spell sets. Similar to /memspellset, but it only memorizes the spellset if it's not already memorized. This command was part of MQ years before EQ was inspired to add /memspellset. - +<!--cmd-desc-end--> ## Parameters - **/loadspells list** - Shows all saved spell sets with their index numbers diff --git a/reference/commands/location.md b/reference/commands/location.md index 0feb4efda..43ef5d51d 100644 --- a/reference/commands/location.md +++ b/reference/commands/location.md @@ -5,15 +5,16 @@ tags: # /location ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /location ``` +<!--cmd-syntax-end--> ## Description - -Extends the EverQuest Y, X, Z coordinates to add the direction you're facing from a 16-wind compass. - +<!--cmd-desc-start--> +Extends the EverQuest Y, X, Z coordinates to add the direction you're facing from a 16-wind compass. +<!--cmd-desc-end--> ## Example Output ```text diff --git a/reference/commands/loginname.md b/reference/commands/loginname.md index c6b296115..3b2715f9e 100644 --- a/reference/commands/loginname.md +++ b/reference/commands/loginname.md @@ -5,11 +5,13 @@ tags: # /loginname ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /loginname ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Displays the login name of the account you are currently logged into. +<!--cmd-desc-end--> diff --git a/reference/commands/look.md b/reference/commands/look.md index bcf5836de..14a988e88 100644 --- a/reference/commands/look.md +++ b/reference/commands/look.md @@ -5,15 +5,16 @@ tags: # /look ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /look [<angle>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Changes the angle you are looking. _Angle_ can be any value between -128 (directly down) and 128 (directly up). The default for _angle_ is 0 (straight ahead). - +<!--cmd-desc-end--> ## Examples * Changes your look angle to +50 diff --git a/reference/commands/lootall.md b/reference/commands/lootall.md index bcbe242fc..9708d3fc5 100644 --- a/reference/commands/lootall.md +++ b/reference/commands/lootall.md @@ -5,15 +5,16 @@ tags: # /lootall ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /lootall ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Automatically loots all non-"No Trade" items from corpses. If EverQuest's `/lootnodrop` command is enabled, it will loot all items. Otherwise, single No Trade items leave others lootable, while multiple No Trade items disable auto-looting entirely, requiring manual collection of all items. - +<!--cmd-desc-end--> ## Examples * **Will loot everything**: diff --git a/reference/commands/macro.md b/reference/commands/macro.md index 2f659aa3c..6fbbf0bc3 100644 --- a/reference/commands/macro.md +++ b/reference/commands/macro.md @@ -5,15 +5,16 @@ tags: # /macro ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /macro <filename> [ <param0> [ <param1> [...]]] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes a macro file. Supports passing parameters to the macro's `Sub Main` entry point. - +<!--cmd-desc-end--> ## Notes * Calling a macro from another macro will immediately terminate the calling macro (no cleanup). diff --git a/reference/commands/makemevisible.md b/reference/commands/makemevisible.md index 6f3c12820..752549248 100644 --- a/reference/commands/makemevisible.md +++ b/reference/commands/makemevisible.md @@ -5,15 +5,16 @@ tags: # /makemevisible ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /makemevisible ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This will make your toon visible - +<!--cmd-desc-end--> ## Example `/makemevisible` diff --git a/reference/commands/memspell.md b/reference/commands/memspell.md index 7bd1ce837..e6cd89b62 100644 --- a/reference/commands/memspell.md +++ b/reference/commands/memspell.md @@ -5,15 +5,16 @@ tags: # /memspell ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /memspell <gem> "<spellname>" ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Attempts to memorize "_spellname_" into gem _gem_. Any _spellname_ with more than one word must be surrounded by quotes. - +<!--cmd-desc-end--> ## Example `/memspell 1 "Shallow Breath"` diff --git a/reference/commands/mercswitch.md b/reference/commands/mercswitch.md index 1bfb89f17..d3cf9662c 100644 --- a/reference/commands/mercswitch.md +++ b/reference/commands/mercswitch.md @@ -5,13 +5,16 @@ tags: # /mercswitch ## Syntax +<!--cmd-syntax-start--> ```eqcommand /mercswitch <type> ``` +<!--cmd-syntax-end--> ## Description -Extends the default EverQuest command to add the `<type>` option. Valid types are: Healer, Damage Caster, Melee Damage, Tank. A list of your mercenaries, their types and indices can be found in the "Switch" tab of your `/mercwindows`. - +<!--cmd-desc-start--> +Extends the default EverQuest command to add the `<type>` option. Valid types are: Healer, Damage Caster, Melee Damage, Tank. A list of your mercenaries, their types and indices can be found in the "Switch" tab of your `/mercwindows`. +<!--cmd-desc-end--> ## Examples `/mercswitch healer` will switch to your first "healer" merc. `/mercswitch damage caster` will switch to your first "damage caster" merc. diff --git a/reference/commands/mouseto.md b/reference/commands/mouseto.md index 457c08d12..d99804aba 100644 --- a/reference/commands/mouseto.md +++ b/reference/commands/mouseto.md @@ -5,18 +5,18 @@ tags: # /mouseto ## Syntax +<!--cmd-syntax-start--> ```eqcommand /mouseto <X or X offset> [ <Y or Y offset> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Moves the mouse to the specified location. - When an absolute location is specified (a number from 0 through 9) the mouse is moved to the absolute position. - When a relative position is specified (using - or + in front of the X or Y) the mouse is moved by that offset. - +<!--cmd-desc-end--> ## Examples Move the mouse to X=1 Y=1 diff --git a/reference/commands/mqanon.md b/reference/commands/mqanon.md index 909ca6748..905083c76 100644 --- a/reference/commands/mqanon.md +++ b/reference/commands/mqanon.md @@ -5,14 +5,16 @@ tags: # /mqanon ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqanon [*command*] [*parameters*] [*strategy*] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Anonymization tool that filters words in-game, designed for streaming and recording. It handles both the active player and any party/raid/fellowship members. It does **not** grant full-fledged anonymization, but is a tool to help with the process of anonymizing words (names, guilds, etc) in-game. For more (especially for plugin authors), see the [Anonymize](../../main/features/anonymize.md) feature. +<!--cmd-desc-end--> **Important Notes:** - Login/character screens contain no anonymization, this command is in-game only. Any text at server select, character select, login, etc ***will not be filtered***. Please make any considerations necessary to prevent visibility of the client outside of actual in-game experiences. diff --git a/reference/commands/mqconsole.md b/reference/commands/mqconsole.md index 3da34b522..af76dde42 100644 --- a/reference/commands/mqconsole.md +++ b/reference/commands/mqconsole.md @@ -5,15 +5,16 @@ tags: # /mqconsole ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqconsole [clear | toggle | show | hide] ``` +<!--cmd-syntax-end--> ## Description - -Brings up an external MacroQuest console - +<!--cmd-desc-start--> +Brings up an external MacroQuest console +<!--cmd-desc-end--> ## Parameters - **clear** - Clears the text in the console diff --git a/reference/commands/mqcopylayout.md b/reference/commands/mqcopylayout.md index 42ed747e5..6601e3117 100644 --- a/reference/commands/mqcopylayout.md +++ b/reference/commands/mqcopylayout.md @@ -5,15 +5,16 @@ tags: # /mqcopylayout ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqcopylayout <charname> <server> [res:<W>x<H>] [nohot] [noload] [nosoc] [none] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Intelligent copying of EverQuest's UI layout. By default copies all options (hotbuttons, loadouts, socials) using the windowed resolution. - +<!--cmd-desc-end--> ## Options diff --git a/reference/commands/mqlistmodules.md b/reference/commands/mqlistmodules.md index 9a704ab25..078c640b9 100644 --- a/reference/commands/mqlistmodules.md +++ b/reference/commands/mqlistmodules.md @@ -5,10 +5,13 @@ tags: # /mqlistmodules ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqlistmodules [<name>] ``` +<!--cmd-syntax-end--> ## Description -List loaded modules in the MQ directory to help with debugging stuck and/or broken dependencies/plugins. `<name>` is a filter. +<!--cmd-desc-start--> +List loaded modules in the MQ directory to help with debugging stuck and/or broken dependencies/plugins. `<name>` is a filter. +<!--cmd-desc-end--> diff --git a/reference/commands/mqlistprocesses.md b/reference/commands/mqlistprocesses.md index 7914bffff..9615204e6 100644 --- a/reference/commands/mqlistprocesses.md +++ b/reference/commands/mqlistprocesses.md @@ -5,10 +5,13 @@ tags: # /mqlistprocesses ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqlistprocesses [<name>] ``` +<!--cmd-syntax-end--> ## Description -List relevant processes to help debug stuck and/or broken dependencies/plugins. `<name>` is a filter. +<!--cmd-desc-start--> +List relevant processes to help debug stuck and/or broken dependencies/plugins. `<name>` is a filter. +<!--cmd-desc-end--> diff --git a/reference/commands/mqlog.md b/reference/commands/mqlog.md index cc669eecf..0cacf0c05 100644 --- a/reference/commands/mqlog.md +++ b/reference/commands/mqlog.md @@ -5,20 +5,21 @@ tags: # /mqlog ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqlog clear | <text> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This will log _text_ to a log file in the "Logs" directory. Clear will delete everything in the log file. **Notes** * The log filename will be _macroname.mac.log_ if run from within a macro * The log filename will be _MacroQuest.log_ if issued normally - +<!--cmd-desc-end--> ## Example ```text diff --git a/reference/commands/mqoverlay.md b/reference/commands/mqoverlay.md index b31c6cdb9..14358ee61 100644 --- a/reference/commands/mqoverlay.md +++ b/reference/commands/mqoverlay.md @@ -5,15 +5,16 @@ tags: # /mqoverlay ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqoverlay [reload | resume | stop | start | cursor [on|off] debug [mouse|graphics|fonts|cursor]] ``` +<!--cmd-syntax-end--> ## Description - -Simple controls for the imgui overlay in MacroQuest. If imgui crashes, it can be resumed with this command. - +<!--cmd-desc-start--> +Simple controls for the imgui overlay in MacroQuest. If imgui crashes, it can be resumed with this command. +<!--cmd-desc-end--> ## Parameters - **reload** - Reloads the overlay diff --git a/reference/commands/mqpause.md b/reference/commands/mqpause.md index 4d152fbc0..555b0ace3 100644 --- a/reference/commands/mqpause.md +++ b/reference/commands/mqpause.md @@ -5,15 +5,16 @@ tags: # /mqpause ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqpause [on|off] | chat [on|off] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Pauses/resumes a macro. Not using a parameter will toggle pausing on/off. - +<!--cmd-desc-end--> ## Parameters - **on|off** - Pauses or resumes a macro diff --git a/reference/commands/mqsettings.md b/reference/commands/mqsettings.md index 272c8c01c..cce940d9a 100644 --- a/reference/commands/mqsettings.md +++ b/reference/commands/mqsettings.md @@ -5,15 +5,16 @@ tags: # /mqsettings ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqsettings [Section to Open] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Open the MacroQuest Settings window -- optionally, to a specific area. - +<!--cmd-desc-end--> ## Examples | | | diff --git a/reference/commands/mqtarget.md b/reference/commands/mqtarget.md index 551677c66..ff51ccb6b 100644 --- a/reference/commands/mqtarget.md +++ b/reference/commands/mqtarget.md @@ -5,13 +5,14 @@ tags: # /mqtarget ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /mqtarget <option> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Targets whatever is matched by one or more of the following _options_: | | | @@ -20,7 +21,7 @@ Targets whatever is matched by one or more of the following _options_: | **mycorpse** | Your own corpse (nearest) | | **myself** | Target yourself | | _Anything Else_ | Anything else is considered a [Spawn Search](../../reference/general/spawn-search.md) | - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/msgbox.md b/reference/commands/msgbox.md index 7bca6d29c..162f03c6a 100644 --- a/reference/commands/msgbox.md +++ b/reference/commands/msgbox.md @@ -5,11 +5,13 @@ tags: # /msgbox ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /msgbox <message> ``` +<!--cmd-syntax-end--> ## Description - -Creates a windows message box with _message_, user clicks "ok" to close. \ No newline at end of file +<!--cmd-desc-start--> +Creates a windows message box with _message_, user clicks "ok" to close. +<!--cmd-desc-end--> diff --git a/reference/commands/multiline.md b/reference/commands/multiline.md index 0945bc8ec..d6e0a3bc6 100644 --- a/reference/commands/multiline.md +++ b/reference/commands/multiline.md @@ -5,15 +5,16 @@ tags: # /multiline ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /multiline <delimiter> <command> [ <delimiter> <command> [...] ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes multiple commands using a single line separated by the delimiter. - +<!--cmd-desc-end--> **Notes** * This is useful for keybinds diff --git a/reference/commands/netstatusxpos.md b/reference/commands/netstatusxpos.md index 31b897fdc..b640fccef 100644 --- a/reference/commands/netstatusxpos.md +++ b/reference/commands/netstatusxpos.md @@ -5,12 +5,13 @@ tags: # /netstatusxpos ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /netstatusxpos <XXX> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> used for moving the X coordinates of the Network Status Indicator - +<!--cmd-desc-end--> diff --git a/reference/commands/netstatusypos.md b/reference/commands/netstatusypos.md index 5cba78d9e..2a38d5334 100644 --- a/reference/commands/netstatusypos.md +++ b/reference/commands/netstatusypos.md @@ -5,12 +5,13 @@ tags: # /netstatusypos ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /netstatusypos <XXX> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Used to change the Y coordinates of the Network Status Indicator - +<!--cmd-desc-end--> diff --git a/reference/commands/next.md b/reference/commands/next.md index 9bc926043..5f74c5765 100644 --- a/reference/commands/next.md +++ b/reference/commands/next.md @@ -5,14 +5,16 @@ tags: # /next ## Syntax +<!--cmd-syntax-start--> ```eqcommand /for <varname> <initial-value> to|downto <final-value> [step <interval>] /next <varname> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This runs all commands between the /for line and the /next line, after which it increments/decrements the _varname_ number (#1) by _step_ number (#3) \(default is 1) before running through the commands again. It will keep doing this until the _varname_ number equals #2. You can end a /for loop immediately with /break or try the next iteration with /continue. - +<!--cmd-desc-end--> ## See also * [/for](for.md) diff --git a/reference/commands/no.md b/reference/commands/no.md index 1246c283a..1808268cf 100644 --- a/reference/commands/no.md +++ b/reference/commands/no.md @@ -5,19 +5,19 @@ tags: # /no ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /no ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Clicks "no" on in-game dialogues and popups. Technically not a command, this is an [/alias](alias.md) that's included by default. - +<!--cmd-desc-end--> ## Examples Here's what the alias is really doing behind the scenes. From your MacroQuest.ini, ```ini /no=/multiline ; /squelch /notify LargeDialogWindow LDW_NoButton leftmouseup ; /squelch /notify ConfirmationDialogBox CD_No_Button leftmouseup ; /squelch /notify ConfirmationDialogBox CD_Cancel_Button leftmouseup ; /squelch /notify TradeWND TRDW_Cancel_Button leftmouseup ; /squelch /notify GiveWnd GVW_Cancel_Button leftmouseup ; /squelch /notify ProgressionSelectionWnd ProgressionTemplateSelectCancelButton leftmouseup ; /squelch /notify TaskSelectWnd TSEL_DeclineButton leftmouseup ; /squelch /notify RaidWindow RAID_DeclineButton leftmouseup -``` - +``` \ No newline at end of file diff --git a/reference/commands/nomodkey.md b/reference/commands/nomodkey.md index 54afd52fc..7a542a9c8 100644 --- a/reference/commands/nomodkey.md +++ b/reference/commands/nomodkey.md @@ -5,11 +5,13 @@ tags: # /nomodkey ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /nomodkey <command> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Releases all ctrl/alt/shift keys while executing _command_ +<!--cmd-desc-end--> diff --git a/reference/commands/noparse.md b/reference/commands/noparse.md index d0fbb1ab2..7b41675be 100644 --- a/reference/commands/noparse.md +++ b/reference/commands/noparse.md @@ -5,15 +5,16 @@ tags: # /noparse ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /noparse <command> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Prevents any MQ2Data from being parsed when used in _command_. - +<!--cmd-desc-end--> ## Example * Here the literal string "${stuff}" is added to the ini file, as opposed to the current value of ${stuff}. diff --git a/reference/commands/notify.md b/reference/commands/notify.md index 610496a1e..a79445fa9 100644 --- a/reference/commands/notify.md +++ b/reference/commands/notify.md @@ -5,15 +5,16 @@ tags: # /notify ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /notify <windowname> <control> [ <notification> [ <data> ] ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This command is used to interact with UI windows. It can simulate various mouse and keyboard interactions with UI elements. - +<!--cmd-desc-end--> ## Parameters - _windowname_ is the name of the window (e.g., "HotButtonWnd"). Use the Window Inspector (preferred) within the [/mqconsole](mqconsole.md) or the [/windows](windows.md) command to list all available windows. diff --git a/reference/commands/pet.md b/reference/commands/pet.md index 17632d056..6926006ab 100644 --- a/reference/commands/pet.md +++ b/reference/commands/pet.md @@ -5,15 +5,16 @@ tags: # /pet ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /pet <action> <spawnid> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> MacroQuest extends EverQuest's `/pet` command to allow attacking by spawn #. - +<!--cmd-desc-end--> ## Options - **attack** _#_ - Can specify the spawn ID number to attack diff --git a/reference/commands/pickzone.md b/reference/commands/pickzone.md index d445df2f1..2f5a78178 100644 --- a/reference/commands/pickzone.md +++ b/reference/commands/pickzone.md @@ -5,15 +5,16 @@ tags: # /pickzone ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /pickzone <#> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Extends EverQuest's `/pickzone` command to allow picking a zone by number. 0 is the main instance. - +<!--cmd-desc-end--> ## Examples - **/pickzone 0** - Main Instance diff --git a/reference/commands/plugin.md b/reference/commands/plugin.md index b8f670264..c60eaec0f 100644 --- a/reference/commands/plugin.md +++ b/reference/commands/plugin.md @@ -5,15 +5,16 @@ tags: # /plugin ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /plugin <name> [ load | unload | toggle ] [noauto] | [list] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> The plugin command can be used to list all plugins currently loaded, to load a new plugin, or to unload a plugin that is already loaded. Loading a plugin will also add an entry to the **[Plugins]** section of the [MacroQuest.ini](../../main/macroquest.ini.md) file thereby loading it next session. Using the _noauto_ switch prevents this modification to MacroQuest.ini from occurring. - +<!--cmd-desc-end--> ## Examples `/plugin list` diff --git a/reference/commands/popcustom.md b/reference/commands/popcustom.md index 80390cc1d..fd4bcac86 100644 --- a/reference/commands/popcustom.md +++ b/reference/commands/popcustom.md @@ -5,15 +5,16 @@ tags: # /popcustom ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /popcustom [<#color>] [<#seconds>] <message> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Creates an in-game overlay message. See also [/popupecho](popupecho.md). - +<!--cmd-desc-end--> ## Color Chart | **Number** | **Color** | diff --git a/reference/commands/popup.md b/reference/commands/popup.md index 8b0d2c282..1972fa981 100644 --- a/reference/commands/popup.md +++ b/reference/commands/popup.md @@ -5,17 +5,18 @@ tags: # /popup ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /popup <text> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Displays _text_ in the center of your screen. Currently the text is a fixed font and color. See Also: [/popcustom](popcustom.md) - +<!--cmd-desc-end--> ## Examples * Displays Current Mana: 65% diff --git a/reference/commands/popupecho.md b/reference/commands/popupecho.md index 4129aa382..da2109fa2 100644 --- a/reference/commands/popupecho.md +++ b/reference/commands/popupecho.md @@ -5,15 +5,16 @@ tags: # /popupecho ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /popupecho [<#color>] [<#seconds>] <message> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Same as [/popcustom](popcustom.md) but also echos the message to chat. - +<!--cmd-desc-end--> ## Color Chart | **Number** | **Color** | diff --git a/reference/commands/profile.md b/reference/commands/profile.md index 3a2d9c036..e7a1d0e76 100644 --- a/reference/commands/profile.md +++ b/reference/commands/profile.md @@ -5,15 +5,16 @@ tags: # /profile ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /profile <profile> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> This runs a macro just like [/mac](macro.md) does, but when the macro ends it will output a csv file of every subroutine that has been called, and how long it took. The file will be in Macros/profiles, named for the macro and the time it started. - +<!--cmd-desc-end--> ## Settings The output file contains one line per subroutine call, in the order they were called in. The columns are: diff --git a/reference/commands/quit.md b/reference/commands/quit.md index 883f1f30a..d082bb543 100644 --- a/reference/commands/quit.md +++ b/reference/commands/quit.md @@ -5,11 +5,13 @@ tags: # /quit ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /quit ``` +<!--cmd-syntax-end--> ## Description - -Extends EverQuest's `/quit` command to allow quitting from the character select screen. \ No newline at end of file +<!--cmd-desc-start--> +Extends EverQuest's `/quit` command to allow quitting from the character select screen. +<!--cmd-desc-end--> diff --git a/reference/commands/ranged.md b/reference/commands/ranged.md index 90ae5e333..69e9657ab 100644 --- a/reference/commands/ranged.md +++ b/reference/commands/ranged.md @@ -5,16 +5,18 @@ tags: # /ranged ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /ranged [ <spawnID> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Performs a ranged attack. +<!--cmd-desc-end--> -**Notes** +## Notes * No parameter executes a ranged attack on your current target * If _spawnID_ is supplied this will attempt to execute a ranged attack on that spawn if it exists. diff --git a/reference/commands/reloadui.md b/reference/commands/reloadui.md index 160b4188a..8b48597a6 100644 --- a/reference/commands/reloadui.md +++ b/reference/commands/reloadui.md @@ -5,12 +5,13 @@ tags: # /reloadui ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /reloadui ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> It works just like **/loadskin 1** but with less typing - +<!--cmd-desc-end--> diff --git a/reference/commands/removeaug.md b/reference/commands/removeaug.md index bfc3ebeed..459296b96 100644 --- a/reference/commands/removeaug.md +++ b/reference/commands/removeaug.md @@ -6,20 +6,20 @@ tags: # /removeaug ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /removeaug <augment> <item> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Removes the specified augment from the specified item. Uses appropriate augment solvent from your inventory. - +<!--cmd-desc-end--> !!! note _augment_ and _item_ can be either the numeric item id OR a quoted item name - ## See Also - [/insertaug](insertaug.md) \ No newline at end of file diff --git a/reference/commands/removeaura.md b/reference/commands/removeaura.md index d85707aa1..aea81b307 100644 --- a/reference/commands/removeaura.md +++ b/reference/commands/removeaura.md @@ -5,15 +5,16 @@ tags: # /removeaura ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /removeaura <Name Of Aura> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Will remove an aura by name or partial name - +<!--cmd-desc-end--> ## Example `/removeaura Frostweave Aura` diff --git a/reference/commands/removebuff.md b/reference/commands/removebuff.md index 6b3a9e854..3a4cab4b5 100644 --- a/reference/commands/removebuff.md +++ b/reference/commands/removebuff.md @@ -5,15 +5,16 @@ tags: # /removebuff ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /removebuff [-pet|-both] <Name Of Buff> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Will remove a buff or song by the name of the buff. It can be used to remove buffs from the player, the pet, or both. By default it does a partial match, but you can force an exact compare with the equals sign. - +<!--cmd-desc-end--> ## Example ```text diff --git a/reference/commands/removelev.md b/reference/commands/removelev.md index e11ed343e..051851fa3 100644 --- a/reference/commands/removelev.md +++ b/reference/commands/removelev.md @@ -5,15 +5,16 @@ tags: # /removelev ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /removelev ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Will attempt to remove any levitation buffs on you that are found in the buff or shortbuff window. - +<!--cmd-desc-end--> ## Example ```text diff --git a/reference/commands/removepetbuff.md b/reference/commands/removepetbuff.md index c5d388d2c..05bdc7c0b 100644 --- a/reference/commands/removepetbuff.md +++ b/reference/commands/removepetbuff.md @@ -5,15 +5,16 @@ tags: # /removepetbuff ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /removepetbuff <Buff Name> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Removes a pet buff using either the buff name, or a partial name. If an exact match is required, the equals sign can be used to force the exact match. - +<!--cmd-desc-end--> ## Example ```text diff --git a/reference/commands/return.md b/reference/commands/return.md index b5b6eec2c..a3b30ce77 100644 --- a/reference/commands/return.md +++ b/reference/commands/return.md @@ -5,15 +5,16 @@ tags: # /return ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /return [value|${varname}] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Returns to the line immediately following the call. Can return values or variables. - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/screenmode.md b/reference/commands/screenmode.md index a9ac63ccf..5364d2a37 100644 --- a/reference/commands/screenmode.md +++ b/reference/commands/screenmode.md @@ -5,15 +5,16 @@ tags: # /screenmode ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /screenmode <#> ``` +<!--cmd-syntax-end--> ## Description - -Where 2 is normal and 3 is no windows. 1 is Unknown. Experimental. - +<!--cmd-desc-start--> +Where 2 is normal and 3 is no windows. 1 is Unknown. Experimental. +<!--cmd-desc-end--> ## Examples /screenmode 2 diff --git a/reference/commands/selectitem.md b/reference/commands/selectitem.md index 227cbec0c..199683af5 100644 --- a/reference/commands/selectitem.md +++ b/reference/commands/selectitem.md @@ -5,15 +5,16 @@ tags: # /selectitem ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /selecitem "itemname" ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Selects items in your inventory when you have a merchant open. /selectitem "bottle of" will select a "bottle of vinegar" you can also do "=bottle of vinegar" to match EXACT name (its not case sensitive though) - +<!--cmd-desc-end--> ## Examples `/selectitem "bottle of"` diff --git a/reference/commands/sellitem.md b/reference/commands/sellitem.md index 8b7f8677b..111a60cc3 100644 --- a/reference/commands/sellitem.md +++ b/reference/commands/sellitem.md @@ -5,12 +5,13 @@ tags: # /sellitem ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /sellitem [<#quantity>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Sells the selected item. If \# is specified it will sell that \# of a stacked item. - +<!--cmd-desc-end--> diff --git a/reference/commands/setautorun.md b/reference/commands/setautorun.md index 0d191087e..78c5d4577 100644 --- a/reference/commands/setautorun.md +++ b/reference/commands/setautorun.md @@ -5,11 +5,13 @@ tags: # /setautorun ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /setautorun ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Creates an ini entry in Macroquest.ini that performs a command automatically after entering world. This may be deprecated in favor of .cfg files. +<!--cmd-desc-end--> diff --git a/reference/commands/seterror.md b/reference/commands/seterror.md index 9ef0e9380..c2a45128c 100644 --- a/reference/commands/seterror.md +++ b/reference/commands/seterror.md @@ -5,12 +5,14 @@ tags: # /seterror ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /seterror [ <error> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> * Sets ${MacroQuest.Error} to _error_ * Omitting _error_ will clear ${MacroQuest.Error} +<!--cmd-desc-end--> diff --git a/reference/commands/setprio.md b/reference/commands/setprio.md index f37703bb5..71dcd25ef 100644 --- a/reference/commands/setprio.md +++ b/reference/commands/setprio.md @@ -5,15 +5,16 @@ tags: # /setprio ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /setprio <#priority> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Sets process priority (like in Windows Task Manager), where 1 is low 2 is below normal 3 is normal 4 is above normal 5 is high and 6 is real time. The default value is 3. - +<!--cmd-desc-end--> ## Examples You need to build something quick in Visual Studio, just do a /bcga //setprio 2 and it will zoom by real fast. diff --git a/reference/commands/setwintitle.md b/reference/commands/setwintitle.md index a0b1ee7fd..adf9671a0 100644 --- a/reference/commands/setwintitle.md +++ b/reference/commands/setwintitle.md @@ -5,16 +5,16 @@ tags: # /setwintitle ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /setwintitle <Window Name> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Sets the window title (the name shown at the top of the window and in the task bar tray) to whatever text you specify. - - +<!--cmd-desc-end--> ## Examples Set the window title to "My Very Cool Window" diff --git a/reference/commands/shiftkey.md b/reference/commands/shiftkey.md index c49650a9d..363b8e5ad 100644 --- a/reference/commands/shiftkey.md +++ b/reference/commands/shiftkey.md @@ -5,19 +5,20 @@ tags: # /shiftkey ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /shiftkey <command> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Execute _command_ while telling the window manager that the shift key is pressed. Can also be used together with [/altkey](altkey.md) , [/ctrlkey](ctrlkey.md) , or both in this format: ```text /ctrlkey /altkey /shiftkey /command ``` - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/skills.md b/reference/commands/skills.md index 13e272202..c41e1ddbe 100644 --- a/reference/commands/skills.md +++ b/reference/commands/skills.md @@ -5,15 +5,16 @@ tags: # /skills ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /skills [ <skillname> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Lists the skill level(s) that match _skillname_ if provided, or all possible skills if no parameter given. - +<!--cmd-desc-end--> ## Examples * Lists all of your skills with skill level diff --git a/reference/commands/spellslotinfo.md b/reference/commands/spellslotinfo.md index 2cb769ff8..5520670b5 100644 --- a/reference/commands/spellslotinfo.md +++ b/reference/commands/spellslotinfo.md @@ -5,14 +5,15 @@ tags: # /spellslotinfo ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /spellslotinfo [#|"<spell name>"] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> You can use this to see the spell slot Information for any spell without having to right-click display through the ItemDisplay plugin. - +<!--cmd-desc-end--> diff --git a/reference/commands/spew.md b/reference/commands/spew.md index a8f3b3544..7b275c235 100644 --- a/reference/commands/spew.md +++ b/reference/commands/spew.md @@ -5,12 +5,13 @@ tags: # /spew ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /spew [on|off] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Enables or disables the output of Debug Spew to the "\Logs\DebugSpew.log" file. - +<!--cmd-desc-end--> diff --git a/reference/commands/squelch.md b/reference/commands/squelch.md index 0da1922fe..f6302431e 100644 --- a/reference/commands/squelch.md +++ b/reference/commands/squelch.md @@ -5,13 +5,14 @@ tags: # /squelch ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /squelch <command> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes _command_ while preventing any output from that _command_. Basically, it does the following: @@ -19,7 +20,7 @@ Basically, it does the following: 1. Turns mq filter off 2. Executes _command_ 3. Turns mq filter back to the state it was in before step 1 - +<!--cmd-desc-end--> ## Example ```text diff --git a/reference/commands/syntaxconvert.py b/reference/commands/syntaxconvert.py new file mode 100644 index 000000000..76da32430 --- /dev/null +++ b/reference/commands/syntaxconvert.py @@ -0,0 +1,68 @@ +# this script converts command syntax from markdown to the eqcommand lexer format. + +import os +import re +from pathlib import Path +import argparse + +def convert_syntax_line(line): + # First remove all residual bold markers + line = line.replace('**', '') + # Then handle quoted names and parameters + line = re.sub(r'_"([^"]+)"_', r'<"\1">', line) + # Modified regex to capture phrases with spaces + line = re.sub(r'_([^_]+)_', r'<\1>', line) + return line + +def process_markdown_file(file_path): + with open(file_path, 'r', encoding='utf-8') as f: + content = f.read() + + # Updated regex to capture entire syntax block + converted = re.sub( + r'(## Syntax\n+)(.*?)(?=\n##|\n\n|\Z)', + lambda m: f'{m.group(1)}```eqcommand\n{convert_syntax_line(m.group(2))}\n```', + content, + flags=re.DOTALL + ) + + if converted != content: + with open(file_path, 'w', encoding='utf-8') as f: + f.write(converted) + return True + return False + +def main(): + parser = argparse.ArgumentParser(description='Convert command syntax formatting') + parser.add_argument('--file', help='Process a single file') # <-- Argument definition + args = parser.parse_args() # <-- Argument parsing + + commands_dir = Path(__file__).parent + + if args.file: # <-- Argument check + target_file = commands_dir / args.file + if not target_file.exists(): + print(f"Error: File {args.file} not found") + return + if process_markdown_file(target_file): + print(f"Successfully processed {args.file}") + else: + print(f"No changes needed for {args.file}") + else: + processed_files = 0 + + for md_file in commands_dir.glob('*.md'): + if md_file.name == 'README.md': + continue + + try: + if process_markdown_file(md_file): + print(f'Processed: {md_file.name}') + processed_files += 1 + except Exception as e: + print(f'Error processing {md_file.name}: {str(e)}') + + print(f'\nConversion complete. Modified {processed_files} files.') + +if __name__ == '__main__': + main() diff --git a/reference/commands/target.md b/reference/commands/target.md index c31b7c9fd..8098d1380 100644 --- a/reference/commands/target.md +++ b/reference/commands/target.md @@ -8,15 +8,16 @@ tags: This command name has been deprecated and may be removed in a future version. Please update your scripts to use [/mqtarget](mqtarget.md) instead. Users who rightly want the native command should use [/eqtarget](eqtarget.md) for now. ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /target <option> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Targets whatever is matched by one or more of the following _options_: - +<!--cmd-desc-end--> | | | | :--- | :--- | | **clear** | Clears your current target | diff --git a/reference/commands/taskquit.md b/reference/commands/taskquit.md index 5b71505ee..90050cb22 100644 --- a/reference/commands/taskquit.md +++ b/reference/commands/taskquit.md @@ -5,11 +5,13 @@ tags: # /taskquit ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /taskquit [<name>] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> MacroQuest extends the `/taskquit` command to quit solo tasks by specifying the exact task name. +<!--cmd-desc-end--> diff --git a/reference/commands/timed.md b/reference/commands/timed.md index c8245a1c2..6cb11a2e7 100644 --- a/reference/commands/timed.md +++ b/reference/commands/timed.md @@ -5,15 +5,16 @@ tags: # /timed ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /timed <#deciseconds> <command> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes _command_ after a specified duration, given in deciseconds. - +<!--cmd-desc-end--> **Notes** * This does not pause successive commands. diff --git a/reference/commands/timestamp.md b/reference/commands/timestamp.md index c8fee2de7..cb51707f1 100644 --- a/reference/commands/timestamp.md +++ b/reference/commands/timestamp.md @@ -5,12 +5,15 @@ tags: # /timestamp ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /timestamp [on|off] ``` +<!--cmd-syntax-end--> ## Description +<!--cmd-desc-start--> Toggles timestamps on all chat messages. It can be set in MacroQuest.ini via `TimeStampChat=1` (1=ON, 0=OFF) in the [MacroQuest] section. `NOTE:` The timestamp is added *before* the message reaches game UI but *after* MQ's chat event processing. This should not have any adverse effects when turned on. +<!--cmd-desc-end--> diff --git a/reference/commands/tloc.md b/reference/commands/tloc.md index 8ddfda07a..4772c6fe9 100644 --- a/reference/commands/tloc.md +++ b/reference/commands/tloc.md @@ -5,11 +5,13 @@ tags: # /tloc ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /tloc ``` +<!--cmd-syntax-end--> ## Description - -Returns your target's location. Technically not a command, this is an [alias](alias.md) that's included by default. \ No newline at end of file +<!--cmd-desc-start--> +Returns your target's location. Technically not a command, this is an [alias](alias.md) that's included by default. +<!--cmd-desc-end--> diff --git a/reference/commands/unload.md b/reference/commands/unload.md index d62b2d90f..212c77649 100644 --- a/reference/commands/unload.md +++ b/reference/commands/unload.md @@ -5,12 +5,13 @@ tags: # /unload ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /unload ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Unloads MacroQuest. - +<!--cmd-desc-end--> diff --git a/reference/commands/useitem.md b/reference/commands/useitem.md index f429e10d8..f32ced412 100644 --- a/reference/commands/useitem.md +++ b/reference/commands/useitem.md @@ -5,11 +5,13 @@ tags: # /useitem ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /useitem <item name> ``` +<!--cmd-syntax-end--> ## Description - -Extends the default EverQuest command to support partial matching for the item name. \ No newline at end of file +<!--cmd-desc-start--> +Extends the default EverQuest command to support partial matching for the item name. +<!--cmd-desc-end--> diff --git a/reference/commands/usercamera.md b/reference/commands/usercamera.md index 75331b1b6..15e146df1 100644 --- a/reference/commands/usercamera.md +++ b/reference/commands/usercamera.md @@ -5,15 +5,16 @@ tags: # /usercamera ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /usercamera [ <0-7> |on|off|save [ <charname> ]|load [ <charname> ]] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Switch to a specified camera view or manage the User Camera 1 position settings. - +<!--cmd-desc-end--> ## Options ### Camera Numbers (0-7) diff --git a/reference/commands/varcalc.md b/reference/commands/varcalc.md index c31cc0fdc..28c896d27 100644 --- a/reference/commands/varcalc.md +++ b/reference/commands/varcalc.md @@ -5,17 +5,18 @@ tags: # /varcalc ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /varcalc varname <formula> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> * Sets a variable directly to the numeric result of a calculation (_formula_) * Keep in mind that the type of the variable may itself reject this value depending on what you give it * **This will not work on strings!** - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/vardata.md b/reference/commands/vardata.md index 29bcdfe80..362e0e5e9 100644 --- a/reference/commands/vardata.md +++ b/reference/commands/vardata.md @@ -5,20 +5,21 @@ tags: # /vardata ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /vardata varname <newMQ2Datavalue> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Sets a variable directly to the end result of a MQ2Data string. \*To use this, **do not** put ${} around the outer data to parse. * This is more efficient than using _/varset_ as it skips a step * _/varset_ first converts the MQ2Data to text, and then back to MQ2Data * _/vardata_ converts directly through MQ2Data - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/varset.md b/reference/commands/varset.md index 1eed85b6a..65258bb3b 100644 --- a/reference/commands/varset.md +++ b/reference/commands/varset.md @@ -5,18 +5,19 @@ tags: # /varset ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /varset varname [ <newvalue> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Sets a variable directly to a new value. * Keep in mind that the type of the variable may itself reject this value depending on what you give it. * To clear the value of the variable, you may omit the new value. - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/where.md b/reference/commands/where.md index 860db45b0..4b0182de4 100644 --- a/reference/commands/where.md +++ b/reference/commands/where.md @@ -5,19 +5,20 @@ tags: # /where ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /where [ pc | npc ] [ <spawnname> ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Lists where the closest PC, NPC or _spawnname_ is. The message returned is: ```text The closest 'spawnname' is a level # <race> <class> and <distance> away to the <direction>, Z difference = #.##. ``` - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/while.md b/reference/commands/while.md index c67d8091a..497b56846 100644 --- a/reference/commands/while.md +++ b/reference/commands/while.md @@ -5,17 +5,18 @@ tags: # /while ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /while (condition) { `...` } ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Executes the commands between { and } while the expression condition evaluates to true. Note that } must be on a line by its own. You can end a /while loop immediately with /break or try the next iteration with /continue. - +<!--cmd-desc-end--> ## Examples ```text diff --git a/reference/commands/who.md b/reference/commands/who.md index 9ce02f23e..943db7507 100644 --- a/reference/commands/who.md +++ b/reference/commands/who.md @@ -5,19 +5,20 @@ tags: # /who ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /who <options> ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Searches the current zone for the spawns matching the specified [Spawn Search](../../reference/general/spawn-search.md) _options_, with the addition of: * all: Scan all zones. Note: this reverts to the native /who command. * concolor: Displays the results in consider colors * sort \: Sort by this metric - +<!--cmd-desc-end--> ## Examples * **/who npc named** diff --git a/reference/commands/whofilter.md b/reference/commands/whofilter.md index 4d39df7c8..577ae4df3 100644 --- a/reference/commands/whofilter.md +++ b/reference/commands/whofilter.md @@ -5,11 +5,13 @@ tags: # /whofilter ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /whofilter lastname|class|race|body|level|gm|guild|ld|sneak|lfg|npctag|spawnid|trader|afk|anon|distance|light|holding|concolor|invisible [on|off] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Toggles the display of the specified spawn(s) when using /who +<!--cmd-desc-end--> diff --git a/reference/commands/whotarget.md b/reference/commands/whotarget.md index d1a884ab6..ab2822d63 100644 --- a/reference/commands/whotarget.md +++ b/reference/commands/whotarget.md @@ -5,11 +5,13 @@ tags: # /whotarget ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /whotarget ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> MQ enhances this EQ command by allowing you to use it on any target (including NPCs). Output is the same as the [/who](who.md) command (set by [/whofilter](whofilter.md)), displaying the target's class, race, level, guild, con color, and distance regardless of the player being in anonymous or roleplaying mode. +<!--cmd-desc-end--> diff --git a/reference/commands/windows.md b/reference/commands/windows.md index 1426683cd..b25deab44 100644 --- a/reference/commands/windows.md +++ b/reference/commands/windows.md @@ -5,15 +5,16 @@ tags: # /windows ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /windows [ <windowname> | open ] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Lists all available UI windows. These are usable with [/notify](notify.md). You can alternately use the Window Inspector within the [/mqconsole](mqconsole.md) to find windows and controls. - +<!--cmd-desc-end--> ## Examples * Display all open windows in UI diff --git a/reference/commands/windowstate.md b/reference/commands/windowstate.md index 2aca67fc4..188b1c4ba 100644 --- a/reference/commands/windowstate.md +++ b/reference/commands/windowstate.md @@ -5,16 +5,18 @@ tags: # /windowstate ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /windowstate <window> [open|close] ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Opens or closes the specified window. **Notes** * These commands affect the client at an unnecessarily low level -* The best practice is to use [/keypress](keypress.md) for opening that window instead \ No newline at end of file +* The best practice is to use [/keypress](keypress.md) for opening that window instead +<!--cmd-desc-end--> diff --git a/reference/commands/yes.md b/reference/commands/yes.md index 2abb8452e..f57fe97b7 100644 --- a/reference/commands/yes.md +++ b/reference/commands/yes.md @@ -5,15 +5,16 @@ tags: # /yes ## Syntax - +<!--cmd-syntax-start--> ```eqcommand /yes ``` +<!--cmd-syntax-end--> ## Description - +<!--cmd-desc-start--> Clicks "yes" on in-game dialogues and popups. Technically not a command, this is an [/alias](alias.md) that's included by default. - +<!--cmd-desc-end--> ## Examples Here's what the alias is really doing behind the scenes. From your MacroQuest.ini, From 81b177177610a450e1cda576e6d310a85b198f67 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 10 May 2025 18:13:59 -0500 Subject: [PATCH 15/41] include-markdown markup for data-types --- reference/data-types/datatype-achievement.md | 10 ++++++---- reference/data-types/datatype-achievementcat.md | 10 ++++++---- reference/data-types/datatype-achievementobj.md | 10 ++++++---- reference/data-types/datatype-altability.md | 10 ++++++---- reference/data-types/datatype-argb.md | 10 +++++++--- reference/data-types/datatype-array.md | 11 ++++++----- reference/data-types/datatype-augtype.md | 9 ++++++--- reference/data-types/datatype-auratype.md | 9 ++++++--- reference/data-types/datatype-bandolier.md | 13 +++++++------ reference/data-types/datatype-bank.md | 10 ++++++---- reference/data-types/datatype-body.md | 10 ++++++---- reference/data-types/datatype-bool.md | 11 +++++++---- reference/data-types/datatype-buff.md | 10 ++++++---- reference/data-types/datatype-byte.md | 2 ++ reference/data-types/datatype-cachedbuff.md | 11 ++++++----- reference/data-types/datatype-character.md | 10 ++++++---- reference/data-types/datatype-charselectlist.md | 10 ++++++---- reference/data-types/datatype-class.md | 10 ++++++---- reference/data-types/datatype-corpse.md | 10 ++++++---- reference/data-types/datatype-currentzone.md | 10 ++++++---- reference/data-types/datatype-deity.md | 8 ++++++-- reference/data-types/datatype-double.md | 10 ++++++---- reference/data-types/datatype-dynamiczone.md | 10 ++++++---- reference/data-types/datatype-dzmember.md | 9 ++++++--- reference/data-types/datatype-dztimer.md | 10 ++++++---- reference/data-types/datatype-everquest.md | 10 ++++++---- reference/data-types/datatype-evolving.md | 10 ++++++---- reference/data-types/datatype-fellowship.md | 11 ++++++----- reference/data-types/datatype-fellowshipmember.md | 10 ++++++---- reference/data-types/datatype-float.md | 10 ++++++---- reference/data-types/datatype-framelimiter.md | 9 ++++++--- reference/data-types/datatype-ground.md | 10 ++++++---- reference/data-types/datatype-group.md | 9 ++++++--- reference/data-types/datatype-groupmember.md | 10 ++++++---- reference/data-types/datatype-heading.md | 9 ++++++--- reference/data-types/datatype-hotbuttonwindow.md | 12 +++++++----- reference/data-types/datatype-ini.md | 9 ++++++--- reference/data-types/datatype-inifile.md | 10 ++++++---- reference/data-types/datatype-inifilesection.md | 10 ++++++---- reference/data-types/datatype-inifilesectionkey.md | 10 ++++++---- reference/data-types/datatype-int.md | 10 ++++++---- reference/data-types/datatype-int64.md | 9 ++++++--- reference/data-types/datatype-inventory.md | 9 ++++++--- reference/data-types/datatype-invslot.md | 10 ++++++---- reference/data-types/datatype-invslotwindow.md | 9 ++++++--- reference/data-types/datatype-item.md | 10 ++++++---- reference/data-types/datatype-itemspell.md | 9 ++++++--- reference/data-types/datatype-keyring.md | 10 ++++++---- reference/data-types/datatype-keyringitem.md | 10 ++++++---- reference/data-types/datatype-macro.md | 10 ++++++---- reference/data-types/datatype-macroquest.md | 10 ++++++---- reference/data-types/datatype-math.md | 10 ++++++---- reference/data-types/datatype-mercenary.md | 10 ++++++---- reference/data-types/datatype-merchant.md | 10 ++++++---- reference/data-types/datatype-pet.md | 9 ++++++--- reference/data-types/datatype-plugin.md | 10 ++++++---- reference/data-types/datatype-race.md | 10 ++++++---- reference/data-types/datatype-raid.md | 10 ++++++---- reference/data-types/datatype-raidmember.md | 9 ++++++--- reference/data-types/datatype-range.md | 9 ++++++--- reference/data-types/datatype-skill.md | 10 ++++++---- reference/data-types/datatype-social.md | 10 ++++++---- reference/data-types/datatype-spawn.md | 10 ++++++---- reference/data-types/datatype-spell.md | 10 ++++++---- reference/data-types/datatype-string.md | 10 ++++++---- reference/data-types/datatype-switch.md | 9 ++++++--- reference/data-types/datatype-target.md | 10 ++++++---- reference/data-types/datatype-task.md | 10 ++++++---- reference/data-types/datatype-taskmember.md | 9 ++++++--- reference/data-types/datatype-taskobjective.md | 9 ++++++--- reference/data-types/datatype-ticks.md | 11 ++++++----- reference/data-types/datatype-time.md | 13 +++++++------ reference/data-types/datatype-timer.md | 9 ++++++--- reference/data-types/datatype-timestamp.md | 9 ++++++--- reference/data-types/datatype-tradeskilldepot.md | 10 ++++++---- reference/data-types/datatype-type.md | 9 ++++++--- reference/data-types/datatype-window.md | 11 ++++++----- reference/data-types/datatype-worldlocation.md | 9 ++++++--- reference/data-types/datatype-xtarget.md | 9 ++++++--- reference/data-types/datatype-zone.md | 8 ++++++-- 80 files changed, 481 insertions(+), 299 deletions(-) diff --git a/reference/data-types/datatype-achievement.md b/reference/data-types/datatype-achievement.md index 1ac16c628..6450c7291 100644 --- a/reference/data-types/datatype-achievement.md +++ b/reference/data-types/datatype-achievement.md @@ -4,10 +4,11 @@ tags: --- # `achievement` +<!--dt-desc-start--> Provides the details about a single achievement and allows access to an achievement's objective. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Completed') }} : True if the achievement has been completed @@ -71,7 +72,7 @@ Provides the details about a single achievement and allows access to an achievem ### {{ renderMember(type='string', name='State') }} : The achievement state. See [Achievement State](datatype-achievement.md#achievement-state) below. - +<!--dt-members-end--> ## Achievement State @@ -175,9 +176,10 @@ Print how many humans you have left to kill for the "**I'm a People Person!**" a | Name | Action | | -------------- | ---------------------- | | **Inspect** | Opens the achievement display window for this achievement | - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [achievementobj]: datatype-achievementobj.md [bool]: datatype-bool.md [time]: datatype-time.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-achievementcat.md b/reference/data-types/datatype-achievementcat.md index d00056eab..ef36d3444 100644 --- a/reference/data-types/datatype-achievementcat.md +++ b/reference/data-types/datatype-achievementcat.md @@ -4,12 +4,13 @@ tags: --- # `achievementcat` +<!--dt-desc-start--> Provides access to achievement categories. Achievements are organized hierarchically in the achievements window by categories. While not required to access achievements, categories may be useful for enumerating lists of achievements. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='achievement', name='Achievement', params='#|Name') }} : Find an achievement in this category by its ID or name. @@ -66,7 +67,7 @@ While not required to access achievements, categories may be useful for enumerat ### {{ renderMember(type='int', name='TotalAchievements') }} : The total number of achievements in this category and its subcategories. - +<!--dt-members-end--> ### Examples @@ -99,8 +100,9 @@ List the unearned achievements in the **EverQuest / Exploration** category: end end ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [achievement]: datatype-achievement.md [achievementcat]: datatype-achievementcat.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-achievementobj.md b/reference/data-types/datatype-achievementobj.md index 35c975fc3..92acbbfa5 100644 --- a/reference/data-types/datatype-achievementobj.md +++ b/reference/data-types/datatype-achievementobj.md @@ -4,10 +4,11 @@ tags: --- # `achievementobj` +<!--dt-desc-start--> Represents a single objective of an achievement - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Completed') }} : True if the objective has been completed. @@ -31,7 +32,7 @@ Represents a single objective of an achievement ### {{ renderMember(type='int', name='RequiredCount') }} : The total count required to be complete the objective. For objectives that don't require a count, this will be zero. - +<!--dt-members-end--> ## Example @@ -72,7 +73,8 @@ List the objectives that are still left to complete the achievement "**Norrathia end end ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [bool]: datatype-bool.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-altability.md b/reference/data-types/datatype-altability.md index 239b93c3f..11bd76586 100644 --- a/reference/data-types/datatype-altability.md +++ b/reference/data-types/datatype-altability.md @@ -4,10 +4,11 @@ tags: --- # `altability` +<!--dt-desc-start--> Contains all the data related to alternate abilities - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='AARankRequired') }} : Rank required to train @@ -111,7 +112,7 @@ Contains all the data related to alternate abilities ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Examples @@ -132,9 +133,10 @@ If the AA "Companion's Aegis" can be trained, buy the next index/rank of it mq.cmd.alt('buy '..mq.TLO.AltAbility("Companion's Aegis").NextIndex()) end ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [bool]: datatype-bool.md [spell]: datatype-spell.md [altability]: datatype-altability.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-argb.md b/reference/data-types/datatype-argb.md index b04215528..f298ebb54 100644 --- a/reference/data-types/datatype-argb.md +++ b/reference/data-types/datatype-argb.md @@ -4,10 +4,11 @@ tags: --- # `argb` +<!--dt-desc-start--> Represents a color - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='A') }} : Alpha channel value. @@ -31,6 +32,9 @@ Represents a color ### [string][string] To String : The hex value of the integer formed by the ARGB. - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> + diff --git a/reference/data-types/datatype-array.md b/reference/data-types/datatype-array.md index 77647f0c8..8170e4164 100644 --- a/reference/data-types/datatype-array.md +++ b/reference/data-types/datatype-array.md @@ -4,15 +4,15 @@ tags: --- # `array` +<!--dt-desc-start--> Data related to arrays. !!! Note Array indexing starts at 1. - - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Dimensions') }} : Number of dimensions in the array @@ -24,7 +24,7 @@ Data related to arrays. ### {{ renderMember(type='int', name='Size', params='N') }} : Total number of elements stored in the _N_ th dimension of the array - +<!--dt-members-end--> ## Usage @@ -78,5 +78,6 @@ There is no limit to the number of dimensions or the number of elements in each /next myCounter /return ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-augtype.md b/reference/data-types/datatype-augtype.md index 850757178..637bc1daa 100644 --- a/reference/data-types/datatype-augtype.md +++ b/reference/data-types/datatype-augtype.md @@ -4,10 +4,12 @@ tags: --- # `augtype` Type +<!--dt-desc-start--> Describes data about an augmentation slot in an item. +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Empty') }} : True if the slot is empty @@ -39,9 +41,10 @@ Describes data about an augmentation slot in an item. ### {{ renderMember(type='int', name='Visible') }} : True if this slot is visible to the user. - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: ./datatype-int.md [bool]: ./datatype-bool.md [string]: ./datatype-string.md [item]: ./datatype-item.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-auratype.md b/reference/data-types/datatype-auratype.md index 8bfc3db6e..fabb167e8 100644 --- a/reference/data-types/datatype-auratype.md +++ b/reference/data-types/datatype-auratype.md @@ -3,11 +3,12 @@ tags: - datatype --- # `auratype` Type - +<!--dt-desc-start--> Describes an aura. +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : ID of the Aura @@ -19,12 +20,14 @@ Describes an aura. ### {{ renderMember(type='int', name='SpawnID') }} : ID of the spawn that emits aura +<!--dt-members-end--> ## Methods | Name | Action | | :--- | :--- | | **Remove** | Remove the aura | - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-bandolier.md b/reference/data-types/datatype-bandolier.md index 0a5cffe57..118eecfb5 100644 --- a/reference/data-types/datatype-bandolier.md +++ b/reference/data-types/datatype-bandolier.md @@ -4,11 +4,11 @@ tags: --- # `bandolier` +<!--dt-desc-start--> Used to access information about bandolier sets on your character. - - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Active') }} : Indicates if the bandolier set is active @@ -24,7 +24,7 @@ Used to access information about bandolier sets on your character. ### {{ renderMember(type='string', name='Name') }} : Returns the name of the bandolier set - +<!--dt-members-end--> ## Methods @@ -80,8 +80,9 @@ Used to access information about bandolier sets on your character. -- Print the weapon in the primary bandolier slot print('I have a ', mq.TLO.Me.Bandolier('1HB').Item(1).Name(), ' in my primary bandolier slot') ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-bandolier.md [bool]: datatype-bool.md -[bandolieritem]: datatype-bandolier.md#bandolieritem \ No newline at end of file +[bandolieritem]: datatype-bandolier.md#bandolieritem +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-bank.md b/reference/data-types/datatype-bank.md index 9c351a5d7..2afb8d920 100644 --- a/reference/data-types/datatype-bank.md +++ b/reference/data-types/datatype-bank.md @@ -4,10 +4,11 @@ tags: --- # `bank` +<!--dt-desc-start--> This is the type for your bank (not including shared bank or other bank features). - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='BagSlots') }} : How many bag slots (base slots for bags/items) your bank has. @@ -35,7 +36,7 @@ This is the type for your bank (not including shared bank or other bank features ### {{ renderMember(type='int', name='Copper') }} : How much copper you have in your bank. - +<!--dt-members-end--> ## Examples @@ -100,5 +101,6 @@ This is the type for your bank (not including shared bank or other bank features ```lua print(mq.TLO.Inventory.Bank.TotalSlots(3)()) ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-body.md b/reference/data-types/datatype-body.md index b3e6a829d..89577815f 100644 --- a/reference/data-types/datatype-body.md +++ b/reference/data-types/datatype-body.md @@ -4,10 +4,11 @@ tags: --- # `body` +<!--dt-desc-start--> Contains data about spawn body types - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : The ID of the body type @@ -19,7 +20,7 @@ Contains data about spawn body types ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Usage @@ -38,6 +39,7 @@ Contains data about spawn body types ```lua print(mq.TLO.Target.Boddy.Name === 'Undead Pet') ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-bool.md b/reference/data-types/datatype-bool.md index fd700d2c7..5b2fc246b 100644 --- a/reference/data-types/datatype-bool.md +++ b/reference/data-types/datatype-bool.md @@ -4,12 +4,15 @@ tags: --- # `bool` +<!--dt-desc-start--> A Boolean expression is one that has just two possible outcomes: 1 (TRUE) and 0 (FALSE). Technically TRUE doesn't have to be 1, but it's always treated that way. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### [string][string] `To String` : "TRUE" for non-zero, or "FALSE" for zero - -[string]: datatype-string.md \ No newline at end of file +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-buff.md b/reference/data-types/datatype-buff.md index 070e3a6dc..eb42ba6c0 100644 --- a/reference/data-types/datatype-buff.md +++ b/reference/data-types/datatype-buff.md @@ -4,10 +4,11 @@ tags: --- # `buff` +<!--dt-desc-start--> This is the type for any buffs currently affecting you, both long duration and short duration buffs. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> This type inherits members from [_spell_](datatype-spell.md). ### {{ renderMember(type='string', name='Caster') }} @@ -65,7 +66,7 @@ This type inherits members from [_spell_](datatype-spell.md). ### [string][string] `To String` : Same as Name - +<!--dt-members-end--> ## Methods @@ -91,7 +92,7 @@ This type inherits members from [_spell_](datatype-spell.md). ```lua mq.TLO.Me.Buff("Credence").Remove() ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [bool]: datatype-bool.md @@ -99,3 +100,4 @@ This type inherits members from [_spell_](datatype-spell.md). [spell]: datatype-spell.md [int64]: datatype-int64.md [float]: datatype-float.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-byte.md b/reference/data-types/datatype-byte.md index d81ef6055..9328e9a87 100644 --- a/reference/data-types/datatype-byte.md +++ b/reference/data-types/datatype-byte.md @@ -4,4 +4,6 @@ tags: --- # `byte` +<!--dt-desc-start--> Represents an 8 bit integer, with values randing from 0 to 255. This is a pure DataType and has no members +<!--dt-desc-end--> diff --git a/reference/data-types/datatype-cachedbuff.md b/reference/data-types/datatype-cachedbuff.md index 23d6a4509..999697221 100644 --- a/reference/data-types/datatype-cachedbuff.md +++ b/reference/data-types/datatype-cachedbuff.md @@ -11,11 +11,11 @@ tags: buffs is now discouraged. You should only used this type if you need access to its "unique" style of buff lookup. - +<!--dt-desc-start--> Information about cached buffs on a player. Data must be populated on a player by first targeting them. See also: [Cached Buffs](../../main/features/cached-buffs.md). - +<!--dt-desc-end--> ## Inheritance This type inherits members from [spell][spell]. @@ -31,7 +31,7 @@ classDiagram ``` ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Caster') }} : Same as _CasterName_, added for consistency. @@ -67,7 +67,7 @@ classDiagram ### {{ renderMember(type='timestamp', name='Staleness') }} : How long it has been since this information was refreshed. - +<!--dt-members-end--> ## Usage @@ -87,8 +87,9 @@ classDiagram ```lua print(mq.TLO.Group.Member(2).CachedBuff("Spirit of Wolf").Duration()) ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [spell]: datatype-spell.md [timestamp]: datatype-timestamp.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-character.md b/reference/data-types/datatype-character.md index 7b965edc7..e631a6cce 100644 --- a/reference/data-types/datatype-character.md +++ b/reference/data-types/datatype-character.md @@ -4,8 +4,9 @@ tags: --- # `character` +<!--dt-desc-start--> This data type contains all the information about _your_ character. - +<!--dt-desc-end--> ## Inheritance This type inherits members from [_spawn_](datatype-spawn.md). @@ -21,7 +22,7 @@ classDiagram ``` ## Members - +<!--dt-members-start--> The [source](https://github.com/macroquest/macroquest/blob/master/src/main/datatypes/MQ2CharacterType.cpp) always has the latest data members. If something is missing here, you can check the source to see if it exists. @@ -1425,7 +1426,7 @@ If something is missing here, you can check the source to see if it exists. ### [string][string] `To String` : The character's name - +<!--dt-members-end--> ## Methods @@ -1448,7 +1449,7 @@ If something is missing here, you can check the source to see if it exists. ``` The delay will last either 5s OR until the assist is complete - +<!--dt-linkrefs-start--> [altability]: datatype-altability.md [auratype]: datatype-auratype.md [bandolier]: datatype-bandolier.md @@ -1470,3 +1471,4 @@ The delay will last either 5s OR until the assist is complete [worldlocation]: datatype-worldlocation.md [xtarget]: datatype-xtarget.md [zone]: datatype-zone.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-charselectlist.md b/reference/data-types/datatype-charselectlist.md index da53d9ba2..933d1cd12 100644 --- a/reference/data-types/datatype-charselectlist.md +++ b/reference/data-types/datatype-charselectlist.md @@ -4,12 +4,13 @@ tags: --- # `charselectlist` +<!--dt-desc-start--> Provides information about the character list. See Also: [_character_](./datatype-character.md), [TLO:Me](../top-level-objects/tlo-me.md) - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Class') }} : Class of the character @@ -33,7 +34,8 @@ See Also: [_character_](./datatype-character.md), [TLO:Me](../top-level-objects/ ### {{ renderMember(type='int', name='ZoneID') }} : Id of the zone the character logged out in - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: ./datatype-int.md [string]: ./datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-class.md b/reference/data-types/datatype-class.md index 84c68d175..315869242 100644 --- a/reference/data-types/datatype-class.md +++ b/reference/data-types/datatype-class.md @@ -4,10 +4,11 @@ tags: --- # `class` +<!--dt-desc-start--> Data about a particular character class - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='CanCast') }} : Can cast spells, including Bard @@ -59,7 +60,7 @@ Data about a particular character class ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Class name and ShortName list: | **Name** | **ShortName** | @@ -80,7 +81,8 @@ Data about a particular character class | Warrior | WAR | | Wizard | WIZ | | Mercenary | MER | - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-corpse.md b/reference/data-types/datatype-corpse.md index 69455c752..2096041f7 100644 --- a/reference/data-types/datatype-corpse.md +++ b/reference/data-types/datatype-corpse.md @@ -4,8 +4,9 @@ tags: --- # `corpse` +<!--dt-desc-start--> Data related to the current lootable corpse. See [Corpse](../top-level-objects/tlo-corpse.md). - +<!--dt-desc-end--> ## Inheritance This type inherits members from [_spawn_](datatype-spawn.md). @@ -22,7 +23,7 @@ classDiagram ``` ## Members - +<!--dt-members-start--> ### {{ renderMember(type='item', name='Item', params='N') }} : _Nth_ item on the corpse @@ -42,7 +43,7 @@ classDiagram ### [string][string] `To String` : Same as **Open** - +<!--dt-members-end--> ## Usage @@ -63,8 +64,9 @@ classDiagram print('We are currently looting a corpse with items') end ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [item]: datatype-item.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-currentzone.md b/reference/data-types/datatype-currentzone.md index 523a1f230..3b7279c42 100644 --- a/reference/data-types/datatype-currentzone.md +++ b/reference/data-types/datatype-currentzone.md @@ -4,8 +4,9 @@ tags: --- # `currentzone` +<!--dt-desc-start--> Extends the [_zone_](datatype-zone.md) type with additional information about the current zone. - +<!--dt-desc-end--> ## Inheritance This type inherits members from [_zone_](datatype-zone.md). @@ -22,7 +23,7 @@ classDiagram ``` ## Members - +<!--dt-members-start--> This type inherits members from [_zone_](datatype-zone.md). ### {{ renderMember(type='bool', name='Dungeon') }} @@ -81,7 +82,7 @@ This type inherits members from [_zone_](datatype-zone.md). ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Usage @@ -100,8 +101,9 @@ This type inherits members from [_zone_](datatype-zone.md). -- echo if the current zone is indoors: print(mq.TLO.Zone.Indoor()) ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-deity.md b/reference/data-types/datatype-deity.md index 3c231b1eb..8c730e065 100644 --- a/reference/data-types/datatype-deity.md +++ b/reference/data-types/datatype-deity.md @@ -4,10 +4,12 @@ tags: --- # `deity` Type +<!--dt-desc-start--> Contains data related to deity members +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : The deity's ID # @@ -23,6 +25,8 @@ Contains data related to deity members ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-double.md b/reference/data-types/datatype-double.md index 1c5c0da56..e0e0da45c 100644 --- a/reference/data-types/datatype-double.md +++ b/reference/data-types/datatype-double.md @@ -3,15 +3,15 @@ tags: - datatype --- # `double` Type - +<!--dt-desc-start--> Represents a double precision (64-bit) floating point number. * A floating-point number is one which has a decimal component (_e.g. 1.01_) * Members of this DataType generally manipulate the number's precision (_i.e. how many decimal places_) * They all round correctly with the exception of _int_ - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Deci') }} : The number as a string with **one** place of precision, _i.e. ###.#_ @@ -39,6 +39,8 @@ Represents a double precision (64-bit) floating point number. ### [string][string] `To String` : Same as **Centi** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-dynamiczone.md b/reference/data-types/datatype-dynamiczone.md index 27acf45e1..e666d618c 100644 --- a/reference/data-types/datatype-dynamiczone.md +++ b/reference/data-types/datatype-dynamiczone.md @@ -4,12 +4,13 @@ tags: --- # `dynamiczone` +<!--dt-desc-start--> Data for the current dynamic zone instance See Also: [TLO:DynamicZone](../top-level-objects/tlo-dynamiczone.md) - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='InRaid') }} : ?? @@ -53,7 +54,7 @@ See Also: [TLO:DynamicZone](../top-level-objects/tlo-dynamiczone.md) ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Usage @@ -80,9 +81,10 @@ See Also: [TLO:DynamicZone](../top-level-objects/tlo-dynamiczone.md) * January 19th, 2022: Added MinMembers * July 9th, 2021: Added MaxTimers, Timer - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [dzmember]: datatype-dzmember.md [dztimer]: datatype-dztimer.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-dzmember.md b/reference/data-types/datatype-dzmember.md index 9f54db754..b4a078471 100644 --- a/reference/data-types/datatype-dzmember.md +++ b/reference/data-types/datatype-dzmember.md @@ -4,12 +4,13 @@ tags: --- # `dzmember` +<!--dt-desc-start--> This DataType contains information on the members of the current dynamic zone instance See Also: [DataType:dynamiczone](./datatype-dynamiczone.md), [TLO:DynamicZone](../top-level-objects/tlo-dynamiczone.md) - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Flagged') }} : Returns true if the dzmember can successfully enter the dz. where x is either index or the name. @@ -25,6 +26,8 @@ See Also: [DataType:dynamiczone](./datatype-dynamiczone.md), [TLO:DynamicZone](. ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-dztimer.md b/reference/data-types/datatype-dztimer.md index 6a9251663..6b975db05 100644 --- a/reference/data-types/datatype-dztimer.md +++ b/reference/data-types/datatype-dztimer.md @@ -4,12 +4,13 @@ tags: --- # `dztimer` +<!--dt-desc-start--> Provides information about a dynamic zone lockout timer See Also: [DataType:dynamiczone](./datatype-dynamiczone.md), [TLO:DynamicZone](../top-level-objects/tlo-dynamiczone.md) - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='ExpeditionName') }} : The name of the expedition @@ -29,11 +30,12 @@ See Also: [DataType:dynamiczone](./datatype-dynamiczone.md), [TLO:DynamicZone](. ### [string][string] `To String` : Returns the string formatted as `"ExpeditionName|EventName"` | - +<!--dt-members-end--> ### Changelog * July 9th, 2021: Initial version - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [timestamp]: datatype-timestamp.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-everquest.md b/reference/data-types/datatype-everquest.md index 7515d8987..fef4fb4d1 100644 --- a/reference/data-types/datatype-everquest.md +++ b/reference/data-types/datatype-everquest.md @@ -4,10 +4,11 @@ tags: --- # `everquest` +<!--dt-desc-start--> Data types related to the current EverQuest session. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='CharSelectList') }} : Currently returns the zone ID the character is currently in @@ -147,7 +148,7 @@ Data types related to the current EverQuest session. ### {{ renderMember(type='string', name='WinTitle') }} : Titlebar text of the Everquest window. - +<!--dt-members-end--> ## Usage @@ -177,7 +178,7 @@ Data types related to the current EverQuest session. -- Will print true or false if the location is valid print(mq.TLO.EverQuest.ValidLoc("123 456 789")()) ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [int]: datatype-int.md @@ -185,3 +186,4 @@ Data types related to the current EverQuest session. [string]: datatype-string.md [window]: datatype-window.md [worldlocation]: datatype-worldlocation.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-evolving.md b/reference/data-types/datatype-evolving.md index 2c218ef88..0b2878495 100644 --- a/reference/data-types/datatype-evolving.md +++ b/reference/data-types/datatype-evolving.md @@ -4,10 +4,11 @@ tags: --- # `evolving` +<!--dt-desc-start--> A DataType that deals with evolving items. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='ExpOn') }} : Is evolving item experience turned on for this item? @@ -27,7 +28,7 @@ A DataType that deals with evolving items. ### [string][string] `To String` : Same as **ExpOn** - +<!--dt-members-end--> ## Usage @@ -44,8 +45,9 @@ A DataType that deals with evolving items. ```lua print(mq.TLO.FindItem("Blade of the Eclipse").Evolving.ExpPct()) ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-fellowship.md b/reference/data-types/datatype-fellowship.md index 351099bd3..c4aa00eb7 100644 --- a/reference/data-types/datatype-fellowship.md +++ b/reference/data-types/datatype-fellowship.md @@ -4,10 +4,11 @@ tags: --- # `fellowship` +<!--dt-desc-start--> Contains all the data about your fellowship - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Campfire') }} : TRUE if campfire is up, FALSE if not @@ -63,14 +64,13 @@ Contains all the data about your fellowship ### [string][string] `To String` : TRUE if currently in a fellowship, FALSE if not - - +<!--dt-members-end--> ## Changelog * May 13, 2022: Added Exists * December 3rd, 2020: Added Sharing - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [fellowshipmember]: datatype-fellowshipmember.md [float]: datatype-float.md @@ -78,3 +78,4 @@ Contains all the data about your fellowship [string]: datatype-string.md [ticks]: datatype-ticks.md [zone]: datatype-zone.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-fellowshipmember.md b/reference/data-types/datatype-fellowshipmember.md index eeaf7fa39..02d88e49b 100644 --- a/reference/data-types/datatype-fellowshipmember.md +++ b/reference/data-types/datatype-fellowshipmember.md @@ -4,10 +4,11 @@ tags: --- # `fellowshipmember` +<!--dt-desc-start--> Contains all the data related to fellowship members - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='class', name='Class') }} : Member's class @@ -35,15 +36,16 @@ Contains all the data related to fellowship members ### [string][string] `To String` : player name - +<!--dt-members-end--> ## Changelog * March 7th, 2021: Added Sharing - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [class]: datatype-class.md [int]: datatype-int.md [string]: datatype-string.md [ticks]: datatype-ticks.md [zone]: datatype-zone.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-float.md b/reference/data-types/datatype-float.md index 41cc9c5ea..8573cf3dd 100644 --- a/reference/data-types/datatype-float.md +++ b/reference/data-types/datatype-float.md @@ -3,15 +3,15 @@ tags: - datatype --- # `float` Type - +<!--dt-desc-start--> Represents a single precision (32-bit) floatiang point number. * A floating-point number is one which has a decimal component (_e.g. 1.01_) * Members of this DataType generally manipulate the number's precision (_i.e. how many decimal places_) * They all round correctly with the exception of _int_ - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Centi') }} : The number as a string with **two** places of precision, _i.e. ###.##_ @@ -43,6 +43,8 @@ Represents a single precision (32-bit) floatiang point number. ### [string][string] `To String` : Same as **Centi** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-framelimiter.md b/reference/data-types/datatype-framelimiter.md index cc6b5aab2..4c5d55522 100644 --- a/reference/data-types/datatype-framelimiter.md +++ b/reference/data-types/datatype-framelimiter.md @@ -4,10 +4,11 @@ tags: --- # `framelimiter` +<!--dt-desc-start--> Data type to access frame limiter information. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='float', name='BackgroundFPS') }} : Value of the target background fps setting. @@ -47,7 +48,9 @@ Data type to access frame limiter information. ### {{ renderMember(type='string', name='Status') }} : Either "Foreground" or "Background". - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-ground.md b/reference/data-types/datatype-ground.md index c5d7cf877..1ed0120ff 100644 --- a/reference/data-types/datatype-ground.md +++ b/reference/data-types/datatype-ground.md @@ -4,10 +4,11 @@ tags: --- # `ground` +<!--dt-desc-start--> Represents a ground item. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='float', name='DisplayName') }} : Displays name of the grounspawn @@ -91,7 +92,7 @@ Represents a ground item. ### [string][string] `To String` : Same as ID - +<!--dt-members-end--> ## Methods @@ -135,10 +136,11 @@ Will target the closest item on the ground which has the word "egg" in it. and t ``` Will face the closest item on the ground. and then echo the distance to it in the mq2 window. well if it finds an groundspawn, otherwise it will just echo NULL .DoFace does NOT target the ground item, it just faces it. - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [ground]: datatype-ground.md [heading]: datatype-heading.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-group.md b/reference/data-types/datatype-group.md index d8bed0ffc..696a632d9 100644 --- a/reference/data-types/datatype-group.md +++ b/reference/data-types/datatype-group.md @@ -4,10 +4,11 @@ tags: --- # `group` +<!--dt-desc-start--> Contains details about your group - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='AnyoneMissing') }} : True if somebody in the group is offline, in some other zone, or just simply dead. @@ -113,9 +114,11 @@ Contains details about your group ### [string][string] `To String` : The number of members in the group, as a string. - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [groupmember]: datatype-groupmember.md [int]: datatype-int.md [spawn]: datatype-spawn.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-groupmember.md b/reference/data-types/datatype-groupmember.md index 244a8eeee..99a66f80a 100644 --- a/reference/data-types/datatype-groupmember.md +++ b/reference/data-types/datatype-groupmember.md @@ -4,10 +4,11 @@ tags: --- # `groupmember` +<!--dt-desc-start--> Contains data on a specific group member - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> This type inherits members from [_spawn_ ](datatype-spawn.md)if the member is in the current zone. ### {{ renderMember(type='int', name='Index') }} @@ -73,7 +74,7 @@ This type inherits members from [_spawn_ ](datatype-spawn.md)if the member is in ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Examples @@ -88,8 +89,9 @@ Echo TRUE if you are Group Leader. ``` Echo TRUE if Group Member 3 is marked as Role Puller - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [spawn]: datatype-spawn.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-heading.md b/reference/data-types/datatype-heading.md index fa5733499..eb42516b8 100644 --- a/reference/data-types/datatype-heading.md +++ b/reference/data-types/datatype-heading.md @@ -4,10 +4,11 @@ tags: --- # `heading` +<!--dt-desc-start--> Represents a direction on a compass. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Clock') }} : The nearest clock direction, e.g. 1-12 @@ -31,7 +32,9 @@ Represents a direction on a compass. ### [string][string] `(To String)` : Same as **ShortName** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [float]: datatype-float.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-hotbuttonwindow.md b/reference/data-types/datatype-hotbuttonwindow.md index 141e9e623..98047b402 100644 --- a/reference/data-types/datatype-hotbuttonwindow.md +++ b/reference/data-types/datatype-hotbuttonwindow.md @@ -4,10 +4,11 @@ tags: --- # `hotbuttonwindow` +<!--dt-desc-start--> Data related to hotbuttons - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='altability', name='AltAbility') }} : If this hotbutton activates an alternate ability, this will return the alternate @@ -102,7 +103,7 @@ Data related to hotbuttons ### {{ renderMember(type='string', name='TypeName') }} : Returns the type name of hotbutton. See [HotButton Types](#hotbutton-types). - +<!--dt-members-end--> ## Methods @@ -176,9 +177,10 @@ To access a hot button, go through the Window TLO: The Window Inspector can be used to identify hotbars and hotbuttons. - +<!--dt-linkrefs-start--> [altability]: datatype-altability.md [item]: datatype-item.md [int]: datatype-int.md [social]: datatype-social.md -[string]: datatype-string.md \ No newline at end of file +[string]: datatype-string.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-ini.md b/reference/data-types/datatype-ini.md index 47dcf080d..a9305bd25 100644 --- a/reference/data-types/datatype-ini.md +++ b/reference/data-types/datatype-ini.md @@ -4,14 +4,17 @@ tags: --- # `ini` +<!--dt-desc-start--> This is the type for an ini that you have referenced without an Index. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='inifile', name='File') }} : The ini file you would like to reference. ".ini" is appended if there is no extension. Relative and absolute paths are allowed. Searching is performed using the macro directory and the config directory for relative paths. - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [inifile]: datatype-inifile.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-inifile.md b/reference/data-types/datatype-inifile.md index bbda8695c..de9005916 100644 --- a/reference/data-types/datatype-inifile.md +++ b/reference/data-types/datatype-inifile.md @@ -4,10 +4,11 @@ tags: --- # `inifile` +<!--dt-desc-start--> This is the type for the ini file that was referenced from [TLO:Ini](../top-level-objects/tlo-ini.md) - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Exists') }} : Whether the ini file exists or not. @@ -17,7 +18,7 @@ This is the type for the ini file that was referenced from [TLO:Ini](../top-leve : A reference to the named or unnamed section of this ini file. The index is optional. Passing an index means it will search for matches to that index. Not passing an index references all sections for operations that allow it. - +<!--dt-members-end--> ## Examples @@ -36,6 +37,7 @@ This is the type for the ini file that was referenced from [TLO:Ini](../top-leve ```lua mq.TLO.Ini.File("sample").Exists() ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [inifilesection]: datatype-inifilesection.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-inifilesection.md b/reference/data-types/datatype-inifilesection.md index 6fe9a7856..48ce8aa51 100644 --- a/reference/data-types/datatype-inifilesection.md +++ b/reference/data-types/datatype-inifilesection.md @@ -4,10 +4,11 @@ tags: --- # `inifilesection` +<!--dt-desc-start--> This is the type for the referenced section of an ini file. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Count') }} : How many sections matching the Section[] index exist. @@ -21,7 +22,7 @@ This is the type for the referenced section of an ini file. : A reference to the named or unnamed key in this specific ini file section. The index is optional. Passing an index means it will reference all keys that match that index. Not passing an index references all keys for operations that allow it. - +<!--dt-members-end--> ## Examples @@ -87,7 +88,8 @@ Key=foobar -- prints false print(mq.TLO.Ini.File("Sample").Section("Section3").Exists()) ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [inifilesectionkey]: datatype-inifilesectionkey.md [int]: datatype-int.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-inifilesectionkey.md b/reference/data-types/datatype-inifilesectionkey.md index 84d133025..b013698aa 100644 --- a/reference/data-types/datatype-inifilesectionkey.md +++ b/reference/data-types/datatype-inifilesectionkey.md @@ -4,10 +4,11 @@ tags: --- # `inifilesectionkey` +<!--dt-desc-start--> This is the type for the referenced key in a specific section of an ini file. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Count') }} : How many keys matching the Key[] index exist. @@ -27,7 +28,7 @@ This is the type for the referenced key in a specific section of an ini file. ### {{ renderMember(type='string', name='ValueAtIndex') }} : The value of the entry at the specified index - +<!--dt-members-end--> ## Examples @@ -134,7 +135,8 @@ Key4=foobarfour foobarfive ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-int.md b/reference/data-types/datatype-int.md index c26f8c3e0..8330feb87 100644 --- a/reference/data-types/datatype-int.md +++ b/reference/data-types/datatype-int.md @@ -3,11 +3,11 @@ tags: - datatype --- # `int` Type - +<!--dt-desc-start--> Represents a 32-bit integer. Can hold values from -2,147,483,648 to 2,147,483,647. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='float', name='Float') }} : The number as a float (123 is represented as 123.0) @@ -39,8 +39,10 @@ Represents a 32-bit integer. Can hold values from -2,147,483,648 to 2,147,483,64 ### [string][string] `(To String)` : The number as a string - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [double]: datatype-double.md [float]: datatype-float.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-int64.md b/reference/data-types/datatype-int64.md index 497bc98d1..3f36c9707 100644 --- a/reference/data-types/datatype-int64.md +++ b/reference/data-types/datatype-int64.md @@ -4,10 +4,11 @@ tags: --- # `int64` Type +<!--dt-desc-start--> Represents a 64-bit integer. Can hold values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='float', name='Float') }} : The number as a float (123 is represented as 123.0) @@ -39,9 +40,11 @@ Represents a 64-bit integer. Can hold values from -9,223,372,036,854,775,808 to ### [string][string] `(To String)` : The number as a string - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [double]: datatype-double.md [float]: datatype-float.md [int]: datatype-int.md [int64]: datatype-int64.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-inventory.md b/reference/data-types/datatype-inventory.md index d94b67e40..1fb648d8a 100644 --- a/reference/data-types/datatype-inventory.md +++ b/reference/data-types/datatype-inventory.md @@ -4,12 +4,15 @@ tags: --- # `inventory` +<!--dt-desc-start--> This is the type for all things inventory related. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bank', name='Bank') }} : Your bank, only including the primary slots and currencies (not including shared or other features) - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bank]: datatype-bank.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-invslot.md b/reference/data-types/datatype-invslot.md index 0188030f8..c3c81fcf5 100644 --- a/reference/data-types/datatype-invslot.md +++ b/reference/data-types/datatype-invslot.md @@ -4,10 +4,11 @@ tags: --- # `invslot` +<!--dt-desc-start--> Data related to an inventory slot. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : ID of this item slot (usable directly by [/itemnotify](../../reference/commands/itemnotify.md)) @@ -31,7 +32,7 @@ Data related to an inventory slot. ### [string][string] `To String` : Same as **ID** - +<!--dt-members-end--> ## Example @@ -57,7 +58,7 @@ Data related to an inventory slot. end ``` - +<!--dt-linkrefs-start--> [achievement]: datatype-achievement.md [achievementcat]: datatype-achievementcat.md [achievementobj]: datatype-achievementobj.md @@ -92,3 +93,4 @@ Data related to an inventory slot. [worldlocation]: datatype-worldlocation.md [xtarget]: datatype-xtarget.md [zone]: datatype-zone.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-invslotwindow.md b/reference/data-types/datatype-invslotwindow.md index a56d89a18..afb026082 100644 --- a/reference/data-types/datatype-invslotwindow.md +++ b/reference/data-types/datatype-invslotwindow.md @@ -4,10 +4,11 @@ tags: --- # `invslotwindow` +<!--dt-desc-start--> Contains information related to the specified inventory slot - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Background') }} : Background image for the slot @@ -63,8 +64,10 @@ Contains information related to the specified inventory slot ### {{ renderMember(type='string', name='Text') }} : ??? - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [item]: datatype-item.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-item.md b/reference/data-types/datatype-item.md index 226177075..be9cada89 100644 --- a/reference/data-types/datatype-item.md +++ b/reference/data-types/datatype-item.md @@ -3,11 +3,11 @@ tags: - datatype --- # `item` Type - +<!--dt-desc-start--> Contains the properties that describe an item. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='AC') }} : AC value on item @@ -681,6 +681,7 @@ Contains the properties that describe an item. : Same as **Name** +<!--dt-members-end--> ## Methods @@ -735,7 +736,7 @@ Contains the properties that describe an item. * DisplayIndex = 6 **NOTE:** There is a difference between .Info and .Information .Info contains for example: .Info can return text like; this item is placable in yards, guild yards blah blah , This item can be used in tradeskills .Information can return text like Item Information: Placing this augment into blah blah, this armor can only be used in blah blah - +<!--dt-linkrefs-start--> [augtype]: datatype-augtype.md [bool]: datatype-bool.md [evolving]: datatype-evolving.md @@ -748,3 +749,4 @@ Contains the properties that describe an item. [spell]: datatype-spell.md [string]: datatype-string.md [ticks]: datatype-ticks.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-itemspell.md b/reference/data-types/datatype-itemspell.md index 824555eae..834bb143b 100644 --- a/reference/data-types/datatype-itemspell.md +++ b/reference/data-types/datatype-itemspell.md @@ -4,10 +4,12 @@ tags: --- # `itemspell` Type +<!--dt-desc-start--> Represents a spell effect on an item. +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='CastTime') }} : Spell cast time. @@ -63,8 +65,9 @@ Represents a spell effect on an item. ### {{ renderMember(type='int', name='TimerID') }} : Timer ID of the spell. - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: ../data-types/datatype-int.md [spell]: ../data-types/datatype-spell.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-keyring.md b/reference/data-types/datatype-keyring.md index 513bdd23b..9ca09fe4d 100644 --- a/reference/data-types/datatype-keyring.md +++ b/reference/data-types/datatype-keyring.md @@ -4,10 +4,11 @@ tags: --- # `keyring` +<!--dt-desc-start--> This datatype represents information about a keyring (a.k.a. a collection of mounts, illusions, etc) - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Count') }} : The number of items in this keyring @@ -15,7 +16,7 @@ This datatype represents information about a keyring (a.k.a. a collection of mou ### {{ renderMember(type='keyringitem', name='Stat') }} : The keyring item assigned as the stat item - +<!--dt-members-end--> ## Examples @@ -36,6 +37,7 @@ This datatype represents information about a keyring (a.k.a. a collection of mou ``` Outputs: 3 - +<!--dt-linkrefs-start--> [int]: datatype-int.md [keyringitem]: datatype-keyringitem.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-keyringitem.md b/reference/data-types/datatype-keyringitem.md index 795f9e3cd..329be0de0 100644 --- a/reference/data-types/datatype-keyringitem.md +++ b/reference/data-types/datatype-keyringitem.md @@ -4,10 +4,11 @@ tags: --- # `keyringitem` +<!--dt-desc-start--> This datatype deals strictly with information items on a keyring. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Index') }} : Where on the keyring list @@ -19,7 +20,7 @@ This datatype deals strictly with information items on a keyring. ### {{ renderMember(type='string', name='Name') }} : name of the keyring item - +<!--dt-members-end--> ## Examples @@ -42,7 +43,8 @@ This datatype deals strictly with information items on a keyring. ``` Outputs: 2 - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [item]: datatype-item.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-macro.md b/reference/data-types/datatype-macro.md index 18cad97b6..5b881d010 100644 --- a/reference/data-types/datatype-macro.md +++ b/reference/data-types/datatype-macro.md @@ -4,10 +4,11 @@ tags: --- # `macro` +<!--dt-desc-start--> The Macro DataType deals with the macro currently running, and nothing else. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='CurCommand') }} : list the current line number, macro name, and code of the macro being processed @@ -59,15 +60,16 @@ The Macro DataType deals with the macro currently running, and nothing else. ### {{ renderMember(type='varies', name='Variable') }} : returns the value given the name of Macro variable. The type of this member depends on the type of the variable being accessed. - +<!--dt-members-end--> ## Methods | Method Name | Action | | :--- | :--- | | Undeclared | List all undeclared variables | - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [int64]: datatype-int64.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-macroquest.md b/reference/data-types/datatype-macroquest.md index 66ca149ef..3729fce6e 100644 --- a/reference/data-types/datatype-macroquest.md +++ b/reference/data-types/datatype-macroquest.md @@ -4,10 +4,11 @@ tags: --- # `macroquest` +<!--dt-desc-start--> Data types related to the current MacroQuest2 session. These also inherit from the [EverQuest Type](datatype-everquest.md). - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Anonymize') }} : Anonymize character data @@ -84,7 +85,7 @@ Data types related to the current MacroQuest2 session. These also inherit from ### [string][string] `To String` : None - +<!--dt-members-end--> ## Example @@ -93,7 +94,8 @@ Get the path to the config directory. ``` /echo ${MacroQuest.Path[config]} ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-math.md b/reference/data-types/datatype-math.md index 762d2455d..43eecf0c6 100644 --- a/reference/data-types/datatype-math.md +++ b/reference/data-types/datatype-math.md @@ -4,10 +4,11 @@ tags: --- # `math` +<!--dt-desc-start--> This DataType performs various mathematical calculations. In the following members, _n_ is any formula that consists of valid [Operators](../../macros/operators.md). - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='float', name='Abs', params='n') }} : The absolute value of the result of _n_ @@ -67,8 +68,9 @@ This DataType performs various mathematical calculations. In the following membe ### {{ renderMember(type='float', name='Tan', params='n') }} : Tangent of _n_ (in degrees) - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [float]: datatype-float.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-mercenary.md b/reference/data-types/datatype-mercenary.md index e4b670f4e..225a74949 100644 --- a/reference/data-types/datatype-mercenary.md +++ b/reference/data-types/datatype-mercenary.md @@ -4,10 +4,11 @@ tags: --- # `mercenary` +<!--dt-desc-start--> This is the type used for mercenaries. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> This type inherits members from [_spawn_](datatype-spawn.md). ### {{ renderMember(type='int', name='AAPoints') }} @@ -42,7 +43,7 @@ This type inherits members from [_spawn_](datatype-spawn.md). ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Examples @@ -55,6 +56,7 @@ This type inherits members from [_spawn_](datatype-spawn.md). /stance reactive } ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-merchant.md b/reference/data-types/datatype-merchant.md index 6325d5089..c68549f42 100644 --- a/reference/data-types/datatype-merchant.md +++ b/reference/data-types/datatype-merchant.md @@ -4,10 +4,11 @@ tags: --- # `merchant` +<!--dt-desc-start--> This contains information related to the active merchant. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> This type inherits members from [_spawn_](datatype-spawn.md) if a merchant is active. ### {{ renderMember(type='bool', name='Full') }} @@ -48,7 +49,7 @@ This type inherits members from [_spawn_](datatype-spawn.md) if a merchant is ac ### [string][string] `(To String)` : Same as *Open* - +<!--dt-members-end--> ## Methods @@ -73,9 +74,10 @@ Will select a "Diamond" you can also do "=Diamond" to match EXACT name. Then you ``` /invoke ${Merchant.Sell[100]} ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [int]: datatype-int.md [item]: datatype-item.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-pet.md b/reference/data-types/datatype-pet.md index 2bc117e97..1dfe4ec23 100644 --- a/reference/data-types/datatype-pet.md +++ b/reference/data-types/datatype-pet.md @@ -4,10 +4,11 @@ tags: --- # `pet` +<!--dt-desc-start--> Pet object - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> This type inherits members from [_spawn_](datatype-spawn.md). ### {{ renderMember(type='int', name='Buff', params='buffname') }} @@ -69,9 +70,11 @@ This type inherits members from [_spawn_](datatype-spawn.md). ### {{ renderMember(type='bool', name='Taunt') }} : Taunt state - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [buff]: datatype-buff.md [int]: datatype-int.md [spawn]: datatype-spawn.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-plugin.md b/reference/data-types/datatype-plugin.md index ddab3e33e..942426912 100644 --- a/reference/data-types/datatype-plugin.md +++ b/reference/data-types/datatype-plugin.md @@ -4,10 +4,11 @@ tags: --- # `plugin` +<!--dt-desc-start--> Data for the specified plugin - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='IsLoaded') }} : Returns true if the plugin is loaded @@ -23,8 +24,9 @@ Data for the specified plugin ### [string][string] `To String` : Same as **Name** - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-race.md b/reference/data-types/datatype-race.md index 1d12e5bf6..f79bcaa13 100644 --- a/reference/data-types/datatype-race.md +++ b/reference/data-types/datatype-race.md @@ -4,10 +4,11 @@ tags: --- # `race` +<!--dt-desc-start--> Contains information on the specified race - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : The ID of the race @@ -19,7 +20,8 @@ Contains information on the specified race ### [string][string] `To String` : Same as **Name** - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-raid.md b/reference/data-types/datatype-raid.md index 551f1580a..1332f3e5b 100644 --- a/reference/data-types/datatype-raid.md +++ b/reference/data-types/datatype-raid.md @@ -4,10 +4,11 @@ tags: --- # `raid` +<!--dt-desc-start--> Contains data on the current raid - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='float', name='AverageLevel') }} : Average level of raid members (more accurate than in the window) @@ -73,10 +74,11 @@ Contains data on the current raid ### {{ renderMember(type='int', name='TotalLevels') }} : Sum of all raid member's levels - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [int]: datatype-int.md [raidmember]: datatype-raidmember.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-raidmember.md b/reference/data-types/datatype-raidmember.md index 8a7110d40..00827c2d1 100644 --- a/reference/data-types/datatype-raidmember.md +++ b/reference/data-types/datatype-raidmember.md @@ -4,10 +4,11 @@ tags: --- # `raidmember` +<!--dt-desc-start--> Data related to the specified raid member - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='class', name='Class') }} : Raid member's class (works without being in zone) @@ -43,9 +44,11 @@ Data related to the specified raid member ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [class]: datatype-class.md [int]: datatype-int.md [spawn]: datatype-spawn.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-range.md b/reference/data-types/datatype-range.md index 854d90466..5a1314f71 100644 --- a/reference/data-types/datatype-range.md +++ b/reference/data-types/datatype-range.md @@ -4,10 +4,11 @@ tags: --- # `range` +<!--dt-desc-start--> This DataType performs a simple test on _n_ using the following members. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Between', params='#1,#2:N') }} : True if _N_ is between the range of _#1_ and _#2_, inclusive. @@ -48,5 +49,7 @@ This DataType performs a simple test on _n_ using the following members. ${Range.Inside[33,66:33]} ``` - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-skill.md b/reference/data-types/datatype-skill.md index 8056d1bbd..f2637826a 100644 --- a/reference/data-types/datatype-skill.md +++ b/reference/data-types/datatype-skill.md @@ -4,10 +4,11 @@ tags: --- # `skill` +<!--dt-desc-start--> Data related to a particular skill - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='bool', name='Activated') }} : Returns TRUE if the skill is an activatable skill (ie, an Ability) @@ -53,8 +54,9 @@ Data related to a particular skill ### [string][string] `To String` : Same as **Name** - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-social.md b/reference/data-types/datatype-social.md index 7d0fd68ac..4a75a3699 100644 --- a/reference/data-types/datatype-social.md +++ b/reference/data-types/datatype-social.md @@ -4,10 +4,11 @@ tags: --- # `social` +<!--dt-desc-start--> Data related to an Everquest social macro. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Cmd', params='opt: lineNo') }} : Command lines of social. Provide `lineNo` (line number) to retrieve individual lines. If @@ -21,7 +22,7 @@ Data related to an Everquest social macro. ### {{ renderMember(type='string', name='Name') }} : Name of the social. - +<!--dt-members-end--> ## Example @@ -41,6 +42,7 @@ Data related to an Everquest social macro. print(mq.TLO.Social(3).Name()) ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-spawn.md b/reference/data-types/datatype-spawn.md index d53ff6ffb..718cdac16 100644 --- a/reference/data-types/datatype-spawn.md +++ b/reference/data-types/datatype-spawn.md @@ -4,10 +4,11 @@ tags: --- # `spawn` +<!--dt-desc-start--> Represents an in-game spawn. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='AARank') }} : AA rank number @@ -659,7 +660,7 @@ Represents an in-game spawn. ### [string][string] `To String` : Same as **Name** - +<!--dt-members-end--> ## Methods @@ -677,7 +678,7 @@ Represents an in-game spawn. | --- | --- | | `${Pet.Equipment[primary].ID}` | ID number of the pet's primary weapon | | `${Group.Member[mymagesname].Pet.Equipment[primary].ID}` | ID number of the group member's pet's primary weapon | - +<!--dt-linkrefs-start--> [body]: datatype-body.md [bool]: datatype-bool.md [buff]: datatype-buff.md @@ -693,3 +694,4 @@ Represents an in-game spawn. [spell]: datatype-spell.md [string]: datatype-string.md [timestamp]: datatype-timestamp.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-spell.md b/reference/data-types/datatype-spell.md index c4f40751f..9c901e5c1 100644 --- a/reference/data-types/datatype-spell.md +++ b/reference/data-types/datatype-spell.md @@ -4,10 +4,11 @@ tags: --- # `spell` +<!--dt-desc-start--> This is the type used for spell information. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ActorTagId') }} : ??? @@ -417,7 +418,7 @@ This is the type used for spell information. ### [string][string] `(To String)` : Same as **Name** - +<!--dt-members-end--> ## Methods @@ -457,7 +458,7 @@ To cast a spell with the proper rank, use the following: /cast "${Spell[Vinespur].RankName}" ``` - +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [int]: datatype-int.md @@ -466,3 +467,4 @@ To cast a spell with the proper rank, use the following: [string]: datatype-string.md [ticks]: datatype-ticks.md [timestamp]: datatype-timestamp.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-string.md b/reference/data-types/datatype-string.md index 2e05c50cf..4d802fde9 100644 --- a/reference/data-types/datatype-string.md +++ b/reference/data-types/datatype-string.md @@ -4,10 +4,11 @@ tags: --- # `string` +<!--dt-desc-start--> A string is an array of characters. In MacroQuest there is no single character datatype, so any variable or expression that contains text is considered a string. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Arg', params='#,s') }} : Returns the #th argument of the string separated by _s_. The separator _s_ must be a single character (defaults to space).<br />See [Difference between Arg and Token][1]. @@ -83,7 +84,7 @@ A string is an array of characters. In MacroQuest there is no single character d ### [string][string] `(To String)` : Returns the string - +<!--dt-members-end--> ## Usage @@ -134,7 +135,7 @@ Sub Event_SpellWornOff(string Line, string SpellName, string OnWho) /if (${SpellName.Equal[Enveloping Roots]}) /echo Yikes, Root wore off ... run! /return ``` - +<!--dt-linkrefs-start--> [1]: #difference-between-arg-and-token [achievement]: datatype-achievement.md [achievementcat]: datatype-achievementcat.md @@ -179,3 +180,4 @@ Sub Event_SpellWornOff(string Line, string SpellName, string OnWho) [worldlocation]: datatype-worldlocation.md [xtarget]: datatype-xtarget.md [zone]: datatype-zone.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-switch.md b/reference/data-types/datatype-switch.md index 928a87b92..307d6c6f2 100644 --- a/reference/data-types/datatype-switch.md +++ b/reference/data-types/datatype-switch.md @@ -4,10 +4,11 @@ tags: --- # `switch` +<!--dt-desc-start--> Data related to switches (levers, buttons, etc) in the zone - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='heading', name='DefaultHeading') }} : Heading of "closed" switch @@ -79,9 +80,11 @@ Data related to switches (levers, buttons, etc) in the zone ### {{ renderMember(type='string', name='ToString') }} : Same as **ID** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [float]: datatype-float.md [heading]: datatype-heading.md [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-target.md b/reference/data-types/datatype-target.md index 2c6591a3d..ce47ab51f 100644 --- a/reference/data-types/datatype-target.md +++ b/reference/data-types/datatype-target.md @@ -4,8 +4,9 @@ tags: --- # `target` +<!--dt-desc-start--> This data type represents information specific to your current target. It contains additional members for querying buff information. - +<!--dt-desc-end--> ## Inheritance This type inherits members from [_spawn_](datatype-spawn.md). @@ -21,7 +22,7 @@ classDiagram ``` ## Members - +<!--dt-members-start--> ### {{ renderMember(type='cachedbuff', name='Aego') }} : Returns the name of the Aego spell if the Target has one @@ -181,7 +182,7 @@ classDiagram ### [string][string] `(To String)` : Same as **Name** - +<!--dt-members-end--> ## Examples @@ -191,9 +192,10 @@ classDiagram /target pet /delay 5s ${Target.ID}==${Pet.ID} && ${Target.BuffsPopulated}==TRUE ``` - +<!--dt-linkrefs-start--> [cachedbuff]: datatype-cachedbuff.md [float]: datatype-float.md [int]: datatype-int.md [spawn]: datatype-spawn.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-task.md b/reference/data-types/datatype-task.md index cd84b93d6..b61deb6e0 100644 --- a/reference/data-types/datatype-task.md +++ b/reference/data-types/datatype-task.md @@ -4,10 +4,11 @@ tags: --- # `task` +<!--dt-desc-start--> This is the type for your current task. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : Returns an int of the task ID @@ -72,7 +73,7 @@ This is the type for your current task. ### {{ renderMember(type='int', name='WindowIndex') }} : Returns the Quest Window List Index. (if the window actually has the list filled) - +<!--dt-members-end--> ## Methods @@ -170,9 +171,10 @@ The Task TLO also has a `Select` Method: ``` /echo I should be working on ${Task[hatch].Step} in ${Task[hatch].Step.Zone} ``` - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [taskmember]: datatype-task.md [taskobjective]: datatype-taskobjective.md [timestamp]: datatype-timestamp.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-taskmember.md b/reference/data-types/datatype-taskmember.md index 04c535fc9..3d6c16362 100644 --- a/reference/data-types/datatype-taskmember.md +++ b/reference/data-types/datatype-taskmember.md @@ -4,10 +4,11 @@ tags: --- # `taskmember` +<!--dt-desc-start--> Describes a member in your current task - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Index') }} : Returns task index for member (i.e., 1-6) @@ -19,7 +20,9 @@ Describes a member in your current task ### {{ renderMember(type='string', name='Name') }} : Returns name of the mamber - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [bool]: datatype-ticks.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-taskobjective.md b/reference/data-types/datatype-taskobjective.md index 2f5f3890b..c28627d61 100644 --- a/reference/data-types/datatype-taskobjective.md +++ b/reference/data-types/datatype-taskobjective.md @@ -4,10 +4,11 @@ tags: --- # `taskobjective` +<!--dt-desc-start--> This is the type for your current task objective. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='CurrentCount') }} : Returns the current count of the .Type needed to complete a objective @@ -72,7 +73,9 @@ This is the type for your current task objective. ### {{ renderMember(type='string', name='Zone') }} : Returns the zone the objective is to be performed in - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [bool]: datatype-bool.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-ticks.md b/reference/data-types/datatype-ticks.md index 3be43aa99..c631b7b7e 100644 --- a/reference/data-types/datatype-ticks.md +++ b/reference/data-types/datatype-ticks.md @@ -3,11 +3,11 @@ tags: - datatype --- # `ticks` Type - +<!--dt-desc-start--> Represents a count of "ticks". Ticks are units of 6 seconds that are used to represent certain measurements of time in EverQuest. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Hours') }} : The number of hours in HH:MM:SS (0-23) @@ -43,7 +43,8 @@ Represents a count of "ticks". Ticks are units of 6 seconds that are used to rep ### [string][string] `To String` : Same as **Ticks** - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-time.md b/reference/data-types/datatype-time.md index 4638e5726..0f9072454 100644 --- a/reference/data-types/datatype-time.md +++ b/reference/data-types/datatype-time.md @@ -3,11 +3,11 @@ tags: - datatype --- # `time` Type - +<!--dt-desc-start--> Represents a unit of clock time. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='string', name='Date') }} : Date in the format MM/DD/YYYY @@ -75,9 +75,10 @@ Represents a unit of clock time. ### [string][string] `(To String)` : Same as **Time24** - - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md [int64]: datatype-int64.md -[string]: datatype-string.md \ No newline at end of file +[string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-timer.md b/reference/data-types/datatype-timer.md index e4ba2f639..aa81f4a89 100644 --- a/reference/data-types/datatype-timer.md +++ b/reference/data-types/datatype-timer.md @@ -4,10 +4,11 @@ tags: --- # `timer` +<!--dt-desc-start--> A timer data type is set in tenths of one second and counts down to zero; starting immediately after being set. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='OriginalValue') }} : Original value of the timer @@ -19,6 +20,7 @@ A timer data type is set in tenths of one second and counts down to zero; starti ### [string][string] `To String` : Same as **Value** +<!--dt-members-end--> ## Methods @@ -68,7 +70,7 @@ sub main ``` This would loop while myTimer is above 0 - +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [achievementobj]: datatype-achievementobj.md @@ -113,3 +115,4 @@ This would loop while myTimer is above 0 [deity]: datatype-deity.md [race]: datatype-race.md [taskmember]: datatype-task.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-timestamp.md b/reference/data-types/datatype-timestamp.md index 5cf5d73a0..31f145ada 100644 --- a/reference/data-types/datatype-timestamp.md +++ b/reference/data-types/datatype-timestamp.md @@ -4,10 +4,11 @@ tags: --- # `timestamp` +<!--dt-desc-start--> A timestamp represented in milliseconds. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Days') }} : Number of days remaining in the timestamp (3d 2h 23m will return 3) @@ -60,12 +61,14 @@ A timestamp represented in milliseconds. : Same as **Raw** +<!--dt-members-end--> ### Changelog * July 9th, 2021: Added Days, TimeDHM - +<!--dt-linkrefs-start--> [float]: datatype-float.md [int]: datatype-int.md [int64]: datatype-int64.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-tradeskilldepot.md b/reference/data-types/datatype-tradeskilldepot.md index 727688438..f22309c86 100644 --- a/reference/data-types/datatype-tradeskilldepot.md +++ b/reference/data-types/datatype-tradeskilldepot.md @@ -4,10 +4,11 @@ tags: --- # `tradeskilldepot` +<!--dt-desc-start--> This contains information related to a tradeskill depot. - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='Capacity') }} : Returns the total capacity of the tradeskill depot. @@ -43,7 +44,7 @@ This contains information related to a tradeskill depot. ### {{ renderMember(type='item', name='SelectedItem') }} : Returns the currently selected item in the tradeskill depot window. - +<!--dt-members-end--> ## Methods @@ -55,7 +56,8 @@ This contains information related to a tradeskill depot. | **WithdrawItem**[_name_] | Withdraw the given item name from the tradeskill depot. Will create a quantity window if there is more than one item in the stack. | | **WithdrawStack** | Withdraw a full stack of the selected item from the tradeskill depot. | | **WithdrawStack**[_name_] | Withdraw a full stack of the given item name from the tradeskill depot. | - +<!--dt-linkrefs-start--> [int]: datatype-int.md [bool]: datatype-bool.md [item]: datatype-item.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-type.md b/reference/data-types/datatype-type.md index e750e2fa8..097007153 100644 --- a/reference/data-types/datatype-type.md +++ b/reference/data-types/datatype-type.md @@ -4,10 +4,11 @@ tags: --- # `type` +<!--dt-desc-start--> Contains information about data types - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='InheritedType') }} : Type of inherited type, if applicable. @@ -30,6 +31,8 @@ Contains information about data types : Same as **Name** - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-window.md b/reference/data-types/datatype-window.md index ffc78f0c7..dcc59aa10 100644 --- a/reference/data-types/datatype-window.md +++ b/reference/data-types/datatype-window.md @@ -4,13 +4,13 @@ tags: --- # `window` +<!--dt-desc-start--> This contains data related to the specified in-game window Windows come in many forms, but all are represented with the generic **window** type. In some of the descriptions, a **bold** window type may be specified, which defines the behavior for that type of window. - +<!--dt-desc-end--> ## Members - - +<!--dt-members-start--> ### {{ renderMember(type='argb', name='BGColor') }} : Background color of the window. @@ -306,7 +306,7 @@ Windows come in many forms, but all are represented with the generic **window** ### [string][string] To String : `TRUE` if the window is open, `FALSE` if not, matching [Open](#bool-open) - +<!--dt-members-end--> ## Methods @@ -482,7 +482,7 @@ Return TRUE if I have clicked the Trade button in the Trade Window (TradeWnd) Returns the name of the 2nd option in the list of rewards for the tab titled "Brew for the Day" - +<!--dt-linkrefs-start--> [argb]: datatype-argb.md [bool]: datatype-bool.md [float]: datatype-float.md @@ -492,3 +492,4 @@ Returns the name of the 2nd option in the list of rewards for the tab titled "Br [invslotwindow]: datatype-invslotwindow.md [string]: datatype-string.md [window]: datatype-window.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-worldlocation.md b/reference/data-types/datatype-worldlocation.md index 49f4db703..e32dabac9 100644 --- a/reference/data-types/datatype-worldlocation.md +++ b/reference/data-types/datatype-worldlocation.md @@ -4,10 +4,11 @@ tags: --- # `worldlocation` +<!--dt-desc-start--> Provides access to world locations such as a character's bound location - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='heading', name='Heading') }} : At the point of binding, what direction was the character facing @@ -31,8 +32,10 @@ Provides access to world locations such as a character's bound location ### {{ renderMember(type='zone', name='Zone') }} : Access to the zone data - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [heading]: datatype-heading.md [int]: datatype-int.md [string]: datatype-string.md [zone]: datatype-zone.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-xtarget.md b/reference/data-types/datatype-xtarget.md index 701c20cdb..33694b464 100644 --- a/reference/data-types/datatype-xtarget.md +++ b/reference/data-types/datatype-xtarget.md @@ -4,10 +4,11 @@ tags: --- # `xtarget` +<!--dt-desc-start--> Contains the data related to your extended target list - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : ID of specified XTarget @@ -54,6 +55,8 @@ Contains the data related to your extended target list : Number of current extended targets - +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-zone.md b/reference/data-types/datatype-zone.md index 5f8dce2cb..2b45c38c1 100644 --- a/reference/data-types/datatype-zone.md +++ b/reference/data-types/datatype-zone.md @@ -4,10 +4,11 @@ tags: --- # `zone` +<!--dt-desc-start--> Contains information related to the specified zone - +<!--dt-desc-end--> ## Members - +<!--dt-members-start--> ### {{ renderMember(type='int', name='ID') }} : ID of the zone @@ -28,6 +29,9 @@ Contains information related to the specified zone : Same as **Name** +<!--dt-members-end--> +<!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md [int64]: datatype-int64.md +<!--dt-linkrefs-end--> From 9fd059d94db93a2033e80a2256e657c7019867c0 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 10 May 2025 18:14:18 -0500 Subject: [PATCH 16/41] include-markdown markup for tlos --- .../top-level-objects/tlo-achievement.md | 11 ++++--- reference/top-level-objects/tlo-advloot.md | 8 ++--- reference/top-level-objects/tlo-alert.md | 10 +++--- reference/top-level-objects/tlo-alias.md | 13 ++++---- reference/top-level-objects/tlo-altability.md | 10 +++--- reference/top-level-objects/tlo-bool.md | 12 ++++--- reference/top-level-objects/tlo-corpse.md | 10 +++--- reference/top-level-objects/tlo-cursor.md | 10 +++--- reference/top-level-objects/tlo-defined.md | 10 +++--- .../top-level-objects/tlo-displayitem.md | 9 +++-- reference/top-level-objects/tlo-doortarget.md | 10 +++--- .../top-level-objects/tlo-dynamiczone.md | 11 ++++--- reference/top-level-objects/tlo-everquest.md | 10 +++--- reference/top-level-objects/tlo-familiar.md | 9 +++-- reference/top-level-objects/tlo-finditem.md | 10 +++--- .../top-level-objects/tlo-finditembank.md | 10 +++--- .../tlo-finditembankcount.md | 10 +++--- .../top-level-objects/tlo-finditemcount.md | 12 ++++--- reference/top-level-objects/tlo-float.md | 9 +++-- .../top-level-objects/tlo-framelimiter.md | 33 ++++++++++++++++--- reference/top-level-objects/tlo-friends.md | 10 +++--- reference/top-level-objects/tlo-gametime.md | 9 +++-- reference/top-level-objects/tlo-ground.md | 10 +++--- .../top-level-objects/tlo-grounditemcount.md | 9 +++-- reference/top-level-objects/tlo-group.md | 9 +++-- reference/top-level-objects/tlo-heading.md | 13 ++++---- reference/top-level-objects/tlo-if.md | 11 ++++--- reference/top-level-objects/tlo-illusion.md | 9 +++-- reference/top-level-objects/tlo-ini.md | 11 ++++--- reference/top-level-objects/tlo-int.md | 9 +++-- reference/top-level-objects/tlo-inventory.md | 9 +++-- reference/top-level-objects/tlo-invslot.md | 10 +++--- reference/top-level-objects/tlo-itemtarget.md | 10 +++--- reference/top-level-objects/tlo-lastspawn.md | 10 +++--- .../top-level-objects/tlo-lineofsight.md | 10 +++--- reference/top-level-objects/tlo-macro.md | 9 +++-- reference/top-level-objects/tlo-macroquest.md | 10 +++--- reference/top-level-objects/tlo-math.md | 11 ++++--- reference/top-level-objects/tlo-me.md | 10 +++--- reference/top-level-objects/tlo-mercenary.md | 12 ++++--- reference/top-level-objects/tlo-merchant.md | 12 ++++--- reference/top-level-objects/tlo-mount.md | 10 +++--- .../top-level-objects/tlo-nearestspawn.md | 10 +++--- reference/top-level-objects/tlo-pet.md | 13 ++++---- reference/top-level-objects/tlo-plugin.md | 10 +++--- reference/top-level-objects/tlo-raid.md | 12 ++++--- reference/top-level-objects/tlo-range.md | 12 ++++--- reference/top-level-objects/tlo-select.md | 9 +++-- .../top-level-objects/tlo-selecteditem.md | 9 +++-- reference/top-level-objects/tlo-skill.md | 10 +++--- reference/top-level-objects/tlo-social.md | 13 +++++--- reference/top-level-objects/tlo-spawn.md | 10 +++--- reference/top-level-objects/tlo-spawncount.md | 10 +++--- reference/top-level-objects/tlo-spell.md | 10 +++--- reference/top-level-objects/tlo-switch.md | 10 +++--- reference/top-level-objects/tlo-target.md | 12 ++++--- reference/top-level-objects/tlo-task.md | 10 +++--- reference/top-level-objects/tlo-time.md | 10 +++--- .../top-level-objects/tlo-tradeskilldepot.md | 9 +++-- reference/top-level-objects/tlo-type.md | 10 +++--- reference/top-level-objects/tlo-window.md | 9 +++-- reference/top-level-objects/tlo-zone.md | 10 +++--- 62 files changed, 407 insertions(+), 251 deletions(-) diff --git a/reference/top-level-objects/tlo-achievement.md b/reference/top-level-objects/tlo-achievement.md index ed36693fe..c2c91cc70 100644 --- a/reference/top-level-objects/tlo-achievement.md +++ b/reference/top-level-objects/tlo-achievement.md @@ -4,10 +4,11 @@ tags: --- # `Achievement` +<!--tlo-desc-start--> Provides access to achievements. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='achievement', name='Achievement', params='#|Name') }} : Look up an achievement by name or by id. @@ -15,7 +16,7 @@ Provides access to achievements. ### {{ renderMember(type='achievementmgr', name='Achievement') }} : Access the achievement manager which provides access to information about achievements - +<!--tlo-forms-end--> ## Associated DataTypes @@ -112,9 +113,9 @@ To look up an achievement's ID, you can look up an achievement by name, or you c -- "Wayfarers Brotherhood Adventurer's Stone (Various 20+)" print(mq.TLO.Achievement(500980300).Completed()) ``` - +<!--tlo-linkrefs-start--> [int]: ../data-types/datatype-int.md [bool]: ../data-types/datatype-bool.md [achievement]: ../data-types/datatype-achievement.md [achievementcat]: ../data-types/datatype-achievementcat.md -[achievementmgr]: #achievementmgr-type +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-advloot.md b/reference/top-level-objects/tlo-advloot.md index 45d58c4f1..b3c3c2452 100644 --- a/reference/top-level-objects/tlo-advloot.md +++ b/reference/top-level-objects/tlo-advloot.md @@ -4,10 +4,10 @@ tags: --- # `AdvLoot` +<!--tlo-desc-start--> The AdvLoot TLO grants access to items in the Advanced Loot window. - +<!--tlo-desc-end--> ## Members - ### {{ renderMember(type='itemfilterdata', name='Filter', params='ItemID') }} : Inspect the loot filter for a given ItemID. @@ -40,7 +40,6 @@ The AdvLoot TLO grants access to items in the Advanced Loot window. : Want count from the Shared list (AN + AG + ND + GD) - ## datatype `advlootitem` Represents a discrete item being looted in an AdvLoot window. @@ -220,7 +219,7 @@ A collection of settings that together describe the loot filter for an item. print('Do something else, loot is already in progress...') end ``` - +<!--tlo-linkrefs-start--> [int]: ../data-types/datatype-int.md [string]: ../data-types/datatype-string.md [bool]: ../data-types/datatype-bool.md @@ -228,3 +227,4 @@ A collection of settings that together describe the loot filter for an item. [spawn]: ../data-types/datatype-spawn.md [itemfilterdata]: #datatype-itemfilterdata [advlootitem]: #datatype-advlootitem +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-alert.md b/reference/top-level-objects/tlo-alert.md index 4b61a19ba..434b63c11 100644 --- a/reference/top-level-objects/tlo-alert.md +++ b/reference/top-level-objects/tlo-alert.md @@ -4,16 +4,17 @@ tags: --- # `Alert` +<!--tlo-desc-start--> Provides access to spawn search filter criteria in alerts. Alerts are created using [/alert](../../reference/commands/alert.md). - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='alert', name='Alert', params='ID') }} : Retrieve information for the alert category by its id | [string][string] | **Alert** | Returns pipe `|` separated list of alert ids | - +<!--tlo-forms-end--> ## datatype `alert` @@ -307,7 +308,7 @@ See Also: [Spawn Search](../general/spawn-search.md). -- Will output the number of alerts in list 1 print(mq.TLO.Alert(1).Size()) ``` - +<!--tlo-linkrefs-start--> [alert]: #datatype-alert [alertlist]: #datatype-alertlist [bool]: ../data-types/datatype-bool.md @@ -317,3 +318,4 @@ See Also: [Spawn Search](../general/spawn-search.md). [int64]: ../data-types/datatype-int64.md [spawn]: ../data-types/datatype-spawn.md [string]: ../data-types/datatype-string.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-alias.md b/reference/top-level-objects/tlo-alias.md index 0d7ef8fcb..669eb5399 100644 --- a/reference/top-level-objects/tlo-alias.md +++ b/reference/top-level-objects/tlo-alias.md @@ -4,15 +4,15 @@ tags: --- # `Alias` +<!--tlo-desc-start--> Provides a way to query whether a given alias exists. See [/alias](../commands/alias.md). - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='bool', name='Alias', params='Name') }} : Returns bool indicating if named aliase exists - - +<!--tlo-forms-end--> ## Usage @@ -29,5 +29,6 @@ Provides a way to query whether a given alias exists. See [/alias](../commands/a -- prints true if the /yes alias exists print(mq.TLO.Alias('/yes')()) ``` - -[bool]: ../data-types/datatype-bool.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[bool]: ../data-types/datatype-bool.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-altability.md b/reference/top-level-objects/tlo-altability.md index 114ffd6aa..bfef96ea6 100644 --- a/reference/top-level-objects/tlo-altability.md +++ b/reference/top-level-objects/tlo-altability.md @@ -4,14 +4,15 @@ tags: --- # `AltAbility` +<!--tlo-desc-start--> !!! danger This AltAbility TLO is for accessing the full database of alternate abilities. If you want to access alternate abilities associated with your character, use `Me.AltAbility` instead. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='altability', name='AltAbility', params='Number') }} : Look up an AltAbility by its altability id. @@ -19,7 +20,7 @@ tags: ### {{ renderMember(type='altability', name='AltAbility', params='Name') }} : Look up an AltAbility by its name. - +<!--tlo-forms-end--> ## Usage @@ -36,5 +37,6 @@ tags: -- Prints the pre-requisite AA ability needed to train Combat Stability print(mq.TLO.AltAbility('Combat Stability').RequiresAbility()) ``` - +<!--tlo-linkrefs-start--> [altability]: ../data-types/datatype-altability.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-bool.md b/reference/top-level-objects/tlo-bool.md index 1a3b989e4..d489a9382 100644 --- a/reference/top-level-objects/tlo-bool.md +++ b/reference/top-level-objects/tlo-bool.md @@ -4,6 +4,7 @@ tags: --- # `Bool` +<!--tlo-desc-start--> Creates a bool object from a string. The resulting value is a _bool_ depending on whether the given string is falsey or not. "Falsey" is defined as any of the following values: @@ -14,13 +15,13 @@ Creates a bool object from a string. The resulting value is a _bool_ depending o * The string "0" If the string is one of these values, the resulting bool is `false`. Otherwise, it is `true`. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='bool', name='Bool', params='Text') }} : Converts the given _Text_ to a bool based on the rules presented above. - +<!--tlo-forms-end--> ## Usage @@ -52,5 +53,6 @@ If the string is one of these values, the resulting bool is `false`. Otherwise, myVar = mq.TLO.Bool('NULL')() print(myVar) ``` - -[bool]: ../data-types/datatype-bool.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[bool]: ../data-types/datatype-bool.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-corpse.md b/reference/top-level-objects/tlo-corpse.md index 65e5cc07c..d6752c9a8 100644 --- a/reference/top-level-objects/tlo-corpse.md +++ b/reference/top-level-objects/tlo-corpse.md @@ -4,14 +4,15 @@ tags: --- # `Corpse` +<!--tlo-desc-start--> Access to objects of type corpse, which is the currently active corpse (ie. the one you are looting). - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='corpse', name='Corpse') }} : Corpse you are looting. - +<!--tlo-forms-end--> ## Usage @@ -20,5 +21,6 @@ Access to objects of type corpse, which is the currently active corpse (ie. the /echo Corpse is open, proceeding with looting } ``` - +<!--tlo-linkrefs-start--> [corpse]: ../data-types/datatype-corpse.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-cursor.md b/reference/top-level-objects/tlo-cursor.md index c2b373c14..3db69bbd4 100644 --- a/reference/top-level-objects/tlo-cursor.md +++ b/reference/top-level-objects/tlo-cursor.md @@ -4,14 +4,15 @@ tags: --- # `Cursor` +<!--tlo-desc-start--> Creates an object which references the item on your cursor. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='item', name='Cursor') }} : Access the item on the cursor - +<!--tlo-forms-end--> ## Usage @@ -22,5 +23,6 @@ Creates an object which references the item on your cursor. ``` /if (${Cursor.ID}) /autoinventory ``` - +<!--tlo-linkrefs-start--> [item]: ../data-types/datatype-item.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-defined.md b/reference/top-level-objects/tlo-defined.md index 6f0391254..f166d05cb 100644 --- a/reference/top-level-objects/tlo-defined.md +++ b/reference/top-level-objects/tlo-defined.md @@ -4,14 +4,15 @@ tags: --- # `Defined` +<!--tlo-desc-start--> Determines whether a variable, array, or timer with this name exists. The variable, array or timer must not be enclosed with ${}. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='bool', name='Defined', params='Name') }} : Returns true if the given variable _name_ is defined. - +<!--tlo-forms-end--> ## Usage @@ -20,5 +21,6 @@ Determines whether a variable, array, or timer with this name exists. The variab /echo ${varname} } ``` - +<!--tlo-linkrefs-start--> [bool]: ../data-types/datatype-bool.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-displayitem.md b/reference/top-level-objects/tlo-displayitem.md index a071e529f..4ad09852b 100644 --- a/reference/top-level-objects/tlo-displayitem.md +++ b/reference/top-level-objects/tlo-displayitem.md @@ -4,10 +4,13 @@ tags: --- # `DisplayItem` +<!--tlo-desc-start--> This TLO gives you access to all the information in the Item Display window. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='item', name='DisplayItem') }} - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [item]: ../data-types/datatype-item.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-doortarget.md b/reference/top-level-objects/tlo-doortarget.md index fb4e6febd..34677cad7 100644 --- a/reference/top-level-objects/tlo-doortarget.md +++ b/reference/top-level-objects/tlo-doortarget.md @@ -4,14 +4,15 @@ tags: --- # `DoorTarget` +<!--tlo-desc-start--> Object used to return information on your doortarget. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='switch', name='DoorTarget')}} : Returns the currently targeted door/switch - +<!--tlo-forms-end--> ## Usage @@ -20,5 +21,6 @@ Object used to return information on your doortarget. ``` Returns the ID of your door target. - +<!--tlo-linkrefs-start--> [switch]: ../data-types/datatype-switch.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-dynamiczone.md b/reference/top-level-objects/tlo-dynamiczone.md index c245b1357..e147ef153 100644 --- a/reference/top-level-objects/tlo-dynamiczone.md +++ b/reference/top-level-objects/tlo-dynamiczone.md @@ -4,15 +4,15 @@ tags: --- # `DynamicZone` +<!--tlo-desc-start--> Provides access to properties of the current dynamic (instanced) zone. - - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='dynamiczone', name='DynamicZone') }} : Gives access to the information about the current dynamic zone. - +<!--tlo-forms-end--> ## Usage @@ -24,5 +24,6 @@ Provides access to properties of the current dynamic (instanced) zone. /echo ${DynamicZone.Name} ``` - +<!--tlo-linkrefs-start--> [dynamiczone]: ../data-types/datatype-dynamiczone.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-everquest.md b/reference/top-level-objects/tlo-everquest.md index 3c35ad86e..d859889eb 100644 --- a/reference/top-level-objects/tlo-everquest.md +++ b/reference/top-level-objects/tlo-everquest.md @@ -4,15 +4,17 @@ tags: --- # `EverQuest` +<!--tlo-desc-start--> Provides access to general information about the game and its state. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='everquest', name='everquest') }} - +<!--tlo-forms-end--> ## Usage See [EverQuest] for examples. - +<!--tlo-linkrefs-start--> [everquest]: ../data-types/datatype-everquest.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-familiar.md b/reference/top-level-objects/tlo-familiar.md index 01a5ce601..9d61ee73a 100644 --- a/reference/top-level-objects/tlo-familiar.md +++ b/reference/top-level-objects/tlo-familiar.md @@ -4,10 +4,11 @@ tags: --- # `Familiar` +<!--tlo-desc-start--> Used to get information about items on your familiars keyring. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='keyring', name='Familiar') }} : Access to the familiar keyring. @@ -19,10 +20,12 @@ Used to get information about items on your familiars keyring. ### {{ renderMember(type='keyringitem', name='Familiar', params='Name') }} : Retrieve the item in your familiar keyring by name. A `=` can be prepended for an exact match. +<!--tlo-forms-end--> ## Examples See Also: [keyring][keyring] and [keyringitem][keyringitem] - +<!--tlo-linkrefs-start--> [keyring]: ../data-types/datatype-keyring.md [keyringitem]: ../data-types/datatype-keyringitem.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-finditem.md b/reference/top-level-objects/tlo-finditem.md index fa2d5a710..fbba06d6b 100644 --- a/reference/top-level-objects/tlo-finditem.md +++ b/reference/top-level-objects/tlo-finditem.md @@ -4,10 +4,11 @@ tags: --- # `FindItem` +<!--tlo-desc-start--> A TLO used to find an item on your character, corpse, or a merchant by partial or exact name match. _See examples below._ - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='item', name='FindItem', params='name|id') }} : Search for an item using the given item id, or partial name match. Will search character @@ -50,6 +51,7 @@ A TLO used to find an item on your character, corpse, or a merchant by partial o ```lua print(mq.TLO.FindItem("=Water Sprinkler of Nem Ankh").ID()) ``` - - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [item]: ../data-types/datatype-item.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-finditembank.md b/reference/top-level-objects/tlo-finditembank.md index bfafe1b5f..9b62afbb5 100644 --- a/reference/top-level-objects/tlo-finditembank.md +++ b/reference/top-level-objects/tlo-finditembank.md @@ -4,12 +4,13 @@ tags: --- # `FindItemBank` +<!--tlo-desc-start--> A TLO used to find an item in your bank by partial or exact name match. _See examples below._ Of note: The FindItemBank with ItemSlot REQUIRES that bank item containers be open to function correctly. Due to potential exploits the command will not work if the bank containers are closed. This is in contrast to FindItem functionality with character containers, where ItemSlot was designed to allow inventory management without opening containers. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='item', name='FindItemBank', params='name|id') }} : Search for an item in your bank using the given item id, or partial name match. @@ -50,6 +51,7 @@ Of note: The FindItemBank with ItemSlot REQUIRES that bank item containers be op ```lua print(mq.TLO.FindItemBank("=Water Sprinkler of Nem Ankh").ID()) ``` - - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [item]: ../data-types/datatype-item.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-finditembankcount.md b/reference/top-level-objects/tlo-finditembankcount.md index e70531832..6f1e2118c 100644 --- a/reference/top-level-objects/tlo-finditembankcount.md +++ b/reference/top-level-objects/tlo-finditembankcount.md @@ -4,10 +4,11 @@ tags: --- # `FindItemBankCount` +<!--tlo-desc-start--> A TLO used to find a count of items in your bank by partial or exact name match. _See examples below._ - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='int', name='FindItemBankCount', params='name|id') }} : Counts the items in your bank using the given item id, or partial name match. @@ -48,6 +49,7 @@ A TLO used to find a count of items in your bank by partial or exact name match. ```lua print(mq.TLO.FindItemBankCount("=Swirling Shadows")) ``` - - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [int]: ../data-types/datatype-int.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-finditemcount.md b/reference/top-level-objects/tlo-finditemcount.md index 493faf8cf..57555d22c 100644 --- a/reference/top-level-objects/tlo-finditemcount.md +++ b/reference/top-level-objects/tlo-finditemcount.md @@ -4,10 +4,11 @@ tags: --- # `FindItemCount` +<!--tlo-desc-start--> A TLO used to find a count of items on your character, corpse, or a merchant by partial or exact name match. _See examples below._ - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='int', name='FindItemCount', params='name|id') }} : Counts the items using the given item id, or partial name match. Will search character @@ -50,6 +51,7 @@ A TLO used to find a count of items on your character, corpse, or a merchant by ```lua print(mq.TLO.FindItemCount("=Water Flask")) ``` - - -[int]: ../data-types/datatype-int.md \ No newline at end of file +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> +[int]: ../data-types/datatype-int.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-float.md b/reference/top-level-objects/tlo-float.md index a01c6a7ca..edb5f118f 100644 --- a/reference/top-level-objects/tlo-float.md +++ b/reference/top-level-objects/tlo-float.md @@ -4,13 +4,15 @@ tags: --- # `Float` +<!--tlo-desc-start--> Creates a float object from n. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='float', name='Float', params='n') }} : Returns a float with value _n_. +<!--tlo-forms-end--> ## Usage @@ -19,5 +21,6 @@ Creates a float object from n. ``` Creates a float object of 12.345 and truncates the decimal to one decimal place. - +<!--tlo-linkrefs-start--> [float]: ../data-types/datatype-float.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-framelimiter.md b/reference/top-level-objects/tlo-framelimiter.md index 7baea6fab..b60874331 100644 --- a/reference/top-level-objects/tlo-framelimiter.md +++ b/reference/top-level-objects/tlo-framelimiter.md @@ -1,21 +1,42 @@ --- tags: - - tlo + - tlo --- # `FrameLimiter` +<!--tlo-desc-start--> The FrameLimiter TLO provides access to the [frame limiter](../../main/features/framelimiter.md) feature. +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='framelimiter', name='FrameLimiter') }} : The frame limiter object - +<!--tlo-forms-end--> ## Associated DataTypes -{{ embedMQType('reference/data-types/datatype-framelimiter.md') }} +## [framelimiter](../data-types/datatype-framelimiter.md) +{% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-framelimiter.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-members-start -->" + end="<!--dt-members-end -->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} ## Usage @@ -25,7 +46,9 @@ Indicates that the frame limiter is enabled: /echo ${FrameLimiter.Enabled} ``` +<!--tlo-linkrefs-start--> [bool]: ../data-types/datatype-bool.md [string]: ../data-types/datatype-string.md [float]: ../data-types/datatype-float.md -[framelimiter]: ../data-types/datatype-framelimiter.md \ No newline at end of file +[framelimiter]: ../data-types/datatype-framelimiter.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-friends.md b/reference/top-level-objects/tlo-friends.md index d4d48ff76..50094e134 100644 --- a/reference/top-level-objects/tlo-friends.md +++ b/reference/top-level-objects/tlo-friends.md @@ -4,14 +4,15 @@ tags: --- # `Friends` +<!--tlo-desc-start--> Grants access to your friends dlist. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='friends', name='Friends') }} : Access friends data - +<!--tlo-forms-end--> ## datatype `friends` @@ -52,7 +53,8 @@ Grants access to your friends dlist. -- Echo the name of your firsrt friend print(mq.TLO.Friends.Friend(1)()) ``` - +<!--tlo-linkrefs-start--> [string]: ../data-types/datatype-string.md [bool]: ../data-types/datatype-bool.md [friends]: #datatype-friends +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-gametime.md b/reference/top-level-objects/tlo-gametime.md index d23b29293..a51dc85eb 100644 --- a/reference/top-level-objects/tlo-gametime.md +++ b/reference/top-level-objects/tlo-gametime.md @@ -4,13 +4,15 @@ tags: --- # `GameTime` +<!--tlo-desc-start--> A time object indicating EQ Game Time. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='time', name='GameTime') }} : Access the current in-game time +<!--tlo-forms-end--> ## Usage @@ -19,5 +21,6 @@ A time object indicating EQ Game Time. ``` Echos todays in-game date to the chat window. - +<!--tlo-linkrefs-start--> [time]: ../data-types/datatype-time.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-ground.md b/reference/top-level-objects/tlo-ground.md index ed1d6e537..59da41655 100644 --- a/reference/top-level-objects/tlo-ground.md +++ b/reference/top-level-objects/tlo-ground.md @@ -4,14 +4,15 @@ tags: --- # `Ground` +<!--tlo-desc-start--> Object which references the ground spawn item you have targeted. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='ground', name='Ground') }} : Access currently targeted ground item. - +<!--tlo-forms-end--> ## Usage @@ -20,5 +21,6 @@ Object which references the ground spawn item you have targeted. ``` Echos the distance to the ground item you have targeted. - +<!--tlo-linkrefs-start--> [ground]: ../data-types/datatype-ground.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-grounditemcount.md b/reference/top-level-objects/tlo-grounditemcount.md index fa328e61b..3f4839bd1 100644 --- a/reference/top-level-objects/tlo-grounditemcount.md +++ b/reference/top-level-objects/tlo-grounditemcount.md @@ -4,13 +4,15 @@ tags: --- # `GroundItemCount` +<!--tlo-desc-start--> Access to all Groundspawn item count information. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='int', name='GroundItemCount') }} : Retrieve the count of items on the ground +<!--tlo-forms-end--> ## Usage @@ -25,5 +27,6 @@ Output: There are 5 Apples on the ground ``` Output: There are 12 items on the ground in this zone. - +<!--tlo-linkrefs-start--> [int]: ../data-types/datatype-int.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-group.md b/reference/top-level-objects/tlo-group.md index 2f9fe39f8..74c583e52 100644 --- a/reference/top-level-objects/tlo-group.md +++ b/reference/top-level-objects/tlo-group.md @@ -4,13 +4,15 @@ tags: --- # `Group` +<!--tlo-desc-start--> Access to all group-related information. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='group', name='Group') }} : Retrieve information about your group +<!--tlo-forms-end--> ## Usage @@ -31,5 +33,6 @@ Echos your own name ``` Echos the next person on the list, after yourself. - +<!--tlo-linkrefs-start--> [group]: ../data-types/datatype-group.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-heading.md b/reference/top-level-objects/tlo-heading.md index aa2e51980..ef567033a 100644 --- a/reference/top-level-objects/tlo-heading.md +++ b/reference/top-level-objects/tlo-heading.md @@ -4,10 +4,11 @@ tags: --- # `Heading` +<!--tlo-desc-start--> Object that refers to the directional heading to of a location or direction. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='heading', name='Heading', params='#') }} : Creates a heading object using degrees (clockwise) @@ -19,7 +20,7 @@ Object that refers to the directional heading to of a location or direction. ### {{ renderMember(type='heading', name='Heading', params='N,W') }} : Same as above, just an alternate method - +<!--tlo-forms-end--> ## Usage @@ -34,6 +35,6 @@ Echos the shortname of the heading of 15 degrees. ``` Echos the shortname heading to the location -342,700 - - -[heading]: ../data-types/datatype-heading.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[heading]: ../data-types/datatype-heading.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-if.md b/reference/top-level-objects/tlo-if.md index 8a582123c..448855c72 100644 --- a/reference/top-level-objects/tlo-if.md +++ b/reference/top-level-objects/tlo-if.md @@ -4,16 +4,15 @@ tags: --- # `If` - !!! warning The `If` TLO is used to provide inline condition expressions for macros. It is not intended for use with Lua. - +<!--tlo-desc-start--> Executes an inline condiition, similar to a ternary expression in other languages. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='string', name='If', params='conditions,whentrue,whenfalse', toc_label='If') }} : Performs [Math.Calc][Math.Calc] on `conditions`, gives `whentrue` if non-zero, gives `whenfalse` if zero. @@ -29,6 +28,8 @@ Executes an inline condiition, similar to a ternary expression in other language ### [string][string] `If[conditions~whentrue~whenfalse]` { #if_alternate data-toc-label="If - Alternate Syntax" } : Alternate syntax, behaves the same as above but uses the \~ character as a separator instead of a comma. - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [string]: ../data-types/datatype-string.md [Math.Calc]: ../data-types/datatype-math.md#Calc[n] +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-illusion.md b/reference/top-level-objects/tlo-illusion.md index 13863e92e..86d59b066 100644 --- a/reference/top-level-objects/tlo-illusion.md +++ b/reference/top-level-objects/tlo-illusion.md @@ -4,10 +4,11 @@ tags: --- # `Illusion` +<!--tlo-desc-start--> Used to get information about items on your illusions keyring. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='keyring', name='Illusion') }} : Access to the illusion keyring. @@ -19,10 +20,12 @@ Used to get information about items on your illusions keyring. ### {{ renderMember(type='keyringitem', name='Illusion', params='Name') }} : Retrieve the item in your illusion keyring by name. A `=` can be prepended for an exact match. +<!--tlo-forms-end--> ## Usage See Also: [DataType:keyring](../data-types/datatype-keyring.md) and [DataType:keyringitem](../data-types/datatype-keyring.md) - +<!--tlo-linkrefs-start--> [keyring]: ../data-types/datatype-keyring.md [keyringitem]: ../data-types/datatype-keyringitem.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-ini.md b/reference/top-level-objects/tlo-ini.md index 7d2016a14..aa6541e00 100644 --- a/reference/top-level-objects/tlo-ini.md +++ b/reference/top-level-objects/tlo-ini.md @@ -4,10 +4,11 @@ tags: --- # `Ini` +<!--tlo-desc-start--> Reads value(s) from an ini file located in a relative or absolute path. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='string', name='Ini', params='filename,section,key,default') }} : The _section_, _key_, and _default_ do not need to be given. If _section_ or _key_ are not given, multiple values are read. @@ -22,6 +23,7 @@ Reads value(s) from an ini file located in a relative or absolute path. : When passed with no parameters to Ini[] the more robust form of the Ini TLO is used. See below and the reference to the [Key](../data-types/datatype-inifilesectionkey.md) datatype for further usage. +<!--tlo-forms-end--> ## Usage @@ -97,6 +99,7 @@ foobar > /echo ${Ini.File[sample].Section[SectionOne].Key.ValueAtIndex[2]} bar ``` - +<!--tlo-linkrefs-start--> [ini]: ../data-types/datatype-ini.md -[string]: ../data-types/datatype-string.md \ No newline at end of file +[string]: ../data-types/datatype-string.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-int.md b/reference/top-level-objects/tlo-int.md index 3cf9098b5..f1ab6ad74 100644 --- a/reference/top-level-objects/tlo-int.md +++ b/reference/top-level-objects/tlo-int.md @@ -4,13 +4,15 @@ tags: --- # `Int` +<!--tlo-desc-start--> Object that creates an integer from n. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='int', name='Int') }} : Parses whatever value for _n_ is provided and converts it into an [int]. +<!--tlo-forms-end--> ## Usage @@ -31,5 +33,6 @@ Echos a zero - useful if passing a string to a macro or subroutine that could be ``` Echos 123 - +<!--tlo-linkrefs-start--> [int]: ../data-types/datatype-int.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-inventory.md b/reference/top-level-objects/tlo-inventory.md index a71a7940a..674d84453 100644 --- a/reference/top-level-objects/tlo-inventory.md +++ b/reference/top-level-objects/tlo-inventory.md @@ -4,17 +4,20 @@ tags: --- # `Inventory` +<!--tlo-desc-start--> This is a hierarchical container for things relating to inventory (Bank, etc). It is not currently fully implemented and will be added onto. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='inventory', name='Inventory') }} : Your inventory. +<!--tlo-forms-end--> ## Usage See the datatype link for examples - +<!--tlo-linkrefs-start--> [inventory]: ../data-types/datatype-inventory.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-invslot.md b/reference/top-level-objects/tlo-invslot.md index 5ba66456e..ed74275ba 100644 --- a/reference/top-level-objects/tlo-invslot.md +++ b/reference/top-level-objects/tlo-invslot.md @@ -4,10 +4,11 @@ tags: --- # `InvSlot` +<!--tlo-desc-start--> Object used to get information on a specific inventory slot. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='invslot', name='InvSlot', params='N') }} : Inventory slot by index _N_. @@ -15,11 +16,12 @@ Object used to get information on a specific inventory slot. ### {{ renderMember(type='invslot', name='InvSlot', params='SlotName') }} : Inventory slot matching `SlotName`. - +<!--tlo-forms-end--> ## Usage See the datatype link for examples - +<!--tlo-linkrefs-start--> [invslot]: ../data-types/datatype-invslot.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-itemtarget.md b/reference/top-level-objects/tlo-itemtarget.md index 932bbab28..484f1548e 100644 --- a/reference/top-level-objects/tlo-itemtarget.md +++ b/reference/top-level-objects/tlo-itemtarget.md @@ -4,13 +4,15 @@ tags: --- # `ItemTarget` +<!--tlo-desc-start--> Gives access to the ground item that is previously targeted using [/itemtarget](../commands/itemtarget.md). - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='ground', name='ItemTarget') }} : Returns the current ground item target. - - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [ground]: ../data-types/datatype-ground.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-lastspawn.md b/reference/top-level-objects/tlo-lastspawn.md index 1ca60c47c..548ca4748 100644 --- a/reference/top-level-objects/tlo-lastspawn.md +++ b/reference/top-level-objects/tlo-lastspawn.md @@ -4,12 +4,13 @@ tags: --- # `LastSpawn` +<!--tlo-desc-start--> Information about the spawns that have occurred since you entered the zone. When you enter a zone you dont know the spawn order of anything already there, just anything that spawns while you are in the zone. The useful thing about `${LastSpawn[-1]}` is just being able to get the first spawn in the list which you might use in conjunction with other spawn members to go through the entire spawn list in a loop. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='spawn', name='LastSpawn', params='N') }} : The nth latest spawn (chronological order) @@ -17,7 +18,7 @@ The useful thing about `${LastSpawn[-1]}` is just being able to get the first sp ### {{ renderMember(type='spawn', name='LastSpawn', params='-N') }} : The nth oldest spawn (chronological order) - +<!--tlo-forms-end--> ## Usage @@ -32,5 +33,6 @@ Echos the spawnID of the 10th mob to spawn in the zone ``` Echos the name of the 10th to last spawn in the zone - +<!--tlo-linkrefs-start--> [spawn]: ../data-types/datatype-spawn.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-lineofsight.md b/reference/top-level-objects/tlo-lineofsight.md index 9c398dd05..c2a719a90 100644 --- a/reference/top-level-objects/tlo-lineofsight.md +++ b/reference/top-level-objects/tlo-lineofsight.md @@ -4,14 +4,15 @@ tags: --- # `LineOfSight` +<!--tlo-desc-start--> Object that is used to check if there is Line of Sight betwen two locations. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='bool', name='LineOfSight', params='y,x,z:y,x,z') }} : Check for line-of-sight between the two specified coordinates. - +<!--tlo-forms-end--> ## Usage @@ -20,5 +21,6 @@ Object that is used to check if there is Line of Sight betwen two locations. ``` Returns TRUE if Line of Sight is clear between the two locations - +<!--tlo-linkrefs-start--> [bool]: ../data-types/datatype-bool.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-macro.md b/reference/top-level-objects/tlo-macro.md index 181f9fdac..995975f4b 100644 --- a/reference/top-level-objects/tlo-macro.md +++ b/reference/top-level-objects/tlo-macro.md @@ -4,8 +4,11 @@ tags: --- # `Macro` +<!--tlo-desc-start--> +Information about the macro that's currently running. +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='macro', name='Macro') }} : Returns an object related to the macro that is currently running. @@ -15,5 +18,7 @@ tags: ``` /echo This macro has been running for: ${Macro.RunTime} seconds ``` - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [macro]: ../data-types/datatype-macro.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-macroquest.md b/reference/top-level-objects/tlo-macroquest.md index ccc096b5b..710a153d8 100644 --- a/reference/top-level-objects/tlo-macroquest.md +++ b/reference/top-level-objects/tlo-macroquest.md @@ -4,12 +4,13 @@ tags: --- # `MacroQuest` +<!--tlo-desc-start--> Creates an object related to MacroQuest information. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='macroquest', name='MacroQuest') }} - +<!--tlo-forms-end--> ## Usage @@ -19,5 +20,6 @@ Creates an object related to MacroQuest information. Returns the name of the last person that sent you a tell. - +<!--tlo-linkrefs-start--> [macroquest]: ../data-types/datatype-macroquest.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-math.md b/reference/top-level-objects/tlo-math.md index 50c487183..b0c941394 100644 --- a/reference/top-level-objects/tlo-math.md +++ b/reference/top-level-objects/tlo-math.md @@ -3,15 +3,15 @@ tags: - tlo --- # Math - +<!--tlo-desc-start--> Creates a Math object which gives allows access to the math type members. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='math', name='Math') }} : Returns the math object which is used to perform math operations. - +<!--tlo-forms-end--> ## Usage @@ -46,5 +46,6 @@ Math.Rand now takes an optional min argument so you can get a random number betw ``` this would return a randum number between 5 and 10. - +<!--tlo-linkrefs-start--> [math]: ../data-types/datatype-math.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-me.md b/reference/top-level-objects/tlo-me.md index 0771376dd..fcccf16bc 100644 --- a/reference/top-level-objects/tlo-me.md +++ b/reference/top-level-objects/tlo-me.md @@ -4,10 +4,11 @@ tags: --- # `Me` +<!--tlo-desc-start--> Character object which allows you to get properties of you as a character. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='character', name='Me') }} : Returns the character object which provides access to information about your own character. @@ -15,12 +16,13 @@ Character object which allows you to get properties of you as a character. ${Me} is a character object, so has access to all the properties of the [character](../data-types/datatype-character.md) type. The [character](../data-types/datatype-character.md) type also has access to the properties of the [spawn](../data-types/datatype-spawn.md) type. - +<!--tlo-forms-end--> ## Usage ``` /echo Current Mana: ${Me.PctMana}% ``` - +<!--tlo-linkrefs-start--> [character]: ../data-types/datatype-character.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-mercenary.md b/reference/top-level-objects/tlo-mercenary.md index ffd683857..340b5d41c 100644 --- a/reference/top-level-objects/tlo-mercenary.md +++ b/reference/top-level-objects/tlo-mercenary.md @@ -4,12 +4,13 @@ tags: --- # `Mercenary` +<!--tlo-desc-start--> Object used to get information about your mercenary. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='mercenary', name='Mercenary') }} - +<!--tlo-forms-end--> ## Usage @@ -24,5 +25,6 @@ Displays the current stance of the mercenary based on the type (Passive, Balance ``` Displays whether the mercenary is suspended or not. - -[mercenary]: ../data-types/datatype-mercenary.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[mercenary]: ../data-types/datatype-mercenary.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-merchant.md b/reference/top-level-objects/tlo-merchant.md index 2392b6bf9..aa77dd909 100644 --- a/reference/top-level-objects/tlo-merchant.md +++ b/reference/top-level-objects/tlo-merchant.md @@ -4,12 +4,13 @@ tags: --- # `Merchant` +<!--tlo-desc-start--> Object that interacts with the currently active merchant. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='merchant', name='Merchant') }} - +<!--tlo-forms-end--> ## Usage @@ -18,5 +19,6 @@ Object that interacts with the currently active merchant. ``` Echos the name of the currently open merchant. - -[merchant]: ../data-types/datatype-merchant.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[merchant]: ../data-types/datatype-merchant.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-mount.md b/reference/top-level-objects/tlo-mount.md index 55bb49440..bf7d1aae8 100644 --- a/reference/top-level-objects/tlo-mount.md +++ b/reference/top-level-objects/tlo-mount.md @@ -4,11 +4,11 @@ tags: --- # `Mount` +<!--tlo-desc-start--> Used to get information about items on your Mount keyring. - - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='keyring', name='Mount') }} : Access to the Mount keyring. @@ -20,6 +20,8 @@ Used to get information about items on your Mount keyring. ### {{ renderMember(type='keyringitem', name='Mount', params='Name') }} : Retrieve the item in your mount keyring by name. A `=` can be prepended for an exact match. - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [keyring]: ../data-types/datatype-keyring.md [keyringitem]: ../data-types/datatype-keyringitem.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-nearestspawn.md b/reference/top-level-objects/tlo-nearestspawn.md index 1e7f67674..c0eb13384 100644 --- a/reference/top-level-objects/tlo-nearestspawn.md +++ b/reference/top-level-objects/tlo-nearestspawn.md @@ -4,10 +4,11 @@ tags: --- # `NearestSpawn` +<!--tlo-desc-start--> Object that is used in finding spawns nearest to you. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='spawn', name='NearestSpawn', params='N') }} : The _Nth_ nearest spawn @@ -19,7 +20,7 @@ Object that is used in finding spawns nearest to you. ### {{ renderMember(type='spawn', name='NearestSpawn', params='N,Search') }} : The _Nth_ nearest spawn matching this search string (see [Spawn Search]). - +<!--tlo-forms-end--> ## Usage @@ -35,6 +36,7 @@ Finds the npc containing orc pawn in its name that is within 100 of you. Finds the closest spawn to you (`${NearestSpawn[1]}` will always match yourself). - +<!--tlo-linkrefs-start--> [spawn]: ../data-types/datatype-spawn.md [Spawn Search]: ../general/spawn-search.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-pet.md b/reference/top-level-objects/tlo-pet.md index a4653a7b2..2c619eacb 100644 --- a/reference/top-level-objects/tlo-pet.md +++ b/reference/top-level-objects/tlo-pet.md @@ -4,15 +4,16 @@ tags: --- # `Pet` +<!--tlo-desc-start--> Pet object which allows you to get properties of your pet. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='pet', name='Pet') }} : Provides access to your current Pet. The [pet](../data-types/datatype-pet.md) type extends from spawn, and as such has access to the properties of the [spawn](../data-types/datatype-spawn.md) type as well. - +<!--tlo-forms-end--> ## Usage @@ -27,6 +28,6 @@ Pet object which allows you to get properties of your pet. ``` /echo My Pet's Target has gone Berserk! ${Pet.Target.IsBerserk} ``` - - -[pet]: ../data-types/datatype-pet.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[pet]: ../data-types/datatype-pet.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-plugin.md b/reference/top-level-objects/tlo-plugin.md index 0e66c3642..df09e8340 100644 --- a/reference/top-level-objects/tlo-plugin.md +++ b/reference/top-level-objects/tlo-plugin.md @@ -4,10 +4,11 @@ tags: --- # `Plugin` +<!--tlo-desc-start--> Object that has access to members that provide information on a plugin. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='plugin', name='Plugin', params='Name') }} : Finds plugin by name, uses full name match, case insensitive. @@ -15,7 +16,7 @@ Object that has access to members that provide information on a plugin. ### {{ renderMember(type='plugin', name='Plugin', params='N') }} : Plugin by index, starting with 1 and stopping whenever the list runs out of plugins. - +<!--tlo-forms-end--> ## Usage @@ -50,5 +51,6 @@ To load a plugin if needed: } } ``` - +<!--tlo-linkrefs-start--> [plugin]: ../data-types/datatype-plugin.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-raid.md b/reference/top-level-objects/tlo-raid.md index 8434735fb..6d4bab716 100644 --- a/reference/top-level-objects/tlo-raid.md +++ b/reference/top-level-objects/tlo-raid.md @@ -4,12 +4,13 @@ tags: --- # `Raid` +<!--tlo-desc-start--> Object that has access to members that provide information on your raid. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='raid', name='Raid') }} - +<!--tlo-forms-end--> ## Usage @@ -19,5 +20,6 @@ Object that has access to members that provide information on your raid. Echos the number of members in your raid - -[raid]: ../data-types/datatype-raid.md \ No newline at end of file +<!--tlo-linkrefs-start--> +[raid]: ../data-types/datatype-raid.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-range.md b/reference/top-level-objects/tlo-range.md index 3858cdb9b..920b03dae 100644 --- a/reference/top-level-objects/tlo-range.md +++ b/reference/top-level-objects/tlo-range.md @@ -4,11 +4,13 @@ tags: --- # `Range` +<!--tlo-desc-start--> Test if _n_ is inside a range of 2 numbers or between 2 numbers - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='range', name='Range') }} - - -[range]: ../data-types/datatype-range.md \ No newline at end of file +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> +[range]: ../data-types/datatype-range.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-select.md b/reference/top-level-objects/tlo-select.md index a84c3d7c5..70f879149 100644 --- a/reference/top-level-objects/tlo-select.md +++ b/reference/top-level-objects/tlo-select.md @@ -4,13 +4,14 @@ tags: --- # `Select` +<!--tlo-desc-start--> Object used to determine if a match was made to argument in the given set of values. !!! warning Values must be single words. Quoted strings do not work, as the parser will drop the quotes and uses spaces as a delimiter. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='int', name='Select', params='argument,value1[,value2,...]') }} !!! example @@ -43,5 +44,7 @@ Object used to determine if a match was made to argument in the given set of val /echo Target is a healer } ``` - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [int]: ../data-types/datatype-int.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-selecteditem.md b/reference/top-level-objects/tlo-selecteditem.md index 35ec36aa4..1f2c34567 100644 --- a/reference/top-level-objects/tlo-selecteditem.md +++ b/reference/top-level-objects/tlo-selecteditem.md @@ -4,10 +4,11 @@ tags: --- # `SelectedItem` +<!--tlo-desc-start--> Used to return information on the object that is selected in your own inventory while using a merchant. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='item', name='SelectedItem') }} : !!! example @@ -47,5 +48,7 @@ Used to return information on the object that is selected in your own inventory end end ``` - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [item]: ../data-types/datatype-item.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-skill.md b/reference/top-level-objects/tlo-skill.md index 76576460d..18aa7b500 100644 --- a/reference/top-level-objects/tlo-skill.md +++ b/reference/top-level-objects/tlo-skill.md @@ -4,10 +4,11 @@ tags: --- # `Skill` +<!--tlo-desc-start--> Object used to get information on your character's skills. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='skill', name='Skill', params='name') }} : Retrieve skill by name @@ -15,7 +16,7 @@ Object used to get information on your character's skills. ### {{ renderMember(type='skill', name='Skill', params='N') }} : Retrieve skill by number - +<!--tlo-forms-end--> ## Usage @@ -31,5 +32,6 @@ Displays the reuse time of skill 1 Displays the skill number of the backstab skill - +<!--tlo-linkrefs-start--> [skill]: ../data-types/datatype-skill.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-social.md b/reference/top-level-objects/tlo-social.md index a36201069..d5603df1a 100644 --- a/reference/top-level-objects/tlo-social.md +++ b/reference/top-level-objects/tlo-social.md @@ -4,16 +4,17 @@ tags: --- # `Social` +<!--tlo-desc-start--> Access data about socials (in-game macro buttons) - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='social', name='Social', params='Index') }} : Look up a social by its button index. Each page as 12 socials, so index 13 would be the first social on the page 2. There are a total of 120 socials. - +<!--tlo-forms-end--> ## Usage @@ -31,4 +32,8 @@ Access data about socials (in-game macro buttons) ```lua print(mq.TLO.Social(3).Name()) - ``` \ No newline at end of file + ``` + +<!--tlo-linkrefs-start--> +[social]: ../data-types/datatype-social.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-spawn.md b/reference/top-level-objects/tlo-spawn.md index 907e5ad09..3c7329b33 100644 --- a/reference/top-level-objects/tlo-spawn.md +++ b/reference/top-level-objects/tlo-spawn.md @@ -4,10 +4,11 @@ tags: --- # `Spawn` +<!--tlo-desc-start--> Object used to get information on a specific spawn. Uses the filters under [Spawn Search]. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='spawn', name='Spawn', params='N') }} : Spawn matching ID _N_. @@ -15,7 +16,7 @@ Object used to get information on a specific spawn. Uses the filters under [Spaw ### {{ renderMember(type='spawn', name='Spawn', params='SearchString') }} : Any spawns matching `SearchString`. See [Spawn Search]. - +<!--tlo-forms-end--> ## Usage @@ -30,6 +31,7 @@ Displays the name of the spawn with id number 1000. ``` Targets the npc with the name Trakanon only if within a radius of 500. - +<!--tlo-linkrefs-start--> [spawn]: ../data-types/datatype-spawn.md [Spawn Search]: ../../reference/general/spawn-search.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-spawncount.md b/reference/top-level-objects/tlo-spawncount.md index f795deb2e..e4f967b83 100644 --- a/reference/top-level-objects/tlo-spawncount.md +++ b/reference/top-level-objects/tlo-spawncount.md @@ -4,10 +4,11 @@ tags: --- # `SpawnCount` +<!--tlo-desc-start--> Object used to count spawns based on a set of queries. Uses the filters under [Spawn Search]. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='int', name='SpawnCount') }} : Total number of spawns in current zone @@ -16,7 +17,7 @@ Object used to count spawns based on a set of queries. Uses the filters under [S ### {{ renderMember(type='int', name='SpawnCount', params='SearchString') }} : Total number of spawns in current zone matching the `SearchString`. See [Spawn Search]. - +<!--tlo-forms-end--> ## Usage @@ -38,6 +39,7 @@ Displays the count of all spawns in the level range of 45 to 50. Displays count of all NPCs within a radius of 100. - +<!--tlo-linkrefs-start--> [int]: ../data-types/datatype-int.md [Spawn Search]: ../../reference/general/spawn-search.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-spell.md b/reference/top-level-objects/tlo-spell.md index ea66fcee7..a52ea1f72 100644 --- a/reference/top-level-objects/tlo-spell.md +++ b/reference/top-level-objects/tlo-spell.md @@ -4,10 +4,11 @@ tags: --- # `Spell` +<!--tlo-desc-start--> Object used to return information on a spell by name or by ID. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='spell', name='Spell') }} : Find spell by ID @@ -15,7 +16,7 @@ Object used to return information on a spell by name or by ID. ### {{ renderMember(type='spell', name='Spell', params='Name') }} : Find spell by name - +<!--tlo-forms-end--> ## Usage @@ -30,5 +31,6 @@ Will return 1620 ``` Will return 16 (ie. 16 ticks) - +<!--tlo-linkrefs-start--> [spell]: ../data-types/datatype-spell.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-switch.md b/reference/top-level-objects/tlo-switch.md index 10828d3c8..daf9e7095 100644 --- a/reference/top-level-objects/tlo-switch.md +++ b/reference/top-level-objects/tlo-switch.md @@ -4,10 +4,11 @@ tags: --- # `Switch` +<!--tlo-desc-start--> Object used when you want to find information on targetted doors or switches such as the portals in PoK. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='switch', name='Switch') }} : Returns the currently targeted switch @@ -23,7 +24,7 @@ Object used when you want to find information on targetted doors or switches suc - `target`: Return the currently targeted switch - `nearest`: Return the nearest switch. - Otherwise, return switch by searching by name - +<!--tlo-forms-end--> ## Usage @@ -47,5 +48,6 @@ Access "foo" [_switch_](../data-types/datatype-switch.md) datatype members Access the current doortarget [_switch_](../data-types/datatype-switch.md) datatype members directly Returns TRUE or FALSE - +<!--tlo-linkrefs-start--> [switch]: ../data-types/datatype-switch.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-target.md b/reference/top-level-objects/tlo-target.md index 2c8c05912..adbdc4c08 100644 --- a/reference/top-level-objects/tlo-target.md +++ b/reference/top-level-objects/tlo-target.md @@ -4,10 +4,11 @@ tags: --- # `Target` +<!--tlo-desc-start--> Object used to get information about your current target. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='target', name='Target') }} : Returns the spawn object for the current target. @@ -55,6 +56,7 @@ Object used to get information about your current target. ``` returns "a_pyre_beetle48 will break mezz in 66s" - - -[target]: ../data-types/datatype-target.md \ No newline at end of file +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> +[target]: ../data-types/datatype-target.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-task.md b/reference/top-level-objects/tlo-task.md index 89a6e9687..2c65965ed 100644 --- a/reference/top-level-objects/tlo-task.md +++ b/reference/top-level-objects/tlo-task.md @@ -4,12 +4,13 @@ tags: --- # `Task` +<!--tlo-desc-start--> Object used to return information on a current Task. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='task', name='Task') }} - +<!--tlo-forms-end--> ## Usage @@ -18,5 +19,6 @@ Object used to return information on a current Task. ``` Will return the name of the first task, or the current shared task if one exists. - +<!--tlo-linkrefs-start--> [task]: ../data-types/datatype-task.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-time.md b/reference/top-level-objects/tlo-time.md index 87ae6c894..e5d328933 100644 --- a/reference/top-level-objects/tlo-time.md +++ b/reference/top-level-objects/tlo-time.md @@ -4,12 +4,13 @@ tags: --- # `Time` +<!--tlo-desc-start--> Object used to return information on real time, not game time. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='time', name='Time') }} - +<!--tlo-forms-end--> ## Usage @@ -18,5 +19,6 @@ Object used to return information on real time, not game time. ``` Returns the day of the week - +<!--tlo-linkrefs-start--> [time]: ../data-types/datatype-time.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-tradeskilldepot.md b/reference/top-level-objects/tlo-tradeskilldepot.md index 08dd26ae2..a871f571b 100644 --- a/reference/top-level-objects/tlo-tradeskilldepot.md +++ b/reference/top-level-objects/tlo-tradeskilldepot.md @@ -4,11 +4,13 @@ tags: --- # `TradeskillDepot` +<!--tlo-desc-start--> Object that interacts with the personal tradeskill depot, introduced in the Night of Shadows expansion. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='tradeskilldepot', name='TradeskillDepot') }} +<!--tlo-forms-end--> ## Examples @@ -17,5 +19,6 @@ Object that interacts with the personal tradeskill depot, introduced in the Nigh ``` Echos the name of the currently selected item in the tradeskill depot window. - +<!--tlo-linkrefs-start--> [tradeskilldepot]: ../data-types/datatype-tradeskilldepot.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-type.md b/reference/top-level-objects/tlo-type.md index 30e52602e..812eb257d 100644 --- a/reference/top-level-objects/tlo-type.md +++ b/reference/top-level-objects/tlo-type.md @@ -4,14 +4,15 @@ tags: --- # `Type` +<!--tlo-desc-start--> Used to get information on data types. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='type', name='Type', params='Name') }} : Retrieve metadata about the type with given `Name` - +<!--tlo-forms-end--> ## Usage @@ -28,5 +29,6 @@ Enumerate members of a type using a loop: /echo ${Type[spawn].Member[${n}]} /next n ``` - +<!--tlo-linkrefs-start--> [type]: ../data-types/datatype-type.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-window.md b/reference/top-level-objects/tlo-window.md index 103baa843..8414995db 100644 --- a/reference/top-level-objects/tlo-window.md +++ b/reference/top-level-objects/tlo-window.md @@ -4,14 +4,17 @@ tags: --- # `Window` +<!--tlo-desc-start--> Used to find information on a particular UI window. You can display a list of window names using the /windows command or by using the window inspector. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='window', name='Window', params='Name') }} : Retrieve window by searching for the first window matching `Name`. - +<!--tlo-forms-end--> +<!--tlo-linkrefs-start--> [window]: ../data-types/datatype-window.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-zone.md b/reference/top-level-objects/tlo-zone.md index 0d3cc76ac..a6438b56e 100644 --- a/reference/top-level-objects/tlo-zone.md +++ b/reference/top-level-objects/tlo-zone.md @@ -4,10 +4,11 @@ tags: --- # `Zone` +<!--tlo-desc-start--> Used to find information about a particular zone. - +<!--tlo-desc-end--> ## Forms - +<!--tlo-forms-start--> ### {{ renderMember(type='currentzone', name='Zone') }} : Retrieves the current zone information @@ -21,7 +22,7 @@ Used to find information about a particular zone. : Retrieves information about a zone by short name. If this zone is the current zone, then this will return [currentzone]. - +<!--tlo-forms-end--> ## Usage @@ -49,6 +50,7 @@ Returns the ID of _zonename_, even if you aren't in the zone. Returns the short name of the zone with ID _zoneid_. - +<!--tlo-linkrefs-start--> [zone]: ../data-types/datatype-zone.md [currentzone]: ../data-types/datatype-currentzone.md +<!--tlo-linkrefs-end--> From 24211012a18a049d927d9639839883d28dfd955f Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 10 May 2025 18:15:18 -0500 Subject: [PATCH 17/41] framelimiter feature re-created with includes --- main/features/framelimiter.md | 60 +++++++++++++++++++++++++++++++++-- 1 file changed, 57 insertions(+), 3 deletions(-) diff --git a/main/features/framelimiter.md b/main/features/framelimiter.md index 6c8d41fef..a277d74f8 100644 --- a/main/features/framelimiter.md +++ b/main/features/framelimiter.md @@ -11,12 +11,66 @@ Frame lmiter settings can be modified in the MacroQuest Settings window. ## Commands -{{ embedCommand('reference/commands/framelimiter.md') }} +<a href="../../../reference/commands/framelimiter/"> +{% + include-markdown "reference/commands/framelimiter.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/framelimiter.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/framelimiter.md') }} +{% + include-markdown "reference/commands/framelimiter.md" + start="<!--cmd-options-start-->" + end="<!--cmd-options-end-->" +%} ## Top-Level Objects -{{ embedMQType('reference/top-level-objects/tlo-framelimiter.md') }} +## [FrameLimiter](../../reference/top-level-objects/tlo-framelimiter.md) +{% + include-markdown "reference/top-level-objects/tlo-framelimiter.md" + start="<!--tlo-desc-start-->" + end="<!--tlo-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/top-level-objects/tlo-framelimiter.md') }} + +<h2>Forms</h2> +{% + include-markdown "reference/top-level-objects/tlo-framelimiter.md" + start="<!--tlo-forms-start-->" + end="<!--tlo-forms-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/top-level-objects/tlo-framelimiter.md" + start="<!--tlo-linkrefs-start-->" + end="<!--tlo-linkrefs-end-->" +%} ## Associated DataTypes -{{ embedMQType('reference/data-types/datatype-framelimiter.md') }} +## [framelimiter](../../reference/data-types/datatype-framelimiter.md) +{% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-framelimiter.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} From 4ca5c7920b03d8c54011fee793549319a189b098 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Mon, 12 May 2025 14:56:47 -0500 Subject: [PATCH 18/41] typo fixes --- plugins/core-plugins/map/mapfilter.md | 2 +- reference/commands/hotbutton.md | 2 +- reference/top-level-objects/tlo-framelimiter.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/core-plugins/map/mapfilter.md b/plugins/core-plugins/map/mapfilter.md index 87d5ade83..db58e3cf8 100644 --- a/plugins/core-plugins/map/mapfilter.md +++ b/plugins/core-plugins/map/mapfilter.md @@ -2,7 +2,7 @@ tags: - command --- -# Mapfilter +# /mapfilter ## Syntax <!--cmd-syntax-start--> diff --git a/reference/commands/hotbutton.md b/reference/commands/hotbutton.md index ff30576e2..8afb409b8 100644 --- a/reference/commands/hotbutton.md +++ b/reference/commands/hotbutton.md @@ -7,7 +7,7 @@ tags: ## Syntax <!--cmd-syntax-start--> ```eqcommand -/hotbutton <name> [<color>] [<line>:][<cursor>:]<text>] +/hotbutton <name> [<color>] [<line>:][<cursor>:][<text>] ``` <!--cmd-syntax-end--> diff --git a/reference/top-level-objects/tlo-framelimiter.md b/reference/top-level-objects/tlo-framelimiter.md index b60874331..ad1bb809b 100644 --- a/reference/top-level-objects/tlo-framelimiter.md +++ b/reference/top-level-objects/tlo-framelimiter.md @@ -28,8 +28,8 @@ The FrameLimiter TLO provides access to the [frame limiter](../../main/features/ <h2>Members</h2> {% include-markdown "reference/data-types/datatype-framelimiter.md" - start="<!--dt-members-start -->" - end="<!--dt-members-end -->" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" heading-offset=0 %} {% From dfaf705366360f81c8a1f90ac4b839d8abeeca2a Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Fri, 16 May 2025 16:37:05 -0500 Subject: [PATCH 19/41] adding notes/parameters sections --- reference/commands/declare.md | 5 +++-- reference/commands/filter.md | 5 ++++- reference/commands/mqlog.md | 5 +++-- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/reference/commands/declare.md b/reference/commands/declare.md index 0929b7858..72b39c33a 100644 --- a/reference/commands/declare.md +++ b/reference/commands/declare.md @@ -14,12 +14,13 @@ tags: ## Description <!--cmd-desc-start--> This creates a variable or array of a particular type with a particular scope, and a default value if desired. The parameters must be given in order, but any after _varname_ may be skipped to use the defaults. +<!--cmd-desc-end--> -**Notes** +## Notes * The default type is string * The default scope is local * The default value is nothing (empty string, or 0) These variables can be of any type that exist in MQ2DataVars. The variable will then have access to the members of that type. -<!--cmd-desc-end--> + diff --git a/reference/commands/filter.md b/reference/commands/filter.md index 30c6e5c8c..ad66c0d83 100644 --- a/reference/commands/filter.md +++ b/reference/commands/filter.md @@ -14,6 +14,9 @@ tags: ## Description <!--cmd-desc-start--> Extends the EverQuest command to allow filtering many types of messages, such as the annoying "You are out of food and drink" alert. +<!--cmd-desc-end--> + +## Parameters | **Command** | Description | | :--- | :--- | @@ -31,7 +34,7 @@ Extends the EverQuest command to allow filtering many types of messages, such as Filters added through `/filter` are excluded from EverQuest's logging (`/log`) system. **Important:** Overly broad filters may capture unintended messages. For example, filtering out `A rat` will also hide messages containing that exact phrase, such as /con messages. -<!--cmd-desc-end--> + ## Examples ```text diff --git a/reference/commands/mqlog.md b/reference/commands/mqlog.md index 0cacf0c05..f8b3e59f1 100644 --- a/reference/commands/mqlog.md +++ b/reference/commands/mqlog.md @@ -14,12 +14,13 @@ tags: ## Description <!--cmd-desc-start--> This will log _text_ to a log file in the "Logs" directory. Clear will delete everything in the log file. +<!--cmd-desc-end--> -**Notes** +## Notes * The log filename will be _macroname.mac.log_ if run from within a macro * The log filename will be _MacroQuest.log_ if issued normally -<!--cmd-desc-end--> + ## Example ```text From 7001ebfff03ac3a920e83b4f5b72e1ff6c08094a Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Fri, 25 Jul 2025 10:34:03 -0500 Subject: [PATCH 20/41] make keys look cool --- plugins/core-plugins/autologin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/core-plugins/autologin/index.md b/plugins/core-plugins/autologin/index.md index 2cd42b70e..6dd4637da 100644 --- a/plugins/core-plugins/autologin/index.md +++ b/plugins/core-plugins/autologin/index.md @@ -80,7 +80,7 @@ Upon clicking "Save", your profile will be encrypted and saved in MQ2AutoLogin.i trailing-newlines=false %} {{ readMore('plugins/core-plugins/autologin/switchserver.md') }} -`END` and `HOME` +++end++ and ++home++ : Pressing the "END" key at the character select screen will pause autologin, "HOME" will unpause. ## INI From 42e4c67ea8cc028705c2f75c354da9d9522686fb Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Fri, 25 Jul 2025 13:08:35 -0500 Subject: [PATCH 21/41] rewrite existing embeds to use separate datatype files --- main.py | 2 +- .../data-types/datatype-achievementmgr.md | 57 ++++ reference/data-types/datatype-advloot.md | 49 +++ reference/data-types/datatype-advlootitem.md | 82 +++++ reference/data-types/datatype-alert.md | 28 ++ reference/data-types/datatype-alertlist.md | 250 +++++++++++++++ reference/data-types/datatype-friends.md | 27 ++ .../data-types/datatype-itemfilterdata.md | 52 +++ .../top-level-objects/tlo-achievement.md | 64 ++-- reference/top-level-objects/tlo-advloot.md | 213 ++++-------- reference/top-level-objects/tlo-alert.md | 302 +++--------------- reference/top-level-objects/tlo-friends.md | 37 ++- 12 files changed, 707 insertions(+), 456 deletions(-) create mode 100644 reference/data-types/datatype-achievementmgr.md create mode 100644 reference/data-types/datatype-advloot.md create mode 100644 reference/data-types/datatype-advlootitem.md create mode 100644 reference/data-types/datatype-alert.md create mode 100644 reference/data-types/datatype-alertlist.md create mode 100644 reference/data-types/datatype-friends.md create mode 100644 reference/data-types/datatype-itemfilterdata.md diff --git a/main.py b/main.py index 742948665..5be1815b9 100644 --- a/main.py +++ b/main.py @@ -84,7 +84,7 @@ def relative_link(target_file_path, embedding_page_src_uri, base_dir=None): # extra sections beyond Members/Forms/Description def has_extra_sections(content): SECTION_PATTERN = r'^##\s+(.+?)\s*$' - target_sections = {"Members", "Forms", "Description"} + target_sections = {"Members", "Forms", "Description", "Associated DataTypes", "DataTypes"} lines = content.split('\n') sections = [] diff --git a/reference/data-types/datatype-achievementmgr.md b/reference/data-types/datatype-achievementmgr.md new file mode 100644 index 000000000..c3db5a4c5 --- /dev/null +++ b/reference/data-types/datatype-achievementmgr.md @@ -0,0 +1,57 @@ +--- +tags: + - datatype +--- +# `achievementmgr` + +<!--dt-desc-start--> +Provides access achievements, achievement categories, and other information surrounding the achievement system. +<!--dt-desc-end--> +## Members +<!--dt-members-start--> +### {{ renderMember(type='achievement', name='Achievement', params='#|Name') }} + +: Find an achievement by its ID or by its name. + +### {{ renderMember(type='achievement', name='AchievementByIndex', params='#') }} + +: Find an achievement by its index. + +### {{ renderMember(type='int', name='AchievementCount') }} + +: The number of achievements in the manager. + +### {{ renderMember(type='achievementcat', name='Category', params='#|Name') }} + +: Find an achievement category by its id or by its name.Note: If searching by name, only top-level categories are returned from the achievement manager. + +### {{ renderMember(type='achievementcat', name='CategoryByIndex', params='#') }} + +: Find an achievement category by its index. + +### {{ renderMember(type='int', name='CategoryCount') }} + +: The number of achievement categories in the manager. + +### {{ renderMember(type='int', name='Points') }} + +: The total number of accumulated achievement points. + +### {{ renderMember(type='int', name='CompletedAchievement') }} + +: The number of completed achievements. + +### {{ renderMember(type='int', name='TotalAchievement') }} + +: The number of available achievements. + +### {{ renderMember(type='bool', name='Ready') }} + +: Indicates that the manager has loaded all achievement data and is ready to be used. +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[achievement]: datatype-achievement.md +[achievementcat]: datatype-achievementcat.md +[bool]: datatype-bool.md +[int]: datatype-int.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-advloot.md b/reference/data-types/datatype-advloot.md new file mode 100644 index 000000000..7e035a975 --- /dev/null +++ b/reference/data-types/datatype-advloot.md @@ -0,0 +1,49 @@ +--- +tags: + - datatype +--- +# `advloot` + +<!--dt-desc-start--> +The AdvLoot TLO grants access to items in the Advanced Loot window. +<!--dt-desc-end--> +## Members +<!--dt-members-start--> +### {{ renderMember(type='itemfilterdata', name='Filter', params='ItemID') }} + +: Inspect the loot filter for a given ItemID. + +### {{ renderMember(type='bool', name='LootInProgress') }} + +: True/False if looting from AdvLoot is in progress + +### {{ renderMember(type='int', name='PCount') }} + +: item count from the Personal list + +### {{ renderMember(type='advlootitem', name='PList', params='Index') }} + +: Inspect the item at the specified index in the personal loot list. + +### {{ renderMember(type='int', name='PWantCount') }} + +: Want count from the Personal list (AN + AG + ND + GD) + +### {{ renderMember(type='int', name='SCount') }} + +: Item count from the Shared list + +### {{ renderMember(type='advlootitem', name='SList', params='Index') }} + +: Inspect the item at the specified index in the shared loot list. + +### {{ renderMember(type='int', name='SWantCount') }} + +: Want count from the Shared list (AN + AG + ND + GD) +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[advlootitem]: datatype-advlootitem.md +[bool]: datatype-bool.md +[int]: datatype-int.md +[itemfilterdata]: datatype-itemfilterdata.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-advlootitem.md b/reference/data-types/datatype-advlootitem.md new file mode 100644 index 000000000..8fddb6a84 --- /dev/null +++ b/reference/data-types/datatype-advlootitem.md @@ -0,0 +1,82 @@ +--- +tags: + - datatype +--- +# `advlootitem` + +<!--dt-desc-start--> +Represents a discrete item being looted in an AdvLoot window. +<!--dt-desc-end--> +## Members +<!--dt-members-start--> +### {{ renderMember(type='bool', name='AlwaysGreed') }} + +: The Always Greed (AG) state of the item. + +### {{ renderMember(type='bool', name='AlwaysNeed') }} + +: The Always Need (AN) state of the item. + +### {{ renderMember(type='bool', name='AutoRoll') }} + +: The Auto Roll state (dice icon) of the item. + +### {{ renderMember(type='spawn', name='Corpse') }} + +: The spawn representing the corpse that is being looted, if available. + +### {{ renderMember(type='bool', name='FreeGrab') }} + +: Indicates that the item is free grab. + +### {{ renderMember(type='bool', name='Greed') }} + +: The Greed (GD) state of the item. + +### {{ renderMember(type='int', name='IconID') }} + +: The ID of the icon for the item. + +### {{ renderMember(type='int64', name='ID') }} + +: The ID of the item. + +### {{ renderMember(type='int', name='Index') }} + +: The positional index of the item. + +### {{ renderMember(type='string', name='Name') }} + +: The name of the item. + +### {{ renderMember(type='bool', name='Need') }} + +: The Need (ND) state of the item. + +### {{ renderMember(type='bool', name='Never') }} + +: The Never (NV) state of the item. + +### {{ renderMember(type='bool', name='No') }} + +: The No state of the item. + +### {{ renderMember(type='bool', name='NoDrop') }} + +: Indicates if the item is NO DROP. + +### {{ renderMember(type='int', name='StackSize') }} + +: The size of the stack of items being looted. + +### [string][string] `To String` + +: Same as **Name** +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[bool]: datatype-bool.md +[int]: datatype-int.md +[int64]: datatype-int64.md +[spawn]: datatype-spawn.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-alert.md b/reference/data-types/datatype-alert.md new file mode 100644 index 000000000..ba6ddffbd --- /dev/null +++ b/reference/data-types/datatype-alert.md @@ -0,0 +1,28 @@ +--- +tags: + - datatype +--- +# `alert` + +<!--dt-desc-start--> +Provides information on alerts. (Alerts are created using [/alert](../../reference/commands/alert.md).) +<!--dt-desc-end--> +## Members +<!--dt-members-start--> +### {{ renderMember(type='alertlist', name='List', params='Index') }} + +: Get the item from the list at the specified index + +### {{ renderMember(type='int', name='Size') }} + +: Get the number of alerts + +### [string][string] `To String` + +: Returns **Size** as a string. +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[alertlist]: datatype-alertlist.md +[int]: datatype-int.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-alertlist.md b/reference/data-types/datatype-alertlist.md new file mode 100644 index 000000000..51d483bbf --- /dev/null +++ b/reference/data-types/datatype-alertlist.md @@ -0,0 +1,250 @@ +--- +tags: + - datatype +--- +# `alertlist` + +<!--dt-desc-start--> +Provides access to the properties of a spawn search associated with an alert. For a spawn to be entered into an alert it must match all the criteria specified by the alert list. + +See Also: [Spawn Search](../general/spawn-search.md). +<!--dt-desc-end--> +## Members +<!--dt-members-start--> +### {{ renderMember(type='int', name='AlertList') }} + +: Any spawn on the associated alert list + +### {{ renderMember(type='bool', name='bAlert') }} + +: Indicates usage of **alert** filter + +### {{ renderMember(type='bool', name='bAura') }} + +: Any aur. + +### {{ renderMember(type='bool', name='bBanker') }} + +: Any banker + +### {{ renderMember(type='bool', name='bBanner') }} + +: Any banner + +### {{ renderMember(type='bool', name='bCampfire') }} + +: Any campfire + +### {{ renderMember(type='bool', name='bDps') }} + +: Any player that is a DPS class + +### {{ renderMember(type='bool', name='bExactName') }} + +: Name match requiries an exact match + +### {{ renderMember(type='bool', name='bFellowship') }} + +: Any member of the fellowship + +### {{ renderMember(type='bool', name='bGM') }} + +: Any player flagged as a GM + +### {{ renderMember(type='bool', name='bGroup') }} + +: Any member of the group + +### {{ renderMember(type='bool', name='bHealer') }} + +: Any player that is a healer class + +### {{ renderMember(type='bool', name='bKnight') }} + +: Any player that is a knight + +### {{ renderMember(type='bool', name='bKnownLocation') }} + +: Indicates usage of a **loc** filter + +### {{ renderMember(type='bool', name='bLFG') }} + +: Any player that is flagged as LFG + +### {{ renderMember(type='bool', name='bLight') }} + +: Indicates usage of a **light** filter + +### {{ renderMember(type='bool', name='bLoS') }} + +: Any spawn in line of sight + +### {{ renderMember(type='bool', name='bMerchant') }} + +: Any merchant + +### {{ renderMember(type='bool', name='bNamed') }} + +: Any "named" NPC + +### {{ renderMember(type='bool', name='bNearAlert') }} + +: Indicates usage of **nearalert** filter + +### {{ renderMember(type='bool', name='bNoAlert') }} + +: Indicates usage of **noalert** filter + +### {{ renderMember(type='bool', name='bNoGroup') }} + +: Exclude any player that is in the group + +### {{ renderMember(type='bool', name='bNoGuild') }} + +: Exclude any player that is in the guild + +### {{ renderMember(type='bool', name='bNoPet') }} + +: Exclude any spawn that is a pet + +### {{ renderMember(type='bool', name='bNotNearAlert') }} + +: Indicates usage of **notnearalert** filter + +### {{ renderMember(type='string', name='BodyType') }} + +: Any spawn with given body type + +### {{ renderMember(type='bool', name='bRaid') }} + +: Any member of the raid + +### {{ renderMember(type='bool', name='bSlower') }} + +: Any player that is a slower + +### {{ renderMember(type='bool', name='bSpawnID') }} + +: Indicates usage of the **id** filter + +### {{ renderMember(type='bool', name='bTank') }} + +: Any player that is a tank class + +### {{ renderMember(type='bool', name='bTargetable') }} + +: Any spawn that is targetable + +### {{ renderMember(type='bool', name='bTargNext') }} + +: Indicates usage of the **next** filter + +### {{ renderMember(type='bool', name='bTargPrev') }} + +: Indicates usage of the **prev** filter + +### {{ renderMember(type='bool', name='bTrader') }} + +: Any player that is a trader + +### {{ renderMember(type='bool', name='bTributeMaster') }} + +: Any NPC that is a tribute master + +### {{ renderMember(type='string', name='Class') }} + +: Any spawn that is the given class + +### {{ renderMember(type='double', name='FRadius') }} + +: Any spawn that is given distance from the given **loc** filter + +### {{ renderMember(type='int', name='FromSpawnID') }} + +: Search starts at given spawn id + +### {{ renderMember(type='int64', name='GuildID') }} + +: Any member of the guild with the given id + +### {{ renderMember(type='string', name='Light') }} + +: Any spawn that is equipped with the given light source + +### {{ renderMember(type='int', name='MaxLevel') }} + +: Any spawn that is at this level or lower + +### {{ renderMember(type='int', name='MinLevel') }} + +: Any spawn that is at this level or greater + +### {{ renderMember(type='string', name='Name') }} + +: Any spawn with the given name + +### {{ renderMember(type='int', name='NearAlertList') }} + +: Any spawn near the given alert list + +### {{ renderMember(type='int', name='NoAlertList') }} + +: Excludes any spawn in the given alert list + +### {{ renderMember(type='int', name='NotID') }} + +: Excludes any spawn with the given id + +### {{ renderMember(type='int', name='NotNearAlertList') }} + +: Excludes any spawn near the given alert list + +### {{ renderMember(type='int', name='PlayerState') }} + +: Any spawn with the given state + +### {{ renderMember(type='string', name='Race') }} + +: Any spawn with the given race + +### {{ renderMember(type='float', name='Radius') }} + +: Excludes the spawn if any player is within this distance (**nopcnear** filter) + +### {{ renderMember(type='int', name='SortBy') }} + +: Indicates the sort order of the filter + +### {{ renderMember(type='spawn', name='Spawn') }} + +: If an ID or Name is part of the filter, attempts to return a spawn with the matching ID or Name + +### {{ renderMember(type='int', name='SpawnID') }} + +: Any spawn with the given Spawn ID + +### {{ renderMember(type='int', name='SpawnType') }} + +: Any spawn with the given type + +### {{ renderMember(type='float', name='xLoc') }} + +: `x` component of the **loc** filter + +### {{ renderMember(type='float', name='yLoc') }} + +: `y` component of the **loc** filter + +### {{ renderMember(type='double', name='ZRadius') }} + +: `z` distance component of the **loc** filter +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[bool]: datatype-bool.md +[double]: datatype-double.md +[float]: datatype-float.md +[int]: datatype-int.md +[int64]: datatype-int64.md +[spawn]: datatype-spawn.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-friends.md b/reference/data-types/datatype-friends.md new file mode 100644 index 000000000..3b4e8785e --- /dev/null +++ b/reference/data-types/datatype-friends.md @@ -0,0 +1,27 @@ +--- +tags: + - datatype +--- +# `friends` + +<!--dt-desc-start--> +Provides access to your friends list data. +<!--dt-desc-end--> +## Members +<!--dt-members-start--> +### {{ renderMember(type='bool', name='Friend', params='name') }} + +: Returns TRUE if _name_ is on your friend list + +### {{ renderMember(type='string', name='Friend', params='#') }} + +: Returns the name of friend list member _\#_ + +### [string][string] `To String` + +: Number of friends on your friends list +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[bool]: datatype-bool.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/data-types/datatype-itemfilterdata.md b/reference/data-types/datatype-itemfilterdata.md new file mode 100644 index 000000000..7cb563be9 --- /dev/null +++ b/reference/data-types/datatype-itemfilterdata.md @@ -0,0 +1,52 @@ +--- +tags: + - datatype +--- +# `itemfilterdata` + +<!--dt-desc-start--> +A collection of settings that together describe the loot filter for an item. +<!--dt-desc-end--> +## Members +<!--dt-members-start--> +### {{ renderMember(type='bool', name='AutoRoll') }} + +: The Auto Roll state (dice icon). + +### {{ renderMember(type='bool', name='Greed') }} + +: The Greed (GD) state. + +### {{ renderMember(type='int', name='IconID') }} + +: The ID of the icon. + +### {{ renderMember(type='int', name='ID') }} + +: The ID of the item. + +### {{ renderMember(type='string', name='Name') }} + +: The Name of the item. + +### {{ renderMember(type='bool', name='Need') }} + +: The Need (ND) state. + +### {{ renderMember(type='bool', name='Never') }} + +: The Never (NV) state. + +### {{ renderMember(type='int', name='Types') }} + +: Bit field representing all the loot filter flags for this item. + +### [string][string] `To String` + +: Same as **Name** +<!--dt-members-end--> +<!--dt-linkrefs-start--> +[bool]: datatype-bool.md +[int]: datatype-int.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-achievement.md b/reference/top-level-objects/tlo-achievement.md index c2c91cc70..b81c09674 100644 --- a/reference/top-level-objects/tlo-achievement.md +++ b/reference/top-level-objects/tlo-achievement.md @@ -20,49 +20,26 @@ Provides access to achievements. ## Associated DataTypes -## `achievementmgr` - -Provides access achievements, achievement categories, and other information surrounding the achievement system. - -### {{ renderMember(type='achievement', name='Achievement', params='#|Name') }} - -: Find an achievement by its ID or by its name. - -### {{ renderMember(type='achievement', name='AchievementByIndex', params='#') }} - -: Find an achievement by its index. - -### {{ renderMember(type='int', name='AchievementCount') }} - -: The number of achievements in the manager. - -### {{ renderMember(type='achievementcat', name='Category', params='#|Name') }} - -: Find an achievement category by its id or by its name.Note: If searching by name, only top-level categories are returned from the achievement manager. - -### {{ renderMember(type='achievementcat', name='CategoryByIndex', params='#') }} - -: Find an achievement category by its index. - -### {{ renderMember(type='int', name='CategoryCount') }} - -: The number of achievement categories in the manager. - -### {{ renderMember(type='int', name='Points') }} - -: The total number of accumulated achievement points. - -### {{ renderMember(type='int', name='CompletedAchievement') }} - -: The number of completed achievements. - -### {{ renderMember(type='int', name='TotalAchievement') }} - -: The number of available achievements. - -### {{ renderMember(type='bool', name='Ready') }} - -: Indicates that the manager has loaded all achievement data and is ready to be used. +## [achievementmgr](../data-types/datatype-achievementmgr.md) +{% + include-markdown "reference/data-types/datatype-achievementmgr.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-achievementmgr.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-achievementmgr.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-achievementmgr.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} @@ -118,4 +95,5 @@ To look up an achievement's ID, you can look up an achievement by name, or you c [bool]: ../data-types/datatype-bool.md [achievement]: ../data-types/datatype-achievement.md [achievementcat]: ../data-types/datatype-achievementcat.md +[achievementmgr]: ../data-types/datatype-achievementmgr.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-advloot.md b/reference/top-level-objects/tlo-advloot.md index b3c3c2452..90a0962d2 100644 --- a/reference/top-level-objects/tlo-advloot.md +++ b/reference/top-level-objects/tlo-advloot.md @@ -7,147 +7,71 @@ tags: <!--tlo-desc-start--> The AdvLoot TLO grants access to items in the Advanced Loot window. <!--tlo-desc-end--> -## Members -### {{ renderMember(type='itemfilterdata', name='Filter', params='ItemID') }} -: Inspect the loot filter for a given ItemID. - -### {{ renderMember(type='bool', name='LootInProgress') }} - -: True/False if looting from AdvLoot is in progress - -### {{ renderMember(type='int', name='PCount') }} - -: item count from the Personal list - -### {{ renderMember(type='advlootitem', name='PList', params='Index') }} - -: Inspect the item at the specified index in the personal loot list. - -### {{ renderMember(type='int', name='PWantCount') }} - -: Want count from the Personal list (AN + AG + ND + GD) - -### {{ renderMember(type='int', name='SCount') }} - -: Item count from the Shared list - -### {{ renderMember(type='advlootitem', name='SList', params='Index') }} - -: Inspect the item at the specified index in the shared loot list. - -### {{ renderMember(type='int', name='SWantCount') }} - -: Want count from the Shared list (AN + AG + ND + GD) - -## datatype `advlootitem` - -Represents a discrete item being looted in an AdvLoot window. - -### {{ renderMember(type='bool', name='AlwaysGreed') }} - -: The Always Greed (AG) state of the item. - -### {{ renderMember(type='bool', name='AlwaysNeed') }} - -: The Always Need (AN) state of the item. - -### {{ renderMember(type='bool', name='AutoRoll') }} - -: The Auto Roll state (dice icon) of the item. - -### {{ renderMember(type='spawn', name='Corpse') }} - -: The spawn representing the corpse that is being looted, if available. - -### {{ renderMember(type='bool', name='FreeGrab') }} - -: Indicates that the item is free grab. - -### {{ renderMember(type='bool', name='Greed') }} - -: The Greed (GD) state of the item. - -### {{ renderMember(type='int', name='IconID') }} - -: The ID of the icon for the item. - -### {{ renderMember(type='int64', name='ID') }} - -: The ID of the item. - -### {{ renderMember(type='int', name='Index') }} - -: The positional index of the item. - -### {{ renderMember(type='string', name='Name') }} - -: The name of the item. - -### {{ renderMember(type='bool', name='Need') }} - -: The Need (ND) state of the item. - -### {{ renderMember(type='bool', name='Never') }} - -: The Never (NV) state of the item. - -### {{ renderMember(type='bool', name='No') }} - -: The No state of the item. - -### {{ renderMember(type='bool', name='NoDrop') }} - -: Indicates if the item is NO DROP. - -### {{ renderMember(type='int', name='StackSize') }} - -: The size of the stack of items being looted. - -### [string][string] `To String` - -: Same as **Name** - - -## datatype `itemfilterdata` - -A collection of settings that together describe the loot filter for an item. - -### {{ renderMember(type='bool', name='AutoRoll') }} - -: The Auto Roll state (dice icon). - -### {{ renderMember(type='bool', name='Greed') }} - -: The Greed (GD) state. - -### {{ renderMember(type='int', name='IconID') }} - -: The ID of the icon. - -### {{ renderMember(type='int', name='ID') }} - -: The ID of the item. - -### {{ renderMember(type='string', name='Name') }} - -: The Name of the item. - -### {{ renderMember(type='bool', name='Need') }} - -: The Need (ND) state. - -### {{ renderMember(type='bool', name='Never') }} - -: The Never (NV) state. - -### {{ renderMember(type='int', name='Types') }} - -: Bit field representing all the loot filter flags for this item. - -### [string][string] `To String` - -: Same as **Name** +## Associated DataTypes + +## [advloot](../data-types/datatype-advloot.md) +{% + include-markdown "reference/data-types/datatype-advloot.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-advloot.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-advloot.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-advloot.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [advlootitem](../data-types/datatype-advlootitem.md) +{% + include-markdown "reference/data-types/datatype-advlootitem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-advlootitem.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-advlootitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-advlootitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [itemfilterdata](../data-types/datatype-itemfilterdata.md) +{% + include-markdown "reference/data-types/datatype-itemfilterdata.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-itemfilterdata.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-itemfilterdata.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-itemfilterdata.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} ## Usage @@ -220,11 +144,12 @@ A collection of settings that together describe the loot filter for an item. end ``` <!--tlo-linkrefs-start--> -[int]: ../data-types/datatype-int.md -[string]: ../data-types/datatype-string.md +[advloot]: ../data-types/datatype-advloot.md +[advlootitem]: ../data-types/datatype-advlootitem.md [bool]: ../data-types/datatype-bool.md +[int]: ../data-types/datatype-int.md [int64]: ../data-types/datatype-int64.md +[itemfilterdata]: ../data-types/datatype-itemfilterdata.md [spawn]: ../data-types/datatype-spawn.md -[itemfilterdata]: #datatype-itemfilterdata -[advlootitem]: #datatype-advlootitem +[string]: ../data-types/datatype-string.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-alert.md b/reference/top-level-objects/tlo-alert.md index 434b63c11..370ff02c9 100644 --- a/reference/top-level-objects/tlo-alert.md +++ b/reference/top-level-objects/tlo-alert.md @@ -13,260 +13,54 @@ Provides access to spawn search filter criteria in alerts. Alerts are created us : Retrieve information for the alert category by its id -| [string][string] | **Alert** | Returns pipe `|` separated list of alert ids | -<!--tlo-forms-end--> - -## datatype `alert` - -Provides access to the values of an alert. - -### {{ renderMember(type='alertlist', name='List', params='Index') }} - -: Get the item from the list at the specified index - -### {{ renderMember(type='int', name='Size') }} - -: Get the number of alerts - -### [string][string] `To String` - -: Returns **Size** as a string. - - -## datatype `alertlist` - -Provides access to the properties of a spawn search associated with an alert. For a spawn to be entered -into an alert it must match all the criteria specified by the alert list. - -See Also: [Spawn Search](../general/spawn-search.md). - -### {{ renderMember(type='int', name='AlertList') }} - -: Any spawn on the associated alert list - -### {{ renderMember(type='bool', name='bAlert') }} - -: Indicates usage of **alert** filter - -### {{ renderMember(type='bool', name='bAura') }} - -: Any aur. - -### {{ renderMember(type='bool', name='bBanker') }} - -: Any banker - -### {{ renderMember(type='bool', name='bBanner') }} - -: Any banner - -### {{ renderMember(type='bool', name='bCampfire') }} - -: Any campfire - -### {{ renderMember(type='bool', name='bDps') }} - -: Any player that is a DPS class - -### {{ renderMember(type='bool', name='bExactName') }} - -: Name match requiries an exact match - -### {{ renderMember(type='bool', name='bFellowship') }} - -: Any member of the fellowship - -### {{ renderMember(type='bool', name='bGM') }} - -: Any player flagged as a GM - -### {{ renderMember(type='bool', name='bGroup') }} - -: Any member of the group - -### {{ renderMember(type='bool', name='bHealer') }} - -: Any player that is a healer class - -### {{ renderMember(type='bool', name='bKnight') }} - -: Any player that is a knight - -### {{ renderMember(type='bool', name='bKnownLocation') }} - -: Indicates usage of a **loc** filter - -### {{ renderMember(type='bool', name='bLFG') }} - -: Any player that is flagged as LFG - -### {{ renderMember(type='bool', name='bLight') }} - -: Indicates usage of a **light** filter - -### {{ renderMember(type='bool', name='bLoS') }} - -: Any spawn in line of sight - -### {{ renderMember(type='bool', name='bMerchant') }} - -: Any merchant - -### {{ renderMember(type='bool', name='bNamed') }} - -: Any "named" NPC - -### {{ renderMember(type='bool', name='bNearAlert') }} - -: Indicates usage of **nearalert** filter - -### {{ renderMember(type='bool', name='bNoAlert') }} - -: Indicates usage of **noalert** filter - -### {{ renderMember(type='bool', name='bNoGroup') }} - -: Exclude any player that is in the group - -### {{ renderMember(type='bool', name='bNoGuild') }} - -: Exclude any player that is in the guild - -### {{ renderMember(type='bool', name='bNoPet') }} - -: Exclude any spawn that is a pet - -### {{ renderMember(type='bool', name='bNotNearAlert') }} - -: Indicates usage of **notnearalert** filter +### {{ renderMember(type='string', name='Alert') }} -### {{ renderMember(type='string', name='BodyType') }} - -: Any spawn with given body type - -### {{ renderMember(type='bool', name='bRaid') }} - -: Any member of the raid - -### {{ renderMember(type='bool', name='bSlower') }} - -: Any player that is a slower - -### {{ renderMember(type='bool', name='bSpawnID') }} - -: Indicates usage of the **id** filter - -### {{ renderMember(type='bool', name='bTank') }} - -: Any player that is a tank class - -### {{ renderMember(type='bool', name='bTargetable') }} - -: Any spawn that is targetable - -### {{ renderMember(type='bool', name='bTargNext') }} - -: Indicates usage of the **next** filter - -### {{ renderMember(type='bool', name='bTargPrev') }} - -: Indicates usage of the **prev** filter - -### {{ renderMember(type='bool', name='bTrader') }} - -: Any player that is a trader - -### {{ renderMember(type='bool', name='bTributeMaster') }} - -: Any NPC that is a tribute master - -### {{ renderMember(type='string', name='Class') }} - -: Any spawn that is the given class - -### {{ renderMember(type='double', name='FRadius') }} - -: Any spawn that is given distance from the given **loc** filter - -### {{ renderMember(type='int', name='FromSpawnID') }} - -: Search starts at given spawn id - -### {{ renderMember(type='int64', name='GuildID') }} - -: Any member of the guild with the given id - -### {{ renderMember(type='string', name='Light') }} - -: Any spawn that is equipped with the given light source - -### {{ renderMember(type='int', name='MaxLevel') }} - -: Any spawn that is at this level or lower - -### {{ renderMember(type='int', name='MinLevel') }} - -: Any spawn that is at this level or greater - -### {{ renderMember(type='string', name='Name') }} - -: Any spawn with the given name - -### {{ renderMember(type='int', name='NearAlertList') }} - -: Any spawn near the given alert list - -### {{ renderMember(type='int', name='NoAlertList') }} - -: Excludes any spawn in the given alert list - -### {{ renderMember(type='int', name='NotID') }} - -: Excludes any spawn with the given id - -### {{ renderMember(type='int', name='NotNearAlertList') }} - -: Excludes any spawn near the given alert list - -### {{ renderMember(type='int', name='PlayerState') }} - -: Any spawn with the given state - -### {{ renderMember(type='string', name='Race') }} - -: Any spawn with the given race - -### {{ renderMember(type='float', name='Radius') }} - -: Excludes the spawn if any player is within this distance (**nopcnear** filter) - -### {{ renderMember(type='int', name='SortBy') }} - -: Indicates the sort order of the filter - -### {{ renderMember(type='spawn', name='Spawn') }} - -: If an ID or Name is part of the filter, attempts to return a spawn with the matching ID or Name - -### {{ renderMember(type='int', name='SpawnID') }} - -: Any spawn with the given Spawn ID - -### {{ renderMember(type='int', name='SpawnType') }} - -: Any spawn with the given type - -### {{ renderMember(type='float', name='xLoc') }} - -: `x` component of the **loc** filter - -### {{ renderMember(type='float', name='yLoc') }} - -: `y` component of the **loc** filter - -### {{ renderMember(type='double', name='ZRadius') }} +: Returns pipe `|` separated list of alert ids +<!--tlo-forms-end--> -: `z` distance component of the **loc** filter +## Associated DataTypes + +## [alert](../data-types/datatype-alert.md) +{% + include-markdown "reference/data-types/datatype-alert.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-alert.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-alert.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-alert.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [alertlist](../data-types/datatype-alertlist.md) +{% + include-markdown "reference/data-types/datatype-alertlist.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-alertlist.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-alertlist.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-alertlist.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} ## Usage @@ -309,8 +103,8 @@ See Also: [Spawn Search](../general/spawn-search.md). print(mq.TLO.Alert(1).Size()) ``` <!--tlo-linkrefs-start--> -[alert]: #datatype-alert -[alertlist]: #datatype-alertlist +[alert]: ../data-types/datatype-alert.md +[alertlist]: ../data-types/datatype-alertlist.md [bool]: ../data-types/datatype-bool.md [double]: ../data-types/datatype-double.md [float]: ../data-types/datatype-float.md diff --git a/reference/top-level-objects/tlo-friends.md b/reference/top-level-objects/tlo-friends.md index 50094e134..3646f6d37 100644 --- a/reference/top-level-objects/tlo-friends.md +++ b/reference/top-level-objects/tlo-friends.md @@ -14,19 +14,28 @@ Grants access to your friends dlist. : Access friends data <!--tlo-forms-end--> -## datatype `friends` - -### {{ renderMember(type='bool', name='Friend', params='name') }} - -: Returns TRUE if _name_ is on your friend list - -### {{ renderMember(type='string', name='Friend', params='#') }} - -: Returns the name of friend list member _\#_ - -### [string][string] `To String` - -: Number of friends on your friends list +## Associated DataTypes + +## [friends](../data-types/datatype-friends.md) +{% + include-markdown "reference/data-types/datatype-friends.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-friends.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-friends.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-friends.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} @@ -56,5 +65,5 @@ Grants access to your friends dlist. <!--tlo-linkrefs-start--> [string]: ../data-types/datatype-string.md [bool]: ../data-types/datatype-bool.md -[friends]: #datatype-friends +[friends]: ../data-types/datatype-friends.md <!--tlo-linkrefs-end--> From fca888796202c94df136a7caa524ee484ce2f37f Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Sat, 26 Jul 2025 11:46:45 -0500 Subject: [PATCH 22/41] add associated datatypes to TLOs --- .../data-types/datatype-taskobjective.md | 2 +- reference/top-level-objects/tlo-altability.md | 23 +++++ reference/top-level-objects/tlo-corpse.md | 23 +++++ .../top-level-objects/tlo-dynamiczone.md | 65 ++++++++++++++ reference/top-level-objects/tlo-everquest.md | 23 +++++ reference/top-level-objects/tlo-familiar.md | 44 ++++++++++ reference/top-level-objects/tlo-ground.md | 23 +++++ reference/top-level-objects/tlo-group.md | 51 ++++++++++- reference/top-level-objects/tlo-heading.md | 23 +++++ reference/top-level-objects/tlo-illusion.md | 44 ++++++++++ reference/top-level-objects/tlo-ini.md | 86 +++++++++++++++++++ reference/top-level-objects/tlo-inventory.md | 23 +++++ reference/top-level-objects/tlo-invslot.md | 23 +++++ reference/top-level-objects/tlo-macro.md | 24 ++++++ reference/top-level-objects/tlo-macroquest.md | 23 +++++ reference/top-level-objects/tlo-math.md | 23 +++++ reference/top-level-objects/tlo-mercenary.md | 23 +++++ reference/top-level-objects/tlo-merchant.md | 23 +++++ reference/top-level-objects/tlo-mount.md | 45 ++++++++++ reference/top-level-objects/tlo-pet.md | 23 +++++ reference/top-level-objects/tlo-plugin.md | 23 +++++ reference/top-level-objects/tlo-raid.md | 44 ++++++++++ reference/top-level-objects/tlo-range.md | 24 ++++++ reference/top-level-objects/tlo-skill.md | 23 +++++ reference/top-level-objects/tlo-social.md | 23 +++++ reference/top-level-objects/tlo-spell.md | 23 +++++ reference/top-level-objects/tlo-switch.md | 23 +++++ reference/top-level-objects/tlo-target.md | 27 +++++- reference/top-level-objects/tlo-task.md | 65 ++++++++++++++ reference/top-level-objects/tlo-time.md | 23 +++++ .../top-level-objects/tlo-tradeskilldepot.md | 23 +++++ reference/top-level-objects/tlo-type.md | 23 +++++ reference/top-level-objects/tlo-window.md | 24 ++++++ reference/top-level-objects/tlo-zone.md | 44 ++++++++++ 34 files changed, 1046 insertions(+), 3 deletions(-) diff --git a/reference/data-types/datatype-taskobjective.md b/reference/data-types/datatype-taskobjective.md index c28627d61..cc8717c7d 100644 --- a/reference/data-types/datatype-taskobjective.md +++ b/reference/data-types/datatype-taskobjective.md @@ -51,7 +51,7 @@ This is the type for your current task objective. ### {{ renderMember(type='string', name='Type') }} -: Returns a string that can be one of the following:< +: Returns a string that can be one of the following: - Unknown - None diff --git a/reference/top-level-objects/tlo-altability.md b/reference/top-level-objects/tlo-altability.md index bfef96ea6..90d96cfb5 100644 --- a/reference/top-level-objects/tlo-altability.md +++ b/reference/top-level-objects/tlo-altability.md @@ -22,6 +22,29 @@ tags: : Look up an AltAbility by its name. <!--tlo-forms-end--> +## Associated DataTypes + +## [altability](../data-types/datatype-altability.md) +{% + include-markdown "reference/data-types/datatype-altability.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-altability.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-altability.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-altability.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage === "MQScript" diff --git a/reference/top-level-objects/tlo-corpse.md b/reference/top-level-objects/tlo-corpse.md index d6752c9a8..dfcce7d25 100644 --- a/reference/top-level-objects/tlo-corpse.md +++ b/reference/top-level-objects/tlo-corpse.md @@ -14,6 +14,29 @@ Access to objects of type corpse, which is the currently active corpse (ie. the : Corpse you are looting. <!--tlo-forms-end--> +## Associated DataTypes + +## [corpse](../data-types/datatype-corpse.md) +{% + include-markdown "reference/data-types/datatype-corpse.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-corpse.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-corpse.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-corpse.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-dynamiczone.md b/reference/top-level-objects/tlo-dynamiczone.md index e147ef153..472e9bf4c 100644 --- a/reference/top-level-objects/tlo-dynamiczone.md +++ b/reference/top-level-objects/tlo-dynamiczone.md @@ -14,6 +14,71 @@ Provides access to properties of the current dynamic (instanced) zone. : Gives access to the information about the current dynamic zone. <!--tlo-forms-end--> +## Associated DataTypes + +## [dynamiczone](../data-types/datatype-dynamiczone.md) +{% + include-markdown "reference/data-types/datatype-dynamiczone.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-dynamiczone.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-dynamiczone.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-dynamiczone.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [dzmember](../data-types/datatype-dzmember.md) +{% + include-markdown "reference/data-types/datatype-dzmember.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-dzmember.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-dzmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-dzmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [dztimer](../data-types/datatype-dztimer.md) +{% + include-markdown "reference/data-types/datatype-dztimer.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-dztimer.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-dztimer.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-dztimer.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage !!! example diff --git a/reference/top-level-objects/tlo-everquest.md b/reference/top-level-objects/tlo-everquest.md index d859889eb..d6c407448 100644 --- a/reference/top-level-objects/tlo-everquest.md +++ b/reference/top-level-objects/tlo-everquest.md @@ -12,6 +12,29 @@ Provides access to general information about the game and its state. ### {{ renderMember(type='everquest', name='everquest') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [everquest](../data-types/datatype-everquest.md) +{% + include-markdown "reference/data-types/datatype-everquest.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-everquest.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-everquest.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-everquest.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage See [EverQuest] for examples. diff --git a/reference/top-level-objects/tlo-familiar.md b/reference/top-level-objects/tlo-familiar.md index 9d61ee73a..f3aceaab3 100644 --- a/reference/top-level-objects/tlo-familiar.md +++ b/reference/top-level-objects/tlo-familiar.md @@ -22,6 +22,50 @@ Used to get information about items on your familiars keyring. : Retrieve the item in your familiar keyring by name. A `=` can be prepended for an exact match. <!--tlo-forms-end--> +## Associated DataTypes + +## [keyring](../data-types/datatype-keyring.md) +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-keyring.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [keyringitem](../data-types/datatype-keyringitem.md) +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-keyringitem.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Examples See Also: [keyring][keyring] and [keyringitem][keyringitem] diff --git a/reference/top-level-objects/tlo-ground.md b/reference/top-level-objects/tlo-ground.md index 59da41655..efe39ce4b 100644 --- a/reference/top-level-objects/tlo-ground.md +++ b/reference/top-level-objects/tlo-ground.md @@ -14,6 +14,29 @@ Object which references the ground spawn item you have targeted. : Access currently targeted ground item. <!--tlo-forms-end--> +## Associated DataTypes + +## [ground](../data-types/datatype-ground.md) +{% + include-markdown "reference/data-types/datatype-ground.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-ground.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-ground.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-ground.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-group.md b/reference/top-level-objects/tlo-group.md index 74c583e52..188ee3b7c 100644 --- a/reference/top-level-objects/tlo-group.md +++ b/reference/top-level-objects/tlo-group.md @@ -14,6 +14,50 @@ Access to all group-related information. : Retrieve information about your group <!--tlo-forms-end--> +## Associated DataTypes + +## [group](../data-types/datatype-group.md) +{% + include-markdown "reference/data-types/datatype-group.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-group.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-group.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-group.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [groupmember](../data-types/datatype-groupmember.md) +{% + include-markdown "reference/data-types/datatype-groupmember.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-groupmember.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-groupmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-groupmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` @@ -29,10 +73,15 @@ Echo Groupleader ID, if any. Echos your own name ``` -`/echo ${Group.Member[1]} +/echo ${Group.Member[1]} ``` Echos the next person on the list, after yourself. <!--tlo-linkrefs-start--> +[bool]: ../data-types/datatype-bool.md [group]: ../data-types/datatype-group.md +[groupmember]: ../data-types/datatype-groupmember.md +[int]: ../data-types/datatype-int.md +[spawn]: ../data-types/datatype-spawn.md +[string]: ../data-types/datatype-string.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-heading.md b/reference/top-level-objects/tlo-heading.md index ef567033a..f4c455e05 100644 --- a/reference/top-level-objects/tlo-heading.md +++ b/reference/top-level-objects/tlo-heading.md @@ -22,6 +22,29 @@ Object that refers to the directional heading to of a location or direction. : Same as above, just an alternate method <!--tlo-forms-end--> +## Associated DataTypes + +## [heading](../data-types/datatype-heading.md) +{% + include-markdown "reference/data-types/datatype-heading.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-heading.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-heading.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-heading.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-illusion.md b/reference/top-level-objects/tlo-illusion.md index 86d59b066..88fd0f454 100644 --- a/reference/top-level-objects/tlo-illusion.md +++ b/reference/top-level-objects/tlo-illusion.md @@ -22,6 +22,50 @@ Used to get information about items on your illusions keyring. : Retrieve the item in your illusion keyring by name. A `=` can be prepended for an exact match. <!--tlo-forms-end--> +## Associated DataTypes + +## [keyring](../data-types/datatype-keyring.md) +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-keyring.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [keyringitem](../data-types/datatype-keyringitem.md) +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-keyringitem.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage See Also: [DataType:keyring](../data-types/datatype-keyring.md) and [DataType:keyringitem](../data-types/datatype-keyring.md) diff --git a/reference/top-level-objects/tlo-ini.md b/reference/top-level-objects/tlo-ini.md index aa6541e00..5266e0ef9 100644 --- a/reference/top-level-objects/tlo-ini.md +++ b/reference/top-level-objects/tlo-ini.md @@ -25,6 +25,92 @@ Reads value(s) from an ini file located in a relative or absolute path. to the [Key](../data-types/datatype-inifilesectionkey.md) datatype for further usage. <!--tlo-forms-end--> +## Associated DataTypes + +## [ini](../data-types/datatype-ini.md) +{% + include-markdown "reference/data-types/datatype-ini.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-ini.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-ini.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-ini.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [inifile](../data-types/datatype-inifile.md) +{% + include-markdown "reference/data-types/datatype-inifile.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-inifile.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-inifile.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-inifile.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [inifilesection](../data-types/datatype-inifilesection.md) +{% + include-markdown "reference/data-types/datatype-inifilesection.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-inifilesection.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-inifilesection.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-inifilesection.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [inifilesectionkey](../data-types/datatype-inifilesectionkey.md) +{% + include-markdown "reference/data-types/datatype-inifilesectionkey.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-inifilesectionkey.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-inifilesectionkey.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-inifilesectionkey.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage If sample.ini contains: diff --git a/reference/top-level-objects/tlo-inventory.md b/reference/top-level-objects/tlo-inventory.md index 674d84453..65ea2bc74 100644 --- a/reference/top-level-objects/tlo-inventory.md +++ b/reference/top-level-objects/tlo-inventory.md @@ -14,6 +14,29 @@ This is a hierarchical container for things relating to inventory (Bank, etc). : Your inventory. <!--tlo-forms-end--> +## Associated DataTypes + +## [inventory](../data-types/datatype-inventory.md) +{% + include-markdown "reference/data-types/datatype-inventory.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-inventory.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-inventory.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-inventory.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage See the datatype link for examples diff --git a/reference/top-level-objects/tlo-invslot.md b/reference/top-level-objects/tlo-invslot.md index ed74275ba..e94a05716 100644 --- a/reference/top-level-objects/tlo-invslot.md +++ b/reference/top-level-objects/tlo-invslot.md @@ -18,6 +18,29 @@ Object used to get information on a specific inventory slot. : Inventory slot matching `SlotName`. <!--tlo-forms-end--> +## Associated DataTypes + +## [invslot](../data-types/datatype-invslot.md) +{% + include-markdown "reference/data-types/datatype-invslot.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-invslot.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-invslot.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-invslot.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage See the datatype link for examples diff --git a/reference/top-level-objects/tlo-macro.md b/reference/top-level-objects/tlo-macro.md index 995975f4b..f002ea707 100644 --- a/reference/top-level-objects/tlo-macro.md +++ b/reference/top-level-objects/tlo-macro.md @@ -19,6 +19,30 @@ Information about the macro that's currently running. /echo This macro has been running for: ${Macro.RunTime} seconds ``` <!--tlo-forms-end--> + +## Associated DataTypes + +## [macro](../data-types/datatype-macro.md) +{% + include-markdown "reference/data-types/datatype-macro.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-macro.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-macro.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-macro.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + <!--tlo-linkrefs-start--> [macro]: ../data-types/datatype-macro.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-macroquest.md b/reference/top-level-objects/tlo-macroquest.md index 710a153d8..fad8d2e33 100644 --- a/reference/top-level-objects/tlo-macroquest.md +++ b/reference/top-level-objects/tlo-macroquest.md @@ -12,6 +12,29 @@ Creates an object related to MacroQuest information. ### {{ renderMember(type='macroquest', name='MacroQuest') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [macroquest](../data-types/datatype-macroquest.md) +{% + include-markdown "reference/data-types/datatype-macroquest.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-macroquest.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-macroquest.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-macroquest.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-math.md b/reference/top-level-objects/tlo-math.md index b0c941394..61f1339f3 100644 --- a/reference/top-level-objects/tlo-math.md +++ b/reference/top-level-objects/tlo-math.md @@ -13,6 +13,29 @@ Creates a Math object which gives allows access to the math type members. : Returns the math object which is used to perform math operations. <!--tlo-forms-end--> +## Associated DataTypes + +## [math](../data-types/datatype-math.md) +{% + include-markdown "reference/data-types/datatype-math.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-math.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-math.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-math.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-mercenary.md b/reference/top-level-objects/tlo-mercenary.md index 340b5d41c..c2e016238 100644 --- a/reference/top-level-objects/tlo-mercenary.md +++ b/reference/top-level-objects/tlo-mercenary.md @@ -12,6 +12,29 @@ Object used to get information about your mercenary. ### {{ renderMember(type='mercenary', name='Mercenary') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [mercenary](../data-types/datatype-mercenary.md) +{% + include-markdown "reference/data-types/datatype-mercenary.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-mercenary.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-mercenary.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-mercenary.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-merchant.md b/reference/top-level-objects/tlo-merchant.md index aa77dd909..2041faf58 100644 --- a/reference/top-level-objects/tlo-merchant.md +++ b/reference/top-level-objects/tlo-merchant.md @@ -12,6 +12,29 @@ Object that interacts with the currently active merchant. ### {{ renderMember(type='merchant', name='Merchant') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [merchant](../data-types/datatype-merchant.md) +{% + include-markdown "reference/data-types/datatype-merchant.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-merchant.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-merchant.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-merchant.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-mount.md b/reference/top-level-objects/tlo-mount.md index bf7d1aae8..db24e968f 100644 --- a/reference/top-level-objects/tlo-mount.md +++ b/reference/top-level-objects/tlo-mount.md @@ -21,6 +21,51 @@ Used to get information about items on your Mount keyring. : Retrieve the item in your mount keyring by name. A `=` can be prepended for an exact match. <!--tlo-forms-end--> + +## Associated DataTypes + +## [keyring](../data-types/datatype-keyring.md) +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-keyring.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [keyringitem](../data-types/datatype-keyringitem.md) +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-keyringitem.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + <!--tlo-linkrefs-start--> [keyring]: ../data-types/datatype-keyring.md [keyringitem]: ../data-types/datatype-keyringitem.md diff --git a/reference/top-level-objects/tlo-pet.md b/reference/top-level-objects/tlo-pet.md index 2c619eacb..7c2b7c434 100644 --- a/reference/top-level-objects/tlo-pet.md +++ b/reference/top-level-objects/tlo-pet.md @@ -15,6 +15,29 @@ Pet object which allows you to get properties of your pet. has access to the properties of the [spawn](../data-types/datatype-spawn.md) type as well. <!--tlo-forms-end--> +## Associated DataTypes + +## [pet](../data-types/datatype-pet.md) +{% + include-markdown "reference/data-types/datatype-pet.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-pet.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-pet.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-pet.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-plugin.md b/reference/top-level-objects/tlo-plugin.md index df09e8340..7471f9851 100644 --- a/reference/top-level-objects/tlo-plugin.md +++ b/reference/top-level-objects/tlo-plugin.md @@ -18,6 +18,29 @@ Object that has access to members that provide information on a plugin. : Plugin by index, starting with 1 and stopping whenever the list runs out of plugins. <!--tlo-forms-end--> +## Associated DataTypes + +## [plugin](../data-types/datatype-plugin.md) +{% + include-markdown "reference/data-types/datatype-plugin.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-plugin.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-plugin.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-plugin.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage To see if a plugin is loaded: diff --git a/reference/top-level-objects/tlo-raid.md b/reference/top-level-objects/tlo-raid.md index 6d4bab716..056a71079 100644 --- a/reference/top-level-objects/tlo-raid.md +++ b/reference/top-level-objects/tlo-raid.md @@ -12,6 +12,50 @@ Object that has access to members that provide information on your raid. ### {{ renderMember(type='raid', name='Raid') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [raid](../data-types/datatype-raid.md) +{% + include-markdown "reference/data-types/datatype-raid.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-raid.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-raid.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-raid.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [raidmember](../data-types/datatype-raidmember.md) +{% + include-markdown "reference/data-types/datatype-raidmember.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-raidmember.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-raidmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-raidmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-range.md b/reference/top-level-objects/tlo-range.md index 920b03dae..d4cc68ef9 100644 --- a/reference/top-level-objects/tlo-range.md +++ b/reference/top-level-objects/tlo-range.md @@ -11,6 +11,30 @@ Test if _n_ is inside a range of 2 numbers or between 2 numbers <!--tlo-forms-start--> ### {{ renderMember(type='range', name='Range') }} <!--tlo-forms-end--> + +## Associated DataTypes + +## [range](../data-types/datatype-range.md) +{% + include-markdown "reference/data-types/datatype-range.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-range.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-range.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-range.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + <!--tlo-linkrefs-start--> [range]: ../data-types/datatype-range.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-skill.md b/reference/top-level-objects/tlo-skill.md index 18aa7b500..41a9ea76f 100644 --- a/reference/top-level-objects/tlo-skill.md +++ b/reference/top-level-objects/tlo-skill.md @@ -18,6 +18,29 @@ Object used to get information on your character's skills. : Retrieve skill by number <!--tlo-forms-end--> +## Associated DataTypes + +## [skill](../data-types/datatype-skill.md) +{% + include-markdown "reference/data-types/datatype-skill.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-skill.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-skill.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-skill.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-social.md b/reference/top-level-objects/tlo-social.md index d5603df1a..536cdce0c 100644 --- a/reference/top-level-objects/tlo-social.md +++ b/reference/top-level-objects/tlo-social.md @@ -16,6 +16,29 @@ Access data about socials (in-game macro buttons) Each page as 12 socials, so index 13 would be the first social on the page 2. There are a total of 120 socials. <!--tlo-forms-end--> +## Associated DataTypes + +## [social](../data-types/datatype-social.md) +{% + include-markdown "reference/data-types/datatype-social.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-social.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-social.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-social.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage !!! Example diff --git a/reference/top-level-objects/tlo-spell.md b/reference/top-level-objects/tlo-spell.md index a52ea1f72..066b6f63b 100644 --- a/reference/top-level-objects/tlo-spell.md +++ b/reference/top-level-objects/tlo-spell.md @@ -18,6 +18,29 @@ Object used to return information on a spell by name or by ID. : Find spell by name <!--tlo-forms-end--> +## Associated DataTypes + +## [spell](../data-types/datatype-spell.md) +{% + include-markdown "reference/data-types/datatype-spell.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-spell.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-spell.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-spell.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-switch.md b/reference/top-level-objects/tlo-switch.md index daf9e7095..1c477769b 100644 --- a/reference/top-level-objects/tlo-switch.md +++ b/reference/top-level-objects/tlo-switch.md @@ -26,6 +26,29 @@ Object used when you want to find information on targetted doors or switches suc - Otherwise, return switch by searching by name <!--tlo-forms-end--> +## Associated DataTypes + +## [switch](../data-types/datatype-switch.md) +{% + include-markdown "reference/data-types/datatype-switch.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-switch.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-switch.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-switch.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-target.md b/reference/top-level-objects/tlo-target.md index adbdc4c08..4ddd211c4 100644 --- a/reference/top-level-objects/tlo-target.md +++ b/reference/top-level-objects/tlo-target.md @@ -12,7 +12,9 @@ Object used to get information about your current target. ### {{ renderMember(type='target', name='Target') }} : Returns the spawn object for the current target. +<!--tlo-forms-end--> +## Examples !!! warning "Note" @@ -56,7 +58,30 @@ Object used to get information about your current target. ``` returns "a_pyre_beetle48 will break mezz in 66s" -<!--tlo-forms-end--> + +## Associated DataTypes + +## [target](../data-types/datatype-target.md) +{% + include-markdown "reference/data-types/datatype-target.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-target.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-target.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-target.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + <!--tlo-linkrefs-start--> [target]: ../data-types/datatype-target.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-task.md b/reference/top-level-objects/tlo-task.md index 2c65965ed..71f6d02fe 100644 --- a/reference/top-level-objects/tlo-task.md +++ b/reference/top-level-objects/tlo-task.md @@ -12,6 +12,71 @@ Object used to return information on a current Task. ### {{ renderMember(type='task', name='Task') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [task](../data-types/datatype-task.md) +{% + include-markdown "reference/data-types/datatype-task.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-task.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-task.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-task.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [taskmember](../data-types/datatype-taskmember.md) +{% + include-markdown "reference/data-types/datatype-taskmember.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-taskmember.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-taskmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-taskmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [taskobjective](../data-types/datatype-taskobjective.md) +{% + include-markdown "reference/data-types/datatype-taskobjective.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-taskobjective.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-taskobjective.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-taskobjective.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-time.md b/reference/top-level-objects/tlo-time.md index e5d328933..df8e19d64 100644 --- a/reference/top-level-objects/tlo-time.md +++ b/reference/top-level-objects/tlo-time.md @@ -12,6 +12,29 @@ Object used to return information on real time, not game time. ### {{ renderMember(type='time', name='Time') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [time](../data-types/datatype-time.md) +{% + include-markdown "reference/data-types/datatype-time.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-time.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-time.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-time.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` diff --git a/reference/top-level-objects/tlo-tradeskilldepot.md b/reference/top-level-objects/tlo-tradeskilldepot.md index a871f571b..2edca46db 100644 --- a/reference/top-level-objects/tlo-tradeskilldepot.md +++ b/reference/top-level-objects/tlo-tradeskilldepot.md @@ -12,6 +12,29 @@ Object that interacts with the personal tradeskill depot, introduced in the Nigh ### {{ renderMember(type='tradeskilldepot', name='TradeskillDepot') }} <!--tlo-forms-end--> +## Associated DataTypes + +## [tradeskilldepot](../data-types/datatype-tradeskilldepot.md) +{% + include-markdown "reference/data-types/datatype-tradeskilldepot.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-tradeskilldepot.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-tradeskilldepot.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-tradeskilldepot.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Examples ``` diff --git a/reference/top-level-objects/tlo-type.md b/reference/top-level-objects/tlo-type.md index 812eb257d..cf6f00066 100644 --- a/reference/top-level-objects/tlo-type.md +++ b/reference/top-level-objects/tlo-type.md @@ -14,6 +14,29 @@ Used to get information on data types. : Retrieve metadata about the type with given `Name` <!--tlo-forms-end--> +## Associated DataTypes + +## [type](../data-types/datatype-type.md) +{% + include-markdown "reference/data-types/datatype-type.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-type.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-type.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-type.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage Determines if a member of a type exists: diff --git a/reference/top-level-objects/tlo-window.md b/reference/top-level-objects/tlo-window.md index 8414995db..339b5ecab 100644 --- a/reference/top-level-objects/tlo-window.md +++ b/reference/top-level-objects/tlo-window.md @@ -15,6 +15,30 @@ You can display a list of window names using the /windows command or by using th : Retrieve window by searching for the first window matching `Name`. <!--tlo-forms-end--> + +## Associated DataTypes + +## [window](../data-types/datatype-window.md) +{% + include-markdown "reference/data-types/datatype-window.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-window.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-window.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-window.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + <!--tlo-linkrefs-start--> [window]: ../data-types/datatype-window.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-zone.md b/reference/top-level-objects/tlo-zone.md index a6438b56e..340d816ea 100644 --- a/reference/top-level-objects/tlo-zone.md +++ b/reference/top-level-objects/tlo-zone.md @@ -24,6 +24,50 @@ Used to find information about a particular zone. this will return [currentzone]. <!--tlo-forms-end--> +## Associated DataTypes + +## [zone](../data-types/datatype-zone.md) +{% + include-markdown "reference/data-types/datatype-zone.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-zone.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-zone.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-zone.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [currentzone](../data-types/datatype-currentzone.md) +{% + include-markdown "reference/data-types/datatype-currentzone.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('reference/data-types/datatype-currentzone.md') }} + +<h2>Members</h2> +{% + include-markdown "reference/data-types/datatype-currentzone.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "reference/data-types/datatype-currentzone.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Usage ``` From f83846c277cef47e6edbee026c149ddc9ed567d0 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 30 Jul 2025 13:42:28 -0500 Subject: [PATCH 23/41] updating general guides --- reference/general/slot-names.md | 17 +- reference/general/spa-list.md | 1058 +++++++++++++++-------------- reference/general/spawn-search.md | 2 +- 3 files changed, 548 insertions(+), 529 deletions(-) diff --git a/reference/general/slot-names.md b/reference/general/slot-names.md index 3f88851e4..5729757ce 100644 --- a/reference/general/slot-names.md +++ b/reference/general/slot-names.md @@ -3,7 +3,7 @@ ## ItemSlot & ItemSlot2 -These are not top level objects they are only members of [DataType:item](../data-types/datatype-item.md) +These are not top level objects they are only members of [DataType item](../data-types/datatype-item.md) ### ItemSlot Diagram @@ -129,6 +129,12 @@ InvSlot Inventory | **30** | pack8 | | **31** | pack9 | | **32** | pack10 | +| **33** | pack11 | +| **34** | pack12 | +| **35** | cursor | + +#### Subindex +A slot within a bag is referred to as a subindex. Bag slot numbers start at 0, left to right, top to bottom. e.g. To use an item the 2nd slot in pack5, you'd type `/useitem 27 1` ### Bank Slots @@ -160,6 +166,10 @@ InvSlot Inventory | **2023** | bank24 | | **2500** | sharedbank1 | | **2501** | sharedbank2 | +| **2502** | sharedbank3 | +| **2503** | sharedbank4 | +| **2504** | sharedbank5 | +| **2505** | sharedbank6 | ### Trade Slots @@ -430,3 +440,8 @@ InvSlot Inventory | **8028** | inspect29 | | **8029** | inspect30 | | **8030** | inspect31 | + +## See also + +* [DataType:item](../data-types/datatype-item.md) +* [TLO:FindItem](../top-level-objects/tlo-finditem.md) diff --git a/reference/general/spa-list.md b/reference/general/spa-list.md index 372b0e86c..f4ccbbc26 100644 --- a/reference/general/spa-list.md +++ b/reference/general/spa-list.md @@ -1,532 +1,536 @@ # SPA List -Spell Affects (yea they have bad engrish) -Spell Effects -Source Info (Updated 2018-12) +A list of every SPA (spell affect), an internal EverQuest term. While divulging this list, developers explained that every spell has an <strong>a</strong>ffect which determines the spell <strong>e</strong>ffect(s). ([source](https://forums.daybreakgames.com/eq/index.php?threads/enumerated-spa-list.206288/page-2#post-3101174)) While SPA lists have been [documented](https://forums.daybreakgames.com/eq/index.php?threads/enumerated-spa-list.206288/) [elsewhere](https://everquest.fanra.info/wiki/SPA_list), this specific list is formatted for MacroQuest ([MQ2Spells.cpp](https://github.com/macroquest/macroquest/blob/master/src/main/MQ2Spells.cpp#L205)). -```text -AFFECTNUMBER - AFFECTNAME -0 - HP -1 - AC -2 - Attack Power -3 - Movement Rate -4 - STR -5 - DEX -6 - AGI -7 - STA -8 - INT -9 - WIS -10 - CHA -11 - Melee Speed -12 - Invisibility -13 - See Invis -14 - Enduring Breath -15 - Mana -16 - NPC-Frenzy -17 - NPC-Awareness -18 - NPC Aggro -19 - NPC Faction -20 - Blindness -21 - Stun -22 - Charm -23 - Fear -24 - Fatigue -25 - Bind Affinity -26 - Gate -27 - Dispel Magic -28 - Invis Vs Undead -29 - Invis Vs Animals -30 - NPC-ReactRange -31 - Enthrall (Mez) -32 - Create Item -33 - Spawn NPC -34 - Confuse -35 - Disease -36 - Poison -37 - DetectHostile -38 - DetectMagic -39 - NoTwincast -40 - Invulnerability -41 - Banish -42 - Shadow Step -43 - Berserk -44 - Lycanthropy -45 - Vampirism -46 - Resist Fire -47 - Resist Cold -48 - Resist Poison -49 - Resist Disease -50 - Resist Magic -51 - Detect (Switch) Traps -52 - Detect Undead -53 - Detect Summoned -54 - Detect Animals -55 - Stoneskin -56 - True North -57 - Levitation -58 - Change Form -59 - Damage Attackers (DS) -60 - TransferItem -61 - Identify -62 - Item ID -63 - NPC-WipeHatelist -64 - Spin Stun -65 - Infravision -66 - Ultravision -67 - NPC-POV -68 - Reclaim Energy -69 - Max HP -70 - CorpseBomb -71 - Create Undead -72 - PreserveCorpse -73 - TargetsView -74 - FeignDeath -75 - Ventriloquism -76 - Sentinel -77 - LocateCorpse -78 - SpellShield -79 - InstantHP -80 - Enchant:Light -81 - Resurrect -82 - Summon Target -83 - Portal -84 - Hp-NPC-ONLY -85 - Contact Ability (Melee Proc) -86 - NPC-Help-Radius -87 - Telescope -88 - Combat Portal -89 - Height -90 - IgnorePet -91 - SummonCorpse -92 - Hate (On Spell Land) -93 - WeatherControl -94 - Fragile -95 - Sacrifice -96 - Silence -97 - Max Mana -98 - Bard Haste -99 - Root -100 - HP Duration Only -101 - Complete Heal (Residual Buff) -102 - Pet No Fear -103 - Summon Pet -104 - Translocate -105 - Anti-Gate (NPC Only) -106 - BeastLordPet -107 - Alter Pet Level -108 - Familiar -109 - CreateItemInBag -110 - Removed (Archery RNG Acc%) -111 - Resistances -112 - Adjust Casting Skill (Fizzles) -113 - SummonMount -114 - Modify Hate -115 - Cornucopia -116 - Curse -117 - HitMagic -118 - Amplification -119 - BardHaste2 -120 - HealMod -121 - IronMaiden -122 - ReduceSkill -123 - Immunity -124 - Fc_Damage_% -125 - Fc_HealMod -126 - Fc_ResistMod -127 - Fc_CastTimeMod1 -128 - Fc_DurationMod -129 - Fc_RangeMod -130 - Fc_HateMod -131 - Fc_ReagentMod -132 - Fc_ManaMod -133 - Fc_StunTimeMod -134 - Ff_LevelMax -135 - Ff_ResistType -136 - Ff_TargetType -137 - Ff_WhichSPA -138 - Ff_Beneficial -139 - Ff_WhichSpellID -140 - Ff_DurationMin -141 - Ff_InstantOnly -142 - Ff_LevelMin -143 - Ff_CastTimeMin -144 - Ff_CastTimeMax -145 - Portal NPC Warder Banish -146 - Portal Locations -147 - Percent Heal -148 - StackingBlocker -149 - StripVirtualSlot -150 - Divine Intervention/Death Pact -151 - PocketPet -152 - PetSwarm -153 - Damage Balance -154 - Cancel Negative -155 - PoP Resurrect -156 - Mirror Form -157 - Feedback -158 - Reflect -159 - Mod all Stats -160 - Inebriation | Sobriety -161 - Spell Guard -162 - Melee Guard -163 - Absorb Hit -164 - Object - Sense Trap -165 - Object - Disarm Trap -166 - Object - Picklock -167 - Fc_Pet -168 - Defensive -169 - Critical Melee (PC Only) -170 - Spell Crit Damage -171 - Crippling Blow -172 - Evasion -173 - Riposte -174 - Dodge -175 - Parry -176 - Dual Wield -177 - Double Attack -178 - Melee Resource Drain -179 - Puretone -180 - Sanctification -181 - Fearless -182 - Hundred Hands -183 - UNUSED - Skill Increase Chance -184 - Accuracy % -185 - Skill Damage Mod 1 -186 - Min Damage Done Mod -187 - Mana Balance -188 - Block -189 - Endurance -190 - Max Endurance -191 - Amnesia -192 - Hate (Duration Only) -193 - Skill Attack -194 - Fade -195 - Stun Resist (Melee+Spell) -196 - Deprecated (strikethrough) -197 - Skill Damage Taken Incoming -198 - Instant Endurance -199 - Taunt -200 - Weapon Proc Chance -201 - Ranged Proc -202 - IllusionOther -203 - MassBuff -204 - Group Fear Immunity -205 - AE Rampage Instant (PC Only) -206 - AE Taunt -207 - Flesh to Bone -208 - Purge Poison -209 - Cancel Beneficial -210 - Shield Caster -211 - AE Melee (PC Only) -212 - Fc_FrenziedDevastation -213 - Pet % HP -214 - HP Max Percent -215 - Pet Avoidance % -216 - Melee Accuracy Amt -217 - Headshot -218 - Pet Crit Melee Chance (Owner) -219 - Slay Undead -220 - Skill Min_Damage Amt 1 -221 - ReduceWeight -222 - BlockBehind -223 - Double Riposte -224 - AddRiposte -225 - Give Double Attack -226 - 2hbash -227 - ReduceSkillTimer -228 - ReduceFallDmg -229 - CastThroughStun -230 - Increase Shield Distance -231 - StunBashChance -232 - Divine Save -233 - Metabolism -234 - Poison Mastery -235 - FocusChannelling -236 - Free Pet -237 - PetAffinity -238 - Permanent Illusion -239 - Stonewall -240 - String Unbreakable -241 - Improve Reclaim Energy -242 - IncreaseChanceMemwipe -243 - NoBreakCharmChance -244 - RootBreakChance -245 - Trap Circumvention -246 - Lung Capacity -247 - IncreaseSkillCap -248 - ExtraSpecialization -249 - Offhand Weapon MinDamage Bonus -250 - Increase ContactAbility Chance -251 - EndlessQuiver -252 - Backstab FullDamage From Front -253 - Chaotic Stab -254 - NoSpell -255 - Shielding Duration Mod -256 - Shroud of Stealth -257 - DEPRECATED - GivePetHold -258 - Triple Backstab -259 - ACLimitMod -260 - AddInstrumentMod -261 - SongModCap -262 - StatsCap -263 - TradeskillMasteries -264 - ReduceAATimer -265 - NoFizzle -266 - AddExtraAttack% (2h) -267 - AddPetCommands -268 - AlcFailRate -269 - Bandage Max HP Limit % -270 - Bard Song Beneficial Radius % -271 - BaseRunMod -272 - Bard Song Level -273 - Critical DoT -274 - CriticalHeal -275 - Critical Mend % -276 - DualWieldAmt -277 - ExtraDIChance -278 - FinishingBlow -279 - FlurryChance (PC Only) -280 - Pet Flurry Chance (Owner) -281 - GivePetFeign -282 - Increase Bandage Heal % -283 - SpecialAttackChain -284 - LoHSetHeal -285 - Allow Hide/Evade While Moving -286 - Fc_Damage_Amt -287 - Fc_DurationMod (static) -288 - Add Proc Hit (AA) -289 - Doom Duration -290 - Increase Movement Cap -291 - Purify -292 - Strikethrough -293 - StunResist2 (Melee) -294 - Spell Crit Chance -295 - ReduceTimerSpecial -296 - Fc_Spell_Damage_%_Incoming -297 - Fc_Spell_Damage_Amt_Incoming -298 - Height (Small) -299 - Wake the Dead 1 (Corpse Class) -300 - Doppelganger -301 - Increase Range Damage -302 - Fc_Damage_%_Crit -303 - Fc_Damage_Amt_Crit -304 - Secondary Riposte Mod -305 - Mitigate Damage Shield Offhand -306 - Wake the Dead 2 (File Class) -307 - Appraisal -308 - Zone Suspend Minion -309 - Teleport Caster's Bindpoint -310 - Fc_ReuseTimer -311 - Ff_CombatSkill -312 - Observer -313 - Forage Master -314 - Improved Invis -315 - Improved Invis Undead -316 - Improved Invis Animals -317 - Worn Regen Cap -318 - Worn Mana Regen Cap -319 - Critical HP Regen -320 - Shield Block Chance -321 - Reduce Target Hate -322 - Gate Starting City -323 - Defensive Proc -324 - HP for Mana -325 - No Break AE Sneak -326 - Spell Slots -327 - Buff Slots -328 - Negative HP Limit -329 - Mana Absorb % Damage -330 - Critical Melee Damage Mod -331 - Alchemy Item Recovery -332 - Summon to Corpse -333 - Doom Rune Consumed -334 - HP No Move -335 - Fc_Immunity_Focus -336 - Illusionary Target -337 - Increase Exp % -338 - Expedient Recovery -339 - Fc_CastProc -340 - Chance Spell -341 - Worn Attack Cap -342 - No Panic -343 - Spell Interrupt -344 - Item Channeling -345 - Assassinate Max Level / Chance -346 - Headshot Max -347 - Double Ranged Attack -348 - Ff_Mana_Min -349 - Increase Damage With Shield -350 - Manaburn -351 - Spawn Interactive Object -352 - Increase Trap Count -353 - Increase SOI Count -354 - Deactivate All Traps -355 - Learn Trap -356 - Change Trigger Type -357 - Fc_Mute -358 - Instant Mana -359 - Passive Sense Trap -360 - Proc On Kill Shot -361 - Proc On Death -362 - Potion Belt -363 - Bandolier -364 - AddTripleAttackChance -365 - Proc On Spell Kill Shot -366 - Group Shielding -367 - Modify Body Type -368 - Modify Faction -369 - Corruption -370 - ResistCorruption -371 - Slow -372 - Grant Foraging -373 - Doom Always -374 - Trigger Spell -375 - Critical DoT Damage Mod % -376 - Fling -377 - Removed (Doom Entity) -378 - Resist Other SPA -379 - Directional Shadowstep -380 - Knockback Explosive (PC Only) -381 - Fling Target to Caster -382 - Suppression -383 - Fc_CastProcNormalized -384 - Fling Caster to Target -385 - Ff_WhichSpellGroup -386 - Doom Dispeller -387 - Doom Dispelled -388 - Summon All Corpses -389 - Fc_Timer_Refresh -390 - Fc_Timer_Lockout -391 - Ff_Mana_Max -392 - Fc_Heal_Amt -393 - Fc_Heal_%_Incoming -394 - Fc_Heal_Amt_Incoming -395 - Fc_Heal_%_Crit -396 - Fc_Heal_Amt_Crit -397 - Pet Add AC -398 - Fc_Swarm_Pet_Duration -399 - Fc_Twincast -400 - Healburn -401 - Mana Ignite -402 - Endurance Ignite -403 - Ff_SpellClass -404 - Ff_SpellSubclass -405 - Staff Block Chance -406 - Doom Limit Use -407 - Doom Focus Used -408 - Limit HP -409 - Limit Mana -410 - Limit Endurance -411 - Ff_ClassPlayer -412 - Ff_Race -413 - Fc_BaseEffects -414 - Ff_CastingSkill -415 - Ff_ItemClass -416 - AC_2 -417 - Mana_2 -418 - Skill Min_Damage Amt 2 -419 - Contact Ability 2 (Melee Proc) -420 - Fc_Limit_Use -421 - Fc_Limit_Use_Amt -422 - Ff_Limit_Use_Min -423 - Ff_Limit_Use_Type -424 - Gravitate -425 - Fly -426 - AddExtTargetSlots -427 - Skill Proc (Attempt) -428 - Proc Skill Modifier -429 - Skill Proc (Success) -430 - PostEffect -431 - PostEffectData -432 - ExpandMaxActiveTrophyBenefits -433 - Normalized Skill Min_Dmg Amt 1 -434 - Normalized Skill Min_Dmg Amt 2 -435 - Fragile Defense -436 - Toggle Freeze Buff Timers -437 - Teleport to Anchor -438 - Translocate to Anchor -439 - Assassinate Chance / DMG -440 - FinishingBlowMax -441 - Distance Removal -442 - Doom Req Bearer -443 - Doom Req Caster -444 - Improved Taunt -445 - Add Merc Slot -446 - A_Stacker -447 - B_Stacker -448 - C_Stacker -449 - D_Stacker -450 - DoT Guard -451 - Melee Threshold Guard -452 - Spell Threshold Guard -453 - Doom Melee Threshold -454 - Doom Spell Threshold -455 - Add Hate % (On Land) -456 - Add Hate Over Time % -457 - Resource Tap -458 - Faction Mod % -459 - Skill Damage Mod 2 -460 - Ff_Override_NotFocusable -461 - Fc_Damage_%_Crit 2 -462 - Fc_Damage_Amt 2 -463 - Shield Target -464 - PC Pet Rampage -465 - PC Pet AE Rampage -466 - PC Pet Flurry Chance -467 - DS Mitigation Amount -468 - DS Mitigation Percentage -469 - Chance Best in Spell Group -470 - Trigger Best in Spell Group -471 - Double Melee Round (PC Only) -472 - Buy AA Rank -473 - Double Backstab From Front -474 - Pet Crit Melee Damage% (Owner) -475 - Trigger Spell Non-Item -476 - Weapon Stance -477 - Hatelist To Top Index -478 - Hatelist To Tail Index -479 - Ff_Value_Min -480 - Ff_Value_Max -481 - Fc_Cast_Spell_On_Land -482 - Skill Base Damage Mod -483 - Fc_Spell_Damage_%_IncomingPC -484 - Fc_Spell_Damage_Amt_IncomingPC -485 - Ff_CasterClass -486 - Ff_Same_Caster -487 - Extend Tradeskill Cap -488 - Defender Melee Force % (PC) -489 - Worn Endurance Regen Cap -490 - Ff_ReuseTimeMin -491 - Ff_ReuseTimeMax -492 - Ff_Endurance_Min -493 - Ff_Endurance_Max -494 - Pet Add Atk -495 - Ff_DurationMax -496 - Critical Melee Damage Mod Max -497 - Ff_FocusCastProcNoBypass -498 - AddExtraAttack% (1h-Primary) -499 - AddExtraAttack% (1h-Secondary) -500 - Fc_CastTimeMod2 -501 - Fc_CastTimeAmt -502 - Fearstun -503 - Melee Damage Position Mod -504 - Melee Damage Position Amt -505 - Damage Taken Position Mod -506 - Damage Taken Position Amt -507 - Fc_Amplify_Mod -508 - Fc_Amplify_Amt -509 - Health Transfer -510 - Fc_ResistIncoming -511 - Ff_FocusTimerMin -512 - Proc Timer Modifier -513 - Mana Max Percent -514 - Endurance Max Percent -515 - AC Avoidance Max Percent -516 - AC Mitigation Max Percent -517 - Attack Offense Max Percent -518 - Attack Accuracy Max Percent -519 - Luck Amount -520 - Luck Percent -``` +## Affect number | Affect_name | Notes +```text +0 - HP +1 - AC +2 - ATTACK_POWER +3 - MOVEMENT_RATE +4 - STR +5 - DEX +6 - AGI +7 - STA +8 - INT +9 - WIS +10 - CHA +11 - HASTE (Melee Speed) +12 - INVISIBILITY +13 - SEE_INVIS +14 - ENDURING_BREATH +15 - MANA +16 - NPC_FRENZY +17 - NPC_AWARENESS +18 - NPC_AGGRO +19 - NPC_FACTION +20 - BLINDNESS +21 - STUN +22 - CHARM +23 - FEAR +24 - FATIGUE +25 - BIND_AFFINITY +26 - GATE +27 - DISPEL_MAGIC +28 - INVIS_VS_UNDEAD +29 - INVIS_VS_ANIMALS +30 - NPC_AGGRO_RADIUS (NPC-ReactRange) +31 - ENTHRALL (Mez) +32 - CREATE_ITEM +33 - SUMMON_PET (Spawn NPC) +34 - CONFUSE +35 - DISEASE +36 - POISON +37 - DETECT_HOSTILE +38 - DETECT_MAGIC +39 - NO_TWINCAST +40 - INVULNERABILITY +41 - BANISH +42 - SHADOW_STEP +43 - BERSERK +44 - LYCANTHROPY +45 - VAMPIRISM +46 - RESIST_FIRE +47 - RESIST_COLD +48 - RESIST_POISON +49 - RESIST_DISEASE +50 - RESIST_MAGIC +51 - DETECT_TRAPS (Detect Switch Traps) +52 - DETECT_UNDEAD +53 - DETECT_SUMMONED +54 - DETECT_ANIMALS +55 - STONESKIN +56 - TRUE_NORTH +57 - LEVITATION +58 - CHANGE_FORM +59 - DAMAGE_SHIELD (Damage Attackers, DS) +60 - TRANSFER_ITEM +61 - ITEM_LORE (Identify) +62 - ITEM_IDENTIFY +63 - NPC_WIPE_HATE_LIST +64 - SPIN_STUN +65 - INFRAVISION +66 - ULTRAVISION +67 - EYE_OF_ZOMM (NPC-POV) +68 - RECLAIM_ENERGY +69 - MAX_HP +70 - CORPSE_BOMB +71 - CREATE_UNDEAD +72 - PRESERVE_CORPSE +73 - BIND_SIGHT (TargetsView) +74 - FEIGN_DEATH +75 - VENTRILOQUISM +76 - SENTINEL +77 - LOCATE_CORPSE +78 - SPELL_SHIELD +79 - INSTANT_HP +80 - ENCHANT_LIGHT +81 - RESURRECT +82 - SUMMON_TARGET +83 - PORTAL +84 - HP_NPC_ONLY +85 - MELEE_PROC (Contact Ability) +86 - NPC_HELP_RADIUS +87 - MAGNIFICATION (Telescope) +88 - EVACUATE (Combat Portal) +89 - HEIGHT +90 - IGNORE_PET +91 - SUMMON_CORPSE +92 - HATE (On Spell Land) +93 - WEATHER_CONTROL +94 - FRAGILE +95 - SACRIFICE +96 - SILENCE +97 - MAX_MANA +98 - BARD_HASTE +99 - ROOT +100 - HEALDOT (HP Duration Only) +101 - COMPLETEHEAL (Complete Heal Residual Buff) +102 - PET_FEARLESS (Pet No Fear) +103 - CALL_PET (Summon Pet) +104 - TRANSLOCATE +105 - NPC_ANTI_GATE (Anti-Gate NPC Only) +106 - BEASTLORD_PET +107 - ALTER_PET_LEVEL +108 - FAMILIAR +109 - CREATE_ITEM_IN_BAG +110 - ARCHERY (Removed - Archery RNG Acc%) +111 - RESIST_ALL (Resistances) +112 - FIZZLE_SKILL (Adjust Casting Skill - Fizzles) +113 - SUMMON_MOUNT +114 - MODIFY_HATE +115 - CORNUCOPIA +116 - CURSE +117 - HIT_MAGIC +118 - AMPLIFICATION +119 - ATTACK_SPEED_MAX (BardHaste2) +120 - HEALMOD +121 - IRONMAIDEN +122 - REDUCESKILL +123 - IMMUNITY +124 - FOCUS_DAMAGE_MOD (Fc_Damage_%) +125 - FOCUS_HEAL_MOD +126 - FOCUS_RESIST_MOD +127 - FOCUS_CAST_TIME_MOD (Fc_CastTimeMod1) +128 - FOCUS_DURATION_MOD +129 - FOCUS_RANGE_MOD +130 - FOCUS_HATE_MOD +131 - FOCUS_REAGENT_MOD +132 - FOCUS_MANACOST_MOD (Fc_ManaMod) +133 - FOCUS_STUNTIME_MOD +134 - FOCUS_LEVEL_MAX (Ff_LevelMax) +135 - FOCUS_RESIST_TYPE (Ff_ResistType) +136 - FOCUS_TARGET_TYPE (Ff_TargetType) +137 - FOCUS_WHICH_SPA (Ff_WhichSPA) +138 - FOCUS_BENEFICIAL (Ff_Beneficial) +139 - FOCUS_WHICH_SPELL (Ff_WhichSpellID) +140 - FOCUS_DURATION_MIN (Ff_DurationMin) +141 - FOCUS_INSTANT_ONLY (Ff_InstantOnly) +142 - FOCUS_LEVEL_MIN (Ff_LevelMin) +143 - FOCUS_CASTTIME_MIN (Ff_CastTimeMin) +144 - FOCUS_CASTTIME_MAX (Ff_CastTimeMax) +145 - NPC_PORTAL_WARDER_BANISH (Portal NPC Warder Banish) +146 - PORTAL_LOCATIONS +147 - PERCENT_HEAL +148 - STACKING_BLOCK (StackingBlocker) +149 - STRIP_VIRTUAL_SLOT +150 - DIVINE_INTERVENTION (Divine Intervention/Death Pact) +151 - POCKET_PET +152 - PET_SWARM +153 - HEALTH_BALANCE (Damage Balance) +154 - CANCEL_NEGATIVE_MAGIC (Cancel Negative) +155 - POP_RESURRECT +156 - MIRROR (Mirror Form) +157 - FEEDBACK +158 - REFLECT +159 - MODIFY_ALL_STATS (Mod all Stats) +160 - CHANGE_SOBRIETY (Inebriation | Sobriety) +161 - SPELL_GUARD +162 - MELEE_GUARD +163 - ABSORB_HIT +164 - OBJECT_SENSE_TRAP +165 - OBJECT_DISARM_TRAP +166 - OBJECT_PICKLOCK +167 - FOCUS_PET (Fc_Pet) +168 - DEFENSIVE +169 - CRITICAL_MELEE (PC Only) +170 - CRITICAL_SPELL (Spell Crit Damage) +171 - CRIPPLING_BLOW +172 - EVASION +173 - RIPOSTE +174 - DODGE +175 - PARRY +176 - DUAL_WIELD +177 - DOUBLE_ATTACK +178 - MELEE_LIFETAP (Melee Resource Drain) +179 - PURETONE +180 - SANCTIFICATION +181 - FEARLESS +182 - HUNDRED_HANDS +183 - SKILL_INCREASE_CHANCE (UNUSED) +184 - ACCURACY (Accuracy %) +185 - SKILL_DAMAGE_MOD (Skill Damage Mod 1) +186 - MIN_DAMAGE_DONE_MOD +187 - MANA_BALANCE +188 - BLOCK +189 - ENDURANCE +190 - INCREASE_MAX_ENDURANCE (Max Endurance) +191 - AMNESIA +192 - HATE_OVER_TIME (Hate Duration Only) +193 - SKILL_ATTACK +194 - FADE +195 - STUN_RESIST (Melee+Spell) +196 - STRIKETHROUGH1 (Deprecated) +197 - SKILL_DAMAGE_TAKEN (Skill Damage Taken Incoming) +198 - INSTANT_ENDURANCE +199 - TAUNT +200 - PROC_CHANCE (Weapon Proc Chance) +201 - RANGE_ABILITY (Ranged Proc) +202 - ILLUSION_OTHERS +203 - MASS_GROUP_BUFF (MassBuff) +204 - GROUP_FEAR_IMMUNITY +205 - RAMPAGE (AE Rampage Instant PC Only) +206 - AE_TAUNT +207 - FLESH_TO_BONE +208 - PURGE_POISON +209 - CANCEL_BENEFICIAL +210 - SHIELD_CASTER +211 - DESTRUCTIVE_FORCE (AE Melee PC Only) +212 - FOCUS_FRENZIED_DEVASTATION (Fc_FrenziedDevastation) +213 - PET_PCT_MAX_HP (Pet % HP) +214 - HP_MAX_HP (HP Max Percent) +215 - PET_PCT_AVOIDANCE (Pet Avoidance %) +216 - MELEE_ACCURACY (Melee Accuracy Amt) +217 - HEADSHOT +218 - PET_CRIT_MELEE (Pet Crit Melee Chance Owner) +219 - SLAY_UNDEAD +220 - INCREASE_SKILL_DAMAGE (Skill Min_Damage Amt 1) +221 - REDUCE_WEIGHT +222 - BLOCK_BEHIND +223 - DOUBLE_RIPOSTE +224 - ADD_RIPOSTE +225 - GIVE_DOUBLE_ATTACK +226 - 2H_BASH (2hbash) +227 - REDUCE_SKILL_TIMER +228 - ACROBATICS (ReduceFallDmg) +229 - CAST_THROUGH_STUN +230 - EXTENDED_SHIELDING (Increase Shield Distance) +231 - BASH_CHANCE (StunBashChance) +232 - DIVINE_SAVE +233 - METABOLISM +234 - POISON_MASTERY +235 - FOCUS_CHANNELING (FocusChannelling) +236 - FREE_PET +237 - PET_AFFINITY +238 - PERM_ILLUSION (Permanent Illusion) +239 - STONEWALL +240 - STRING_UNBREAKABLE +241 - IMPROVE_RECLAIM_ENERGY +242 - INCREASE_CHANGE_MEMWIPE (IncreaseChanceMemwipe) +243 - ENHANCED_CHARM (NoBreakCharmChance) +244 - ENHANCED_ROOT (RootBreakChance) +245 - TRAP_CIRCUMVENTION +246 - INCREASE_AIR_SUPPLY (Lung Capacity) +247 - INCREASE_MAX_SKILL (IncreaseSkillCap) +248 - EXTRA_SPECIALIZATION +249 - OFFHAND_MIN_WEAPON_DAMAGE (Offhand Weapon MinDamage Bonus) +250 - INCREASE_PROC_CHANCE (Increase ContactAbility Chance) +251 - ENDLESS_QUIVER +252 - BACKSTAB_FRONT (Backstab FullDamage From Front) +253 - CHAOTIC_STAB +254 - NOSPELL +255 - SHIELDING_DURATION_MOD +256 - SHROUD_OF_STEALTH +257 - GIVE_PET_HOLD (DEPRECATED) +258 - TRIPLE_BACKSTAB +259 - AC_LIMIT_MOD +260 - ADD_INSTRUMENT_MOD +261 - SONG_MOD_CAP +262 - INCREASE_STAT_CAP (StatsCap) +263 - TRADESKILL_MASTERY (TradeskillMasteries) +264 - REDUCE_AA_TIMER +265 - NO_FIZZLE +266 - ADD_2H_ATTACK_CHANCE (AddExtraAttack% 2h) +267 - ADD_PET_COMMANDS +268 - ALCHEMY_FAIL_RATE +269 - FIRST_AID (Bandage Max HP Limit %) +270 - EXTEND_SONG_RANGE (Bard Song Beneficial Radius %) +271 - BASE_RUN_MOD +272 - INCREASE_CASTING_LEVEL (Bard Song Level) +273 - DOTCRIT (Critical DoT) +274 - HEALCRIT (CriticalHeal) +275 - MENDCRIT (Critical Mend %) +276 - DUAL_WIELD_AMT +277 - EXTRA_DI_CHANCE +278 - FINISHING_BLOW +279 - FLURRY (FlurryChance PC Only) +280 - PET_FLURRY (Pet Flurry Chance Owner) +281 - PET_FEIGN (GivePetFeign) +282 - INCREASE_BANDAGE_AMT (Increase Bandage Heal %) +283 - WU_ATTACK (SpecialAttackChain) +284 - IMPROVE_LOH (LoHSetHeal) +285 - NIMBLE_EVASION (Allow Hide/Evade While Moving) +286 - FOCUS_DAMAGE_AMT +287 - FOCUS_DURATION_AMT (Fc_DurationMod static) +288 - ADD_PROC_HIT (AA) +289 - DOOM_EFFECT (Doom Duration) +290 - INCREASE_RUN_SPEED_CAP (Increase Movement Cap) +291 - PURIFY +292 - STRIKETHROUGH +293 - STUN_RESIST2 (Melee) +294 - SPELL_CRIT_CHANCE +295 - REDUCE_SPECIAL_TIMER (ReduceTimerSpecial) +296 - FOCUS_DAMAGE_MOD_DETRIMENTAL (Fc_Spell_Damage_%_Incoming) +297 - FOCUS_DAMAGE_AMT_DETRIMENTAL (Fc_Spell_Damage_Amt_Incoming) +298 - TINY_COMPANION (Height Small) +299 - WAKE_DEAD (Wake the Dead 1 Corpse Class) +300 - DOPPELGANGER +301 - INCREASE_RANGE_DMG +302 - FOCUS_DAMAGE_MOD_CRIT (Fc_Damage_%_Crit) +303 - FOCUS_DAMAGE_AMT_CRIT +304 - SECONDARY_RIPOSTE_MOD +305 - DAMAGE_SHIELD_MOD (Mitigate Damage Shield Offhand) +306 - WEAK_DEAD_2 (Wake the Dead 2 File Class) +307 - APPRAISAL +308 - ZONE_SUSPEND_MINION +309 - TELEPORT_CASTERS_BINDPOINT (Teleport Caster's Bindpoint) +310 - FOCUS_REUSE_TIMER (Fc_ReuseTimer) +311 - FOCUS_COMBAT_SKILL (Ff_CombatSkill) +312 - OBSERVER +313 - FORAGE_MASTER +314 - IMPROVED_INVIS +315 - IMPROVED_INVIS_UNDEAD +316 - IMPROVED_INVIS_ANIMALS +317 - INCREASE_WORN_HP_REGEN_CAP (Worn Regen Cap) +318 - INCREASE_WORN_MANA_REGEN_CAP (Worn Mana Regen Cap) +319 - CRITICAL_HP_REGEN +320 - SHIELD_BLOCK_CHANCE +321 - REDUCE_TARGET_HATE +322 - GATE_STARTING_CITY +323 - DEFENSIVE_PROC +324 - HP_FOR_MANA +325 - NO_BREAK_AE_SNEAK +326 - ADD_SPELL_SLOTS (Spell Slots) +327 - ADD_BUFF_SLOTS (Buff Slots) +328 - INCREASE_NEGATIVE_HP_LIMIT (Negative HP Limit) +329 - MANA_ABSORB_PCT_DMG (Mana Absorb % Damage) +330 - CRIT_ATTACK_MODIFIER (Critical Melee Damage Mod) +331 - FAIL_ALCHEMY_ITEM_RECOVERY (Alchemy Item Recovery) +332 - SUMMON_TO_CORPSE +333 - DOOM_RUNE_EFFECT (Doom Rune Consumed) +334 - NO_MOVE_HP (HP No Move) +335 - FOCUSED_IMMUNITY (Fc_Immunity_Focus) +336 - ILLUSIONARY_TARGET +337 - INCREASE_EXP_MOD (Increase Exp %) +338 - EXPEDIENT_RECOVERY +339 - FOCUS_CASTING_PROC (Fc_CastProc) +340 - CHANCE_SPELL +341 - WORN_ATTACK_CAP +342 - NO_PANIC +343 - SPELL_INTERRUPT +344 - ITEM_CHANNELING +345 - ASSASSINATE_MAX_LEVEL (Assassinate Max Level / Chance) +346 - HEADSHOT_MAX_LEVEL (Headshot Max) +347 - DOUBLE_RANGED_ATTACK +348 - FOCUS_MANA_MIN (Ff_Mana_Min) +349 - INCREASE_SHIELD_DMG (Increase Damage With Shield) +350 - MANABURN +351 - SPAWN_INTERACTIVE_OBJECT +352 - INCREASE_TRAP_COUNT +353 - INCREASE_SOI_COUNT +354 - DEACTIVATE_ALL_TRAPS +355 - LEARN_TRAP +356 - CHANGE_TRIGGER_TYPE +357 - FOCUS_MUTE (Fc_Mute) +358 - INSTANT_MANA +359 - PASSIVE_SENSE_TRAP +360 - PROC_ON_KILL_SHOT +361 - PROC_ON_DEATH +362 - POTION_BELT +363 - BANDOLIER +364 - ADD_TRIPLE_ATTACK_CHANCE +365 - PROC_ON_SPELL_KILL_SHOT +366 - GROUP_SHIELDING +367 - MODIFY_BODY_TYPE +368 - MODIFY_FACTION +369 - CORRUPTION +370 - RESIST_CORRUPTION +371 - SLOW +372 - GRANT_FORAGING +373 - DOOM_ALWAYS +374 - TRIGGER_SPELL +375 - CRIT_DOT_DMG_MOD (Critical DoT Damage Mod %) +376 - FLING +377 - DOOM_ENTITY (Removed) +378 - RESIST_OTHER_SPA +379 - DIRECTIONAL_TELEPORT (Directional Shadowstep) +380 - EXPLOSIVE_KNOCKBACK (Knockback Explosive PC Only) +381 - FLING_TOWARD (Fling Target to Caster) +382 - SUPPRESSION +383 - FOCUS_CASTING_PROC_NORMALIZED (Fc_CastProcNormalized) +384 - FLING_AT (Fling Caster to Target) +385 - FOCUS_WHICH_GROUP (Ff_WhichSpellGroup) +386 - DOOM_DISPELLER +387 - DOOM_DISPELLEE (Doom Dispelled) +388 - SUMMON_ALL_CORPSES +389 - REFRESH_SPELL_TIMER (Fc_Timer_Refresh) +390 - LOCKOUT_SPELL_TIMER (Fc_Timer_Lockout) +391 - FOCUS_MANA_MAX (Ff_Mana_Max) +392 - FOCUS_HEAL_AMT +393 - FOCUS_HEAL_MOD_BENEFICIAL (Fc_Heal_%_Incoming) +394 - FOCUS_HEAL_AMT_BENEFICIAL (Fc_Heal_Amt_Incoming) +395 - FOCUS_HEAL_MOD_CRIT (Fc_Heal_%_Crit) +396 - FOCUS_HEAL_AMT_CRIT +397 - ADD_PET_AC (Pet Add AC) +398 - FOCUS_SWARM_PET_DURATION (Fc_Swarm_Pet_Duration) +399 - FOCUS_TWINCAST_CHANCE (Fc_Twincast) +400 - HEALBURN +401 - MANA_IGNITE +402 - ENDURANCE_IGNITE +403 - FOCUS_SPELL_CLASS (Ff_SpellClass) +404 - FOCUS_SPELL_SUBCLASS (Ff_SpellSubclass) +405 - STAFF_BLOCK_CHANCE +406 - DOOM_LIMIT_USE +407 - DOOM_FOCUS_USED +408 - LIMIT_HP +409 - LIMIT_MANA +410 - LIMIT_ENDURANCE +411 - FOCUS_LIMIT_CLASS (Ff_ClassPlayer) +412 - FOCUS_LIMIT_RACE (Ff_Race) +413 - FOCUS_BASE_EFFECTS +414 - FOCUS_LIMIT_SKILL (Ff_CastingSkill) +415 - FOCUS_LIMIT_ITEM_CLASS (Ff_ItemClass) +416 - AC2 +417 - MANA2 +418 - FOCUS_INCREASE_SKILL_DMG_2 (Skill Min_Damage Amt 2) +419 - PROC_EFFECT_2 (Contact Ability 2 Melee Proc) +420 - FOCUS_LIMIT_USE +421 - FOCUS_LIMIT_USE_AMT +422 - FOCUS_LIMIT_USE_MIN (Ff_Limit_Use_Min) +423 - FOCUS_LIMIT_USE_TYPE (Ff_Limit_Use_Type) +424 - GRAVITATE +425 - FLY +426 - ADD_EXTENDED_TARGET_SLOTS (AddExtTargetSlots) +427 - SKILL_PROC (Skill Proc Attempt) +428 - PROC_SKILL_MODIFIER +429 - SKILL_PROC_SUCCESS (Skill Proc Success) +430 - POST_EFFECT +431 - POST_EFFECT_DATA +432 - EXPAND_MAX_ACTIVE_TROPHY_BENEFITS (ExpandMaxActiveTrophyBenefits) +433 - ADD_NORMALIZED_SKILL_MIN_DMG_AMT (Normalized Skill Min_Dmg Amt 1) +434 - ADD_NORMALIZED_SKILL_MIN_DMG_AMT_2 (Normalized Skill Min_Dmg Amt 2) +435 - FRAGILE_DEFENSE +436 - FREEZE_BUFF_TIMER (Toggle Freeze Buff Timers) +437 - TELEPORT_TO_ANCHOR +438 - TRANSLOCATE_TO_ANCHOR +439 - ASSASSINATE (Assassinate Chance / DMG) +440 - FINISHING_BLOW_MAX +441 - DISTANCE_REMOVAL +442 - REQUIRE_TARGET_DOOM (Doom Req Bearer) +443 - REQUIRE_CASTER_DOOM (Doom Req Caster) +444 - IMPROVED_TAUNT +445 - ADD_MERC_SLOT +446 - STACKER_A +447 - STACKER_B +448 - STACKER_C +449 - STACKER_D +450 - DOT_GUARD +451 - MELEE_THRESHOLD_GUARD +452 - SPELL_THRESHOLD_GUARD +453 - MELEE_THRESHOLD_DOOM (Doom Melee Threshold) +454 - SPELL_THRESHOLD_DOOM (Doom Spell Threshold) +455 - ADD_HATE_PCT (Add Hate % On Land) +456 - ADD_HATE_OVER_TIME_PCT +457 - RESOURCE_TAP +458 - FACTION_MOD (Faction Mod %) +459 - SKILL_DAMAGE_MOD_2 +460 - OVERRIDE_NOT_FOCUSABLE (Ff_Override_NotFocusable) +461 - FOCUS_DAMAGE_MOD_2 (Fc_Damage_%_Crit 2) +462 - FOCUS_DAMAGE_AMT_2 +463 - SHIELD (Shield Target) +464 - PC_PET_RAMPAGE +465 - PC_PET_AE_RAMPAGE +466 - PC_PET_FLURRY (PC Pet Flurry Chance) +467 - DAMAGE_SHIELD_MITIGATION_AMT (DS Mitigation Amount) +468 - DAMAGE_SHIELD_MITIGATION_PCT (DS Mitigation Percentage) +469 - CHANCE_BEST_IN_SPELL_GROUP +470 - TRIGGER_BEST_IN_SPELL_GROUP +471 - DOUBLE_MELEE_ATTACKS (Double Melee Round PC Only) +472 - AA_BUY_NEXT_RANK (Buy AA Rank) +473 - DOUBLE_BACKSTAB_FRONT +474 - PET_MELEE_CRIT_DMG_MOD (Pet Crit Melee Damage% Owner) +475 - TRIGGER_SPELL_NON_ITEM +476 - WEAPON_STANCE +477 - HATELIST_TO_TOP (Hatelist To Top Index) +478 - HATELIST_TO_TAIL (Hatelist To Tail Index) +479 - FOCUS_LIMIT_MIN_VALUE (Ff_Value_Min) +480 - FOCUS_LIMIT_MAX_VALUE (Ff_Value_Max) +481 - FOCUS_CAST_SPELL_ON_LAND +482 - SKILL_BASE_DAMAGE_MOD +483 - FOCUS_INCOMING_DMG_MOD (Fc_Spell_Damage_%_IncomingPC) +484 - FOCUS_INCOMING_DMG_AMT (Fc_Spell_Damage_Amt_IncomingPC) +485 - FOCUS_LIMIT_CASTER_CLASS (Ff_CasterClass) +486 - FOCUS_LIMIT_SAME_CASTER (Ff_Same_Caster) +487 - EXTEND_TRADESKILL_CAP +488 - DEFENDER_MELEE_FORCE_PCT (Defender Melee Force % PC) +489 - WORN_ENDURANCE_REGEN_CAP +490 - FOCUS_MIN_REUSE_TIME (Ff_ReuseTimeMin) +491 - FOCUS_MAX_REUSE_TIME (Ff_ReuseTimeMax) +492 - FOCUS_ENDURANCE_MIN (Ff_Endurance_Min) +493 - FOCUS_ENDURANCE_MAX (Ff_Endurance_Max) +494 - PET_ADD_ATK +495 - FOCUS_DURATION_MAX (Ff_DurationMax) +496 - CRIT_MELEE_DMG_MOD_MAX (Critical Melee Damage Mod Max) +497 - FOCUS_CAST_PROC_NO_BYPASS (Ff_FocusCastProcNoBypass) +498 - ADD_EXTRA_PRIMARY_ATTACK_PCT (AddExtraAttack% 1h-Primary) +499 - ADD_EXTRA_SECONDARY_ATTACK_PCT (AddExtraAttack% 1h-Secondary) +500 - FOCUS_CAST_TIME_MOD2 +501 - FOCUS_CAST_TIME_AMT +502 - FEARSTUN +503 - MELEE_DMG_POSITION_MOD (Melee Damage Position Mod) +504 - MELEE_DMG_POSITION_AMT (Melee Damage Position Amt) +505 - DMG_TAKEN_POSITION_MOD (Damage Taken Position Mod) +506 - DMG_TAKEN_POSITION_AMT (Damage Taken Position Amt) +507 - AMPLIFY_MOD (Fc_Amplify_Mod) +508 - AMPLIFY_AMT (Fc_Amplify_Amt) +509 - HEALTH_TRANSFER +510 - FOCUS_RESIST_INCOMING +511 - FOCUS_TIMER_MIN (Ff_FocusTimerMin) +512 - PROC_TIMER_MOD (Proc Timer Modifier) +513 - MANA_MAX (Mana Max Percent) +514 - ENDURANCE_MAX (Endurance Max Percent) +515 - AC_AVOIDANCE_MAX (AC Avoidance Max Percent) +516 - AC_MITIGATION_MAX (AC Mitigation Max Percent) +517 - ATTACK_OFFENSE_MAX (Attack Offense Max Percent) +518 - ATTACK_ACCURACY_MAX (Attack Accuracy Max Percent) +519 - LUCK_AMT (Luck Amount) +520 - LUCK_PCT (Luck Percent) +521 - ENDURANCE_ABSORB_PCT_DMG +522 - INSTANT_MANA_PCT +523 - INSTANT_ENDURANCE_PCT +524 - DURATION_HP_PCT +525 - DURATION_MANA_PCT +526 - DURATION_ENDURANCE_PCT +``` \ No newline at end of file diff --git a/reference/general/spawn-search.md b/reference/general/spawn-search.md index 5a0feb0b4..2368a2463 100644 --- a/reference/general/spawn-search.md +++ b/reference/general/spawn-search.md @@ -1,6 +1,6 @@ # Spawn Search -All [Top-Level Objects](../top-level-objects/), [Data Types](../data-types/) and [Commands](../commands/) that support searching for spawns can take the following options: +All top-level objects, data types and commands that support searching for spawns can take the following options: | Parameter | Description | | :--- | :--- | From d2916155722b2f0cc623c80d2c01022f5f0d124b Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 30 Jul 2025 13:56:13 -0500 Subject: [PATCH 24/41] adding 'associated datatypes' to plugin TLOs --- plugins/core-plugins/autologin/index.md | 13 ------ .../core-plugins/autologin/tlo-autologin.md | 44 +++++++++++++++++++ .../core-plugins/bzsrch/bzsrch-tlo-bazaar.md | 44 +++++++++++++++++++ plugins/core-plugins/hud/README.md | 13 ------ .../itemdisplay/tlo-displayitem.md | 23 ++++++++++ 5 files changed, 111 insertions(+), 26 deletions(-) diff --git a/plugins/core-plugins/autologin/index.md b/plugins/core-plugins/autologin/index.md index 6dd4637da..ea1e11e75 100644 --- a/plugins/core-plugins/autologin/index.md +++ b/plugins/core-plugins/autologin/index.md @@ -248,19 +248,6 @@ Launch single sessions without logging in. trailing-newlines=false %} {{ readMore('plugins/core-plugins/autologin/tlo-autologin.md') }} -<h2>Forms</h2> -{% - include-markdown "plugins/core-plugins/autologin/tlo-autologin.md" - start="<!--tlo-forms-start-->" - end="<!--tlo-forms-end-->" - heading-offset=0 -%} -{% - include-markdown "plugins/core-plugins/autologin/tlo-autologin.md" - start="<!--tlo-linkrefs-start-->" - end="<!--tlo-linkrefs-end-->" -%} - ## Datatypes ## [AutoLogin](datatype-autologin.md) {% diff --git a/plugins/core-plugins/autologin/tlo-autologin.md b/plugins/core-plugins/autologin/tlo-autologin.md index 5a9e56a66..85a6a1939 100644 --- a/plugins/core-plugins/autologin/tlo-autologin.md +++ b/plugins/core-plugins/autologin/tlo-autologin.md @@ -14,6 +14,50 @@ Returns "AutoLogin" string when plugin is loaded, provides access to AutoLogin f : Returns "AutoLogin" string when plugin is loaded <!--tlo-forms-end--> +## Associated DataTypes + +## [AutoLogin](datatype-autologin.md) +{% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/autologin/datatype-autologin.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [LoginProfile](datatype-loginprofile.md) +{% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/autologin/datatype-loginprofile.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + ## Example ```text diff --git a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md index 3c1a25622..e780a6416 100644 --- a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md +++ b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md @@ -14,6 +14,50 @@ Provides access to bazaar search functionality and results. : TRUE if there are search results <!--tlo-forms-end--> +## Associated DataTypes + +## [Bazaar](bzsrch-datatype-bazaar.md) +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + +## [BazaarItem](bzsrch-datatype-bazaaritem.md) +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + <!--tlo-linkrefs-start--> [bazaar]: bzsrch-datatype-bazaar.md <!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/hud/README.md b/plugins/core-plugins/hud/README.md index 692a337a0..f4f35d629 100644 --- a/plugins/core-plugins/hud/README.md +++ b/plugins/core-plugins/hud/README.md @@ -171,16 +171,3 @@ RDPauseInd2=3,85,122,225,0,0,${RDPause} end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('plugins/core-plugins/hud/tlo-hud.md') }} - -<h2>Forms</h2> -{% - include-markdown "plugins/core-plugins/hud/tlo-hud.md" - start="<!--tlo-forms-start-->" - end="<!--tlo-forms-end-->" - heading-offset=0 -%} -{% - include-markdown "plugins/core-plugins/hud/tlo-hud.md" - start="<!--tlo-linkrefs-start-->" - end="<!--tlo-linkrefs-end-->" -%} diff --git a/plugins/core-plugins/itemdisplay/tlo-displayitem.md b/plugins/core-plugins/itemdisplay/tlo-displayitem.md index a04cf90eb..976d0f1d8 100644 --- a/plugins/core-plugins/itemdisplay/tlo-displayitem.md +++ b/plugins/core-plugins/itemdisplay/tlo-displayitem.md @@ -18,6 +18,29 @@ Gives information on item windows : Return the Item display window for the specified item name, if one exists. <!--tlo-forms-end--> +## Associated DataTypes + +## [DisplayItem](datatype-displayitem.md) +{% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-desc-start-->" + end="<!--dt-desc-end-->" + trailing-newlines=false +%} {{ readMore('plugins/core-plugins/itemdisplay/datatype-displayitem.md') }} + +<h2>Members</h2> +{% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 +%} +{% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" +%} + <!--tlo-linkrefs-start--> [DisplayItem]: datatype-displayitem.md <!--tlo-linkrefs-end--> From 94f135068883fbdb1d29955bfaae53cef7a2e719 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Mon, 18 Aug 2025 23:42:03 -0500 Subject: [PATCH 25/41] minor fixes and changes --- mkdocs.yml | 2 +- plugins/community-plugins/mq2events.md | 2 - reference/commands/advloot.md | 2 +- reference/commands/dosocial.md | 1 - reference/commands/keypress.md | 2 - reference/commands/location.md | 2 +- reference/commands/mercswitch.md | 2 +- reference/commands/pet.md | 4 +- reference/commands/setautorun.md | 2 +- reference/commands/target.md | 25 ++++++--- reference/commands/who.md | 54 +++++++++++-------- reference/data-types/datatype-alertlist.md | 2 +- reference/data-types/datatype-body.md | 2 +- reference/data-types/datatype-macroquest.md | 2 +- reference/data-types/datatype-spawn.md | 2 +- .../data-types/datatype-taskobjective.md | 1 + 16 files changed, 64 insertions(+), 43 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 85a1533f0..17b1d529a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -656,7 +656,7 @@ plugins: - redirects: redirect_maps: 'main/submodule-quick-list.md': 'main/plugin-quick-list.md' - 'reference/general/combatstate.md': 'reference/data-types/datatype-character#CombatState' + 'reference/general/combatstate.md': 'reference/data-types/datatype-character.md#CombatState' 'plugins/core-plugins/mq2autologin.md': 'plugins/core-plugins/autologin/index.md' 'plugins/core-plugins/mq2bzsrch/README.md': 'plugins/core-plugins/bzsrch/README.md' 'plugins/core-plugins/mq2chat.md': 'plugins/core-plugins/chat/index.md' diff --git a/plugins/community-plugins/mq2events.md b/plugins/community-plugins/mq2events.md index 1c454feb7..77db6e6ac 100644 --- a/plugins/community-plugins/mq2events.md +++ b/plugins/community-plugins/mq2events.md @@ -35,8 +35,6 @@ trigger=trigger text command=command to execute when triggered ``` -## Examples - ### INI Entries ```text diff --git a/reference/commands/advloot.md b/reference/commands/advloot.md index 5d2be792d..a86ea33cb 100644 --- a/reference/commands/advloot.md +++ b/reference/commands/advloot.md @@ -7,7 +7,7 @@ tags: ## Syntax <!--cmd-syntax-start--> ```eqcommand -/advloot {personal | shared} {set | <"item name"> | <#index> } <window option> [ <quantity> ] +/advloot {personal | shared} {set | <"item name"> | <#index> } <loot option> [ <quantity> ] ``` <!--cmd-syntax-end--> diff --git a/reference/commands/dosocial.md b/reference/commands/dosocial.md index 12f4b0737..5794f177d 100644 --- a/reference/commands/dosocial.md +++ b/reference/commands/dosocial.md @@ -16,7 +16,6 @@ tags: This command allows you to list all your current socials, by name and number, or activate them by name. It is useful in that you could activate a social by name as long as it is in your social window without having to change hotbar pages, or call a social by name from a macro. <!--cmd-desc-end--> -## Examples ### list parameter diff --git a/reference/commands/keypress.md b/reference/commands/keypress.md index ba31ba4e3..87472b5f7 100644 --- a/reference/commands/keypress.md +++ b/reference/commands/keypress.md @@ -25,8 +25,6 @@ Note: /keypress usage outside of a script is not recommended nor consistent. Note: Cannot use both together. For chat input, use simple key names ("X" not "shift+x"). "hold" works with movement/toggle commands. -## Examples - ### EQUI and MQ Keybinds ```text /keypress jump # Simulate the key mapped to JUMP diff --git a/reference/commands/location.md b/reference/commands/location.md index 43ef5d51d..615d09dc9 100644 --- a/reference/commands/location.md +++ b/reference/commands/location.md @@ -20,4 +20,4 @@ Extends the EverQuest Y, X, Z coordinates to add the direction you're facing fro ```text Your Location is 100, 200, 10, and are heading west by southwest. ``` -<img src="/images/Brosen_windrose.svg" width="200" align="center" style="background: white; padding: 10px; border-radius: 8px;"> +![16-wind compass](../../images/Brosen_windrose.svg) diff --git a/reference/commands/mercswitch.md b/reference/commands/mercswitch.md index d3cf9662c..c53afa317 100644 --- a/reference/commands/mercswitch.md +++ b/reference/commands/mercswitch.md @@ -16,5 +16,5 @@ tags: Extends the default EverQuest command to add the `<type>` option. Valid types are: Healer, Damage Caster, Melee Damage, Tank. A list of your mercenaries, their types and indices can be found in the "Switch" tab of your `/mercwindows`. <!--cmd-desc-end--> ## Examples -`/mercswitch healer` will switch to your first "healer" merc. +`/mercswitch healer` will switch to your first "healer" merc. `/mercswitch damage caster` will switch to your first "damage caster" merc. diff --git a/reference/commands/pet.md b/reference/commands/pet.md index 6926006ab..b92e28072 100644 --- a/reference/commands/pet.md +++ b/reference/commands/pet.md @@ -5,6 +5,7 @@ tags: # /pet ## Syntax + <!--cmd-syntax-start--> ```eqcommand /pet <action> <spawnid> @@ -15,9 +16,10 @@ tags: <!--cmd-desc-start--> MacroQuest extends EverQuest's `/pet` command to allow attacking by spawn #. <!--cmd-desc-end--> + ## Options -- **attack** _#_ - Can specify the spawn ID number to attack +- **attack** _#_ - Can specify the [spawn ID](../data-types/datatype-spawn.md#ID) number to attack - **qattack** _#_ - Can specify the spawn ID number to queue an attack ## Examples diff --git a/reference/commands/setautorun.md b/reference/commands/setautorun.md index 78c5d4577..409a56378 100644 --- a/reference/commands/setautorun.md +++ b/reference/commands/setautorun.md @@ -13,5 +13,5 @@ tags: ## Description <!--cmd-desc-start--> -Creates an ini entry in Macroquest.ini that performs a command automatically after entering world. This may be deprecated in favor of .cfg files. +Creates an ini entry in Macroquest.ini that performs a command automatically after entering world. This may be deprecated in favor of [.cfg files.](../../main/features/cfg-files.md) <!--cmd-desc-end--> diff --git a/reference/commands/target.md b/reference/commands/target.md index 8098d1380..bbaeb87fa 100644 --- a/reference/commands/target.md +++ b/reference/commands/target.md @@ -16,14 +16,25 @@ tags: ## Description <!--cmd-desc-start--> -Targets whatever is matched by one or more of the following _options_: +Targets yourself, your corpse, or a spawn search. Replaces the native `/target` and its functionality. <!--cmd-desc-end--> -| | | -| :--- | :--- | -| **clear** | Clears your current target | -| **mycorpse** | Your own corpse (nearest) | -| **myself** | Target yourself | -| _Anything Else_ | Anything else is considered a [Spawn Search](../../reference/general/spawn-search.md) | + +## Options + +No parameter +: With no parameter, will target yourself. + +`clear` +: Clears your current target + +`mycorpse` +: Your own corpse (nearest) + +`myself` +: Target yourself + +_Anything Else_ +: Anything else is considered a [Spawn Search](../../reference/general/spawn-search.md) ## Examples diff --git a/reference/commands/who.md b/reference/commands/who.md index 943db7507..cd202a69a 100644 --- a/reference/commands/who.md +++ b/reference/commands/who.md @@ -7,45 +7,57 @@ tags: ## Syntax <!--cmd-syntax-start--> ```eqcommand -/who <options> +/who [concolor | sort <metric> | all | <spawn search>] ``` <!--cmd-syntax-end--> ## Description <!--cmd-desc-start--> -Searches the current zone for the spawns matching the specified [Spawn Search](../../reference/general/spawn-search.md) _options_, with the addition of: - -* all: Scan all zones. Note: this reverts to the native /who command. -* concolor: Displays the results in consider colors -* sort \: Sort by this metric +Searches the current zone for spawns matching the specified [Spawn Search](../../reference/general/spawn-search.md) or other options. <!--cmd-desc-end--> -## Examples -* **/who npc named** +## Options +**all** +: Scan all zones. (reverts to native /who command) -Displays a List of The Named NPC in Zone +**concolor** +: Displays the results in consider colors -* **/who pc Cleric** +**sort** `{level | name | race | class | distance | guild | id}` +: Sort by this metric + +## Examples -Displays a List of Player Clerics (Even if Anon or /role) +`/who range 65 70` +: Shows players within level 65 to 70 in your zone. -* **/who npc pixtt** +`/who npc named` +: Displays a List of The Named NPC in Zone -Diplays a List of NPC's with pixtt in their name +`/who npc named` +: Displays a List of The Named NPC in Zone -* **/who npc 64** +`/who pc Cleric` +: Displays a List of Player Clerics (Even if Anon or /role) -Displays a List of NPC's who are level 64 +`/who npc pixtt` +: Diplays a List of NPC's with pixtt in their name -* **/who pc 70** +`/who npc 64` +: Displays a List of NPC's who are level 64 -Displays a List of PC's Who are level 70 +`/who pc 70` +: Displays a List of PC's Who are level 70 -* **/who race human** +`/who race human` +: Displays a List of PC's Who are Human -Displays a List of PC's Who are Human +`/who healer sort distance` +: Displays healers in the zone, sorted by distance -* **/whotarget (/whot)** +`/who knight sort level` +: Displays paladins and shadow knights in the zone, sorted by level -Displays a /who for your target, works on npc/pc shows even if role/anon, Shows if sneaking as well. +## See also +- [/whotarget](whotarget.md) diff --git a/reference/data-types/datatype-alertlist.md b/reference/data-types/datatype-alertlist.md index 51d483bbf..05473575e 100644 --- a/reference/data-types/datatype-alertlist.md +++ b/reference/data-types/datatype-alertlist.md @@ -113,7 +113,7 @@ See Also: [Spawn Search](../general/spawn-search.md). ### {{ renderMember(type='string', name='BodyType') }} -: Any spawn with given body type +: Any spawn with given [body type](../general/body-types.md) ### {{ renderMember(type='bool', name='bRaid') }} diff --git a/reference/data-types/datatype-body.md b/reference/data-types/datatype-body.md index 89577815f..3e03859b5 100644 --- a/reference/data-types/datatype-body.md +++ b/reference/data-types/datatype-body.md @@ -5,7 +5,7 @@ tags: # `body` <!--dt-desc-start--> -Contains data about spawn body types +Contains data about spawn [body types](../general/body-types.md) <!--dt-desc-end--> ## Members <!--dt-members-start--> diff --git a/reference/data-types/datatype-macroquest.md b/reference/data-types/datatype-macroquest.md index 3729fce6e..63865dd1d 100644 --- a/reference/data-types/datatype-macroquest.md +++ b/reference/data-types/datatype-macroquest.md @@ -5,7 +5,7 @@ tags: # `macroquest` <!--dt-desc-start--> -Data types related to the current MacroQuest2 session. These also inherit from the [EverQuest Type](datatype-everquest.md). +Data types related to the current MacroQuest session. These also inherit from the [EverQuest Type](datatype-everquest.md). <!--dt-desc-end--> ## Members <!--dt-members-start--> diff --git a/reference/data-types/datatype-spawn.md b/reference/data-types/datatype-spawn.md index 718cdac16..3d8ab07d6 100644 --- a/reference/data-types/datatype-spawn.md +++ b/reference/data-types/datatype-spawn.md @@ -55,7 +55,7 @@ Represents an in-game spawn. ### {{ renderMember(type='body', name='Body') }} -: Body type +: Body type (see [body types](../general/body-types.md)) ### {{ renderMember(type='bool', name='BodyWet') }} diff --git a/reference/data-types/datatype-taskobjective.md b/reference/data-types/datatype-taskobjective.md index cc8717c7d..9a0c07514 100644 --- a/reference/data-types/datatype-taskobjective.md +++ b/reference/data-types/datatype-taskobjective.md @@ -74,6 +74,7 @@ This is the type for your current task objective. : Returns the zone the objective is to be performed in <!--dt-members-end--> + <!--dt-linkrefs-start--> [int]: datatype-int.md [string]: datatype-string.md From 3773f5c1493a857140f741ceda8fd6b55f4390e3 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Mon, 18 Aug 2025 23:49:48 -0500 Subject: [PATCH 26/41] adding some missing docs --- reference/data-types/datatype-menu.md | 66 +++++++++++++++++++ .../data-types/datatype-pointmerchant.md | 40 +++++++++++ .../data-types/datatype-pointmerchantitem.md | 56 ++++++++++++++++ reference/top-level-objects/tlo-menu.md | 30 +++++++++ .../top-level-objects/tlo-pointmerchant.md | 46 +++++++++++++ reference/top-level-objects/tlo-string.md | 27 ++++++++ reference/top-level-objects/tlo-subdefined.md | 21 ++++++ .../top-level-objects/tlo-switchtarget.md | 37 +++++++++++ .../tlo-teleportationitem.md | 45 +++++++++++++ 9 files changed, 368 insertions(+) create mode 100644 reference/data-types/datatype-menu.md create mode 100644 reference/data-types/datatype-pointmerchant.md create mode 100644 reference/data-types/datatype-pointmerchantitem.md create mode 100644 reference/top-level-objects/tlo-menu.md create mode 100644 reference/top-level-objects/tlo-pointmerchant.md create mode 100644 reference/top-level-objects/tlo-string.md create mode 100644 reference/top-level-objects/tlo-subdefined.md create mode 100644 reference/top-level-objects/tlo-switchtarget.md create mode 100644 reference/top-level-objects/tlo-teleportationitem.md diff --git a/reference/data-types/datatype-menu.md b/reference/data-types/datatype-menu.md new file mode 100644 index 000000000..0643a728e --- /dev/null +++ b/reference/data-types/datatype-menu.md @@ -0,0 +1,66 @@ +--- +tags: + - datatype +--- +# `menu` + +<!--dt-desc-start--> +Returns information about visible menus. Inherits [window](datatype-window.md) when a menu is open. +<!--dt-desc-end--> + +## Members +<!--dt-members-start--> + +### {{ renderMember(type='int', name='NumVisibleMenus') }} + +: returns number of currently visible menus. Ordinarily this is going to be 1 if a menu is showing and 0 if not. + +### {{ renderMember(type='int', name='CurrMenu') }} + +: returns the index for the currently visible menu. Ordinarily this will be 0 if a menu is open and -1 if not + +### {{ renderMember(type='string', name='Name') }} + +: returns the name of the menu or the first item's name. + +### {{ renderMember(type='int', name='NumItems') }} + +: returns number of items in the currently open menu. + +### {{ renderMember(type='string', name='Items', params='#') }} + +: returns the Itemname specified by Index + +### {{ renderMember(type='string', name='To String') }} + +: If no menu open, returns "No Menu Open". It returns the first menu item's name when a menu is open + +<!--dt-members-end--> + +## Methods + +**Select** +: Clicks a menu item. + +## Examples +<!--dt-examples-start--> +`/invoke ${Menu.Select[open the door]}` +- Clicks the menu item "open the door" + +`/echo ${Menu.Name}` + +- Output: Shabby Lobby Door + +`/echo ${Menu.NumItems}` + +- Output: 4 + +`/echo ${Menu.Items[2]}` + +- Output: Adjust Placement +<!--dt-examples-end--> + +<!--dt-linkrefs-start--> +[int]: datatype-int.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-pointmerchant.md b/reference/data-types/datatype-pointmerchant.md new file mode 100644 index 000000000..90cc03c28 --- /dev/null +++ b/reference/data-types/datatype-pointmerchant.md @@ -0,0 +1,40 @@ +--- +tags: + - datatype +--- +# `pointmerchant` + +<!--dt-desc-start--> +Contains information about point merchants, such as LDON merchants. Inherits [spawn](datatype-spawn.md) when merchant active. +<!--dt-desc-end--> + +## Members +<!--dt-members-start--> +### {{ renderMember(type='pointmerchantitem', name='Item', params='#|name') }} + +: + +### {{ renderMember(type='string', name='To String') }} + +: Returns TRUE if merchant window is visible, otherwise FALSE + +<!--dt-members-end--> + +## Examples + +!!! example + `/echo ${PointMerchant}` + : Returns true if the LDON Merchant window is open and FALSE if not. + +!!! example + `/echo ${PointMerchant.Item[1].Price}` + : Returns the Price for index 1 or whatever index Ebon Hammer is in if you do it by name. + +!!! example + `/echo ${PointMerchant.Item[Ebon Hammer].Price}` + : Returns the Price for Ebon Hammer. + +<!--dt-linkrefs-start--> +[pointmerchantitem]: datatype-pointmerchantitem.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/data-types/datatype-pointmerchantitem.md b/reference/data-types/datatype-pointmerchantitem.md new file mode 100644 index 000000000..eb8d31830 --- /dev/null +++ b/reference/data-types/datatype-pointmerchantitem.md @@ -0,0 +1,56 @@ +--- +tags: + - datatype +--- +# `pointmerchantitem` + +<!--dt-desc-start--> +Returns information about the specified item from a point merchant +<!--dt-desc-end--> + +## Members +<!--dt-members-start--> +### {{ renderMember(type='string', name='Name') }} + +: Returns the name of the item. + +### {{ renderMember(type='int', name='ItemID') }} + +: Returns the ID of the item + +### {{ renderMember(type='int64', name='Price') }} + +: Price of item + +### {{ renderMember(type='int', name='ThemeID') }} + +: + +### {{ renderMember(type='bool', name='IsStackable') }} + +: + +### {{ renderMember(type='bool', name='IsLore') }} + +: + +### {{ renderMember(type='int', name='RaceMask') }} + +: + +### {{ renderMember(type='int', name='ClassMask') }} + +: + +### {{ renderMember(type='bool', name='CanUse') }} + +: + +<!--dt-members-end--> + +<!--dt-linkrefs-start--> +[bool]: datatype-bool.md +[int]: datatype-int.md +[int64]: datatype-int64.md +[string]: datatype-string.md +<!--dt-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-menu.md b/reference/top-level-objects/tlo-menu.md new file mode 100644 index 000000000..5852e97be --- /dev/null +++ b/reference/top-level-objects/tlo-menu.md @@ -0,0 +1,30 @@ +--- +tags: + - tlo +--- +# `Menu` + +<!--tlo-desc-start--> +Access to menu objects when a menu is open. +<!--tlo-desc-end--> + +## Forms +<!--tlo-forms-start--> +### {{ renderMember(type='menu', name='Menu') }} + +: If no menu open, returns "No Menu Open" + +<!--tlo-forms-end--> + +## Associated DataTypes + +## [`menu`](../data-types/datatype-menu.md) +{% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-menu.md') }} + +<h3>Members</h3> +{% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} +{% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +<!--tlo-linkrefs-start--> +[menu]: ../data-types/datatype-menu.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-pointmerchant.md b/reference/top-level-objects/tlo-pointmerchant.md new file mode 100644 index 000000000..97ea250b9 --- /dev/null +++ b/reference/top-level-objects/tlo-pointmerchant.md @@ -0,0 +1,46 @@ +--- +tags: + - tlo +--- +# `PointMerchant` + +<!--tlo-desc-start--> +Access to point merchants (such as those found in LDoN) when a window is open. +<!--tlo-desc-end--> + +## Forms +<!--tlo-forms-start--> +### {{ renderMember(type='pointmerchant', name='PointMerchant') }} + +: Returns TRUE if point merchant window is open + +<!--tlo-forms-end--> + +## Associated DataTypes +<!--tlo-datatypes-start--> +## [`pointmerchant`](../data-types/datatype-pointmerchant.md) +{% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pointmerchant.md') }} + +<h3>Members</h3> +{% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} +{% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + + +## [`pointmerchantitem`](../data-types/datatype-pointmerchantitem.md) +{% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pointmerchantitem.md') }} + +<h3>Members</h3> +{% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} +{% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> + +## Examples + +!!! example + `/echo ${PointMerchant.Item[1].Price}` + `/echo ${PointMerchant.Item[Ebon Hammer].Price}` + : Returns the Price for index 1 or whatever index Ebon Hammer is in if you do it by name. + +<!--tlo-linkrefs-start--> +[pointmerchant]: ../data-types/datatype-pointmerchant.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-string.md b/reference/top-level-objects/tlo-string.md new file mode 100644 index 000000000..dc4b30acb --- /dev/null +++ b/reference/top-level-objects/tlo-string.md @@ -0,0 +1,27 @@ +--- +tags: + - tlo +--- +# `String` + +<!--tlo-desc-start--> +Access the string datatype +<!--tlo-desc-end--> + +## Forms +<!--tlo-forms-start--> +### {{ renderMember(type='string', name='String', params='text') }} + +: Access text as a string + +<!--tlo-forms-end--> + +## Examples + +!!! example + `${String[foo].Right[2]}` + : Returns the right two characters of "foo", which is "oo". + +<!--tlo-linkrefs-start--> +[string]: ../data-types/datatype-string.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-subdefined.md b/reference/top-level-objects/tlo-subdefined.md new file mode 100644 index 000000000..2218ed17e --- /dev/null +++ b/reference/top-level-objects/tlo-subdefined.md @@ -0,0 +1,21 @@ +--- +tags: + - tlo +--- +# `SubDefined` + +<!--tlo-desc-start--> +Information about macro sub's definition +<!--tlo-desc-end--> + +## Forms +<!--tlo-forms-start--> +### {{ renderMember(type='bool', name='SubDefined', params='name') }} + +: Returns true if a sub called `name` is defined and the macro is currently running. + +<!--tlo-forms-end--> + +<!--tlo-linkrefs-start--> +[bool]: ../data-types/datatype-bool.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-switchtarget.md b/reference/top-level-objects/tlo-switchtarget.md new file mode 100644 index 000000000..df555dc99 --- /dev/null +++ b/reference/top-level-objects/tlo-switchtarget.md @@ -0,0 +1,37 @@ +--- +tags: + - tlo +--- +# `SwitchTarget` + +<!--tlo-desc-start--> +Object used to return information on your switch target. Replaces DoorTarget +<!--tlo-desc-end--> + +## Forms +<!--tlo-forms-start--> +### {{ renderMember(type='switch', name='SwitchTarget') }} + +: True if switch (aka door) targeted + +<!--tlo-forms-end--> + +## Associated DataTypes +<!--tlo-datatypes-start--> +## [`switch`](../data-types/datatype-switch.md) +{% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-switch.md') }} + +<h3>Members</h3> +{% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} +{% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> + +## Examples + +!!! example + `/echo ${SwitchTarget.ID}` + : Returns the ID of the door targeted. + +<!--tlo-linkrefs-start--> +[switch]: ../data-types/datatype-switch.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-teleportationitem.md b/reference/top-level-objects/tlo-teleportationitem.md new file mode 100644 index 000000000..72bd43ed3 --- /dev/null +++ b/reference/top-level-objects/tlo-teleportationitem.md @@ -0,0 +1,45 @@ +--- +tags: + - tlo +--- +# `TeleportationItem` + +<!--tlo-desc-start--> +Returns data on the teleportation item in your keyring. +<!--tlo-desc-end--> + +## Forms +<!--tlo-forms-start--> +### {{ renderMember(type='keyringitem', name='TeleportationItem', params='#') }} + +: Retrieves the item in your keyring by index + +### {{ renderMember(type='keyringitem', name='TeleportationItem', params='name') }} + +: Retrieves the item in your keyring by name. A = can be prepended for an exact match. + +### {{ renderMember(type='keyring', name='TeleportationItem') }} + +: + +<!--tlo-forms-end--> + +## Associated DataTypes +## [`keyring`](../data-types/datatype-keyring.md) +{% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyring.md') }} + +<h3>Members</h3> +{% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} +{% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [`keyringitem`](../data-types/datatype-keyringitem.md) +{% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyringitem.md') }} + +<h3>Members</h3> +{% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} +{% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +<!--tlo-linkrefs-start--> +[keyring]: ../data-types/datatype-keyring.md +[keyringitem]: ../data-types/datatype-keyringitem.md +<!--tlo-linkrefs-end--> \ No newline at end of file From c5132057d9673894817992bf094e8819214766b6 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Fri, 22 Aug 2025 12:10:58 -0500 Subject: [PATCH 27/41] update requirements.txt, use it for build --- .github/workflows/mkdocs_deploy.yml | 10 ++-------- requirements.txt | 5 ++--- 2 files changed, 4 insertions(+), 11 deletions(-) diff --git a/.github/workflows/mkdocs_deploy.yml b/.github/workflows/mkdocs_deploy.yml index 1e0a7b83c..2ed5ed21e 100644 --- a/.github/workflows/mkdocs_deploy.yml +++ b/.github/workflows/mkdocs_deploy.yml @@ -23,16 +23,10 @@ jobs: fetch-depth: 0 - name: Setup Python uses: actions/setup-python@v2 - - name: Install mkdocs + - name: Install dependencies run: | pip install --upgrade pip - pip install mkdocs mkdocs-gen-files - pip install mkdocs-material - pip install mkdocs-redirects - pip install mkdocs-same-dir - pip install python-markdown-math - pip install mkdocs-macros-plugin - pip install eq_lexers + pip install -r requirements.txt - name: Configure git as github-actions bot run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com' - name: Publish docs diff --git a/requirements.txt b/requirements.txt index 3296502f2..ab93eb09c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,8 @@ -material -mkdocs mkdocs-gen-files mkdocs-macros-plugin mkdocs-material mkdocs-redirects mkdocs-same-dir python-markdown-math -mkdocs-include-markdown-plugin \ No newline at end of file +mkdocs-include-markdown-plugin +eq_lexers \ No newline at end of file From 8058c9befaf00c651f462be8c2902a47beb4fdf4 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 27 Aug 2025 11:38:56 -0500 Subject: [PATCH 28/41] rewording and some mkdocs formatting --- README.md | 8 +- main/macroquest.ini.md | 211 +++++++++++++++++++---------------------- mkdocs.yml | 2 +- 3 files changed, 101 insertions(+), 120 deletions(-) diff --git a/README.md b/README.md index dfb5ae753..95b1cccd8 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,14 @@ Welcome to the MacroQuest Documentation. # About MacroQuest -MacroQuest, also known as MQ, or most recently MQNext, is the next generation in development of the platform for the customization and automation of [EverQuest](http://www.everquest.com). MacroQuest is, and has always been, open source software. +MacroQuest, also known as MQ, is a platform for the customization and automation of [EverQuest](http://www.everquest.com). MacroQuest is, and has always been, open source software. -MacroQuest is as useful as you wish to make it. You can utilize it just for the capabilities of the map and other plugins, or you can further enhance EverQuest through the use of lua scripts, macros, or designing your own plugin. +MacroQuest is as useful as you wish to make it. You can utilize it just for the capabilities of the [map](plugins/core-plugins/map/README.md) and other plugins, or you can further enhance EverQuest through the use of [lua scripts](lua/README.md), [macros](macros/README.md), or designing your own [plugin](plugins/README.md). However, there are some issues you need to understand: -* First and foremost, the use of MacroQuest is a violation of the EULA of EverQuest. -* This means that if you use MacroQuest, you risk your account being suspended for a period of time, or in extreme cases, having your account(s) permanently banned. +* First and foremost, the use of MacroQuest is a violation of the commercial EverQuest EULA. +* This means that if you use MacroQuest on commercial EverQuest servers, you risk your account being suspended for a period of time, or in extreme cases, having your account(s) permanently banned. _If you are not prepared for such circumstances, stop here and do not continue._ diff --git a/main/macroquest.ini.md b/main/macroquest.ini.md index 24017d8e8..f62989dc9 100644 --- a/main/macroquest.ini.md +++ b/main/macroquest.ini.md @@ -2,153 +2,134 @@ ## Overview -MacroQuest.ini is the configuration file used by MacroQuest. By default it is stored in the config folder in your MacroQuest directory. +MacroQuest.ini is the configuration file used by MacroQuest. By default it is stored in the config folder in your MacroQuest directory. Many settings can be configured via a GUI with the [/mqsettings](../reference/commands/mqsettings.md) command. ## INI Sections ### [MacroQuest] -* Example - -```ini -[MacroQuest] -MacroQuestWinClassName=__MacroQuestTray -MacroQuestWinName=MacroQuest -ToggleConsoleKey=ctrl+` -BossMode= -CycleNextWindow= -CyclePrevWindow= -ParserEngine=1 -ShowMacroQuestConsole=1 -``` +!!! example "[MacroQuest]" + ```ini + [MacroQuest] + MacroQuestWinClassName=__MacroQuestTray + MacroQuestWinName=MacroQuest + ToggleConsoleKey=ctrl+` + BossMode= + CycleNextWindow= + CyclePrevWindow= + ParserEngine=1 + ShowMacroQuestConsole=1 + ``` ### [Crash Handler] -* Example - -```ini -[Crash Handler] -EnableCrashSubmissions=1 -``` - -### [ItemDisplay] - -* Example - -```ini -[ItemDisplay] -LootButton=1 -LucyButton=1 -``` +!!! example "[Crash Handler]" + ```ini + [Crash Handler] + EnableCrashSubmissions=1 + ``` ### [Aliases] -* Example - -```ini -[Aliases] -/tloc=/echo ${If[${Target.ID},${Target.DisplayName}'s Location is ${Target.Y} ${Target.X} ${Target.Z},You do not have a target!]} -/yes=/multiline ; /squelch /notify LargeDialogWindow LDW_YesButton leftmouseup ; /squelch /notify LargeDialogWindow LDW_OKButton leftmouseup ; /squelch /notify ConfirmationDialogBox CD_Yes_Button leftmouseup ; /squelch /notify ConfirmationDialogBox CD_OK_Button leftmouseup ; /squelch /notify TradeWND TRDW_Trade_Button leftmouseup ; /squelch /notify GiveWnd GVW_Give_Button leftmouseup ; /squelch /notify ProgressionSelectionWnd ProgressionTemplateSelectAcceptButton leftmouseup ; -``` +!!! example "[Aliases]" + The `/yes` and `/no` aliases are created to accept and decline in-game dialogs, and the `/tloc` alias is created to show the location of the target. + ```ini + [Aliases] + /tloc=/echo ${If[${Target.ID},${Target.DisplayName}'s Location is ${Target.Y} ${Target.X} ${Target.Z},You do not have a target!]} + /yes=/multiline ; /squelch /notify LargeDialogWindow LDW_YesButton leftmouseup ; /squelch /notify LargeDialogWindow LDW_OKButton leftmouseup ; /squelch /notify ConfirmationDialogBox CD_Yes_Button leftmouseup ; /squelch /notify ConfirmationDialogBox CD_OK_Button leftmouseup ; /squelch /notify TradeWND TRDW_Trade_Button leftmouseup ; /squelch /notify GiveWnd GVW_Give_Button leftmouseup ; /squelch /notify ProgressionSelectionWnd ProgressionTemplateSelectAcceptButton leftmouseup ; /squelch /notify TaskSelectWnd TSEL_AcceptButton leftmouseup ; /squelch /notify RaidWindow RAID_AcceptButton leftmouseup + /no=/multiline ; /squelch /notify LargeDialogWindow LDW_NoButton leftmouseup ; /squelch /notify ConfirmationDialogBox CD_No_Button leftmouseup ; /squelch /notify ConfirmationDialogBox CD_Cancel_Button leftmouseup ; /squelch /notify TradeWND TRDW_Cancel_Button leftmouseup ; /squelch /notify GiveWnd GVW_Cancel_Button leftmouseup ; /squelch /notify ProgressionSelectionWnd ProgressionTemplateSelectCancelButton leftmouseup ; /squelch /notify TaskSelectWnd TSEL_DeclineButton leftmouseup ; /squelch /notify RaidWindow RAID_DeclineButton leftmouseup + ``` ### [Plugins] -* Example - -```ini -[Plugins] -; MacroQuest Defaults -mq2autologin=1 -mq2bzsrch=1 -mq2chatwnd=0 -mq2custombinds=1 -mq2eqbugfix=1 -mq2itemdisplay=1 -mq2labels=1 -mq2lua=1 -mq2map=1 -``` +!!! example "[Plugins]" + ```ini + [Plugins] + ; MacroQuest Defaults + mq2autologin=1 + mq2bzsrch=1 + mq2chatwnd=0 + mq2custombinds=1 + mq2eqbugfix=1 + mq2itemdisplay=1 + mq2labels=1 + mq2lua=1 + mq2map=1 + ``` ### [Key Binds] -* Example - -```ini -[Key Binds] -RANGED_Nrm=clear -RANGED_Alt=clear -MQ2CHAT_Nrm=. -MQ2CSCHAT_Nrm=/ -NAVKEY_forward_Nrm=W -NAVKEY_forward_Alt=Up -NAVKEY_back_Nrm=S -NAVKEY_back_Alt=Down -NAVKEY_left_Nrm=A -``` +!!! example "[Key Binds]" + ```ini + [Key Binds] + RANGED_Nrm=clear + RANGED_Alt=clear + MQ2CHAT_Nrm=. + MQ2CSCHAT_Nrm=/ + NAVKEY_forward_Nrm=W + NAVKEY_forward_Alt=Up + NAVKEY_back_Nrm=S + NAVKEY_back_Alt=Down + NAVKEY_left_Nrm=A + ``` ### [Internal] -* Example - -```ini -[Internal] -SpawnedProcess=aSdFOgl.exe -``` +!!! example "[Internal]" + ```ini + [Internal] + SpawnedProcess=aSdFOgl.exe + ``` ### [Caption Colors] -* Example - -```ini -[Caption Colors] -PC=OFF -PC-Color=ff00ff -PCCon=OFF -PCPVPTeam=OFF -PCRaid=OFF -PCRaid-Color=ff7f -PCClass=OFF -``` +!!! example "[Caption Colors]" + ```ini + [Caption Colors] + PC=OFF + PC-Color=ff00ff + PCCon=OFF + PCPVPTeam=OFF + PCRaid=OFF + PCRaid-Color=ff7f + PCClass=OFF + ``` ### [FrameLimiter] -* Example - -```ini -[FrameLimiter] -Enable=1 -RenderInBackground=0 -SaveByChar=1 -``` +!!! example "[FrameLimiter]" + ```ini + [FrameLimiter] + Enable=1 + RenderInBackground=0 + SaveByChar=1 + ``` ### [Overlay] -* Example - -```ini -[Overlay] -EnableViewports=0 -CursorAttachment=1 -``` +!!! example "[Overlay]" + ```ini + [Overlay] + EnableViewports=0 + CursorAttachment=1 + ``` ### [AchievementsInspector] -* Example - -```ini -[AchievementsInspector] -ShowCategories=1 -ShowOpen=1 -ShowLocked=1 -ShowCompleted=1 -ShowHidden=1 -``` +!!! example "[AchievementsInspector]" + ```ini + [AchievementsInspector] + ShowCategories=1 + ShowOpen=1 + ShowLocked=1 + ShowCompleted=1 + ShowHidden=1 + ``` ### [Console] -* Example - -```ini -[Console] -PersistentCommandHistory=1 -``` +!!! example "[Console]" + ```ini + [Console] + PersistentCommandHistory=1 + ``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 17b1d529a..d7e27a7a5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -613,7 +613,7 @@ nav: - Change Log: https://github.com/macroquest/macroquest/blob/master/data/resources/CHANGELOG.md" target="_blank validation: - unrecognized_links: ignore # Since we use README.md rather than index.md, mkdocs thinks we have a lot of unrecognized links. + unrecognized_links: ignore # Theme theme: From 3de91d120a298ec12b9a64886b264f28907b77e3 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 27 Aug 2025 11:40:55 -0500 Subject: [PATCH 29/41] deleting accidentally included scripts --- reference/commands/comparecmd.py | 37 ------ reference/commands/comparemqcommand.py | 176 ------------------------- reference/commands/syntaxconvert.py | 68 ---------- 3 files changed, 281 deletions(-) delete mode 100644 reference/commands/comparecmd.py delete mode 100644 reference/commands/comparemqcommand.py delete mode 100644 reference/commands/syntaxconvert.py diff --git a/reference/commands/comparecmd.py b/reference/commands/comparecmd.py deleted file mode 100644 index e997c61f4..000000000 --- a/reference/commands/comparecmd.py +++ /dev/null @@ -1,37 +0,0 @@ -#lets find out if we have all the commands in the README.md file -import os -import re - -# Configuration -commands_dir = "D:/Users/Trevor/Dropbox/work/scripts/readguides/docs/projects/macroquest/reference/commands" -readme_path = "D:/Users/Trevor/Dropbox/work/scripts/readguides/docs/projects/macroquest/reference/commands/README.md" - - - - -# Get list of command files (excluding README.md) -command_files = set() -for f in os.listdir(commands_dir): - if f.endswith(".md") and f != "README.md": - command_files.add(f[:-3].lower()) # Remove .md extension and normalize case - -# Parse README.md for listed commands -with open(readme_path, "r", encoding="utf-8") as f: - readme_content = f.read() - -# Find all command links in format [/command](command) -listed_commands = set(re.findall(r"\[/(\w+)\]\([\w/.-]+\)", readme_content, re.IGNORECASE)) - -# Compare sets -missing_in_readme = command_files - listed_commands -extra_in_readme = listed_commands - command_files - -# Print results -print("Commands missing from README.md:") -print("\n".join(sorted(missing_in_readme)) or "None") - -print("\nCommands in README but missing documentation files:") -print("\n".join(sorted(extra_in_readme)) or "None") - -# Print summary -print(f"\nDocumentation coverage: {len(command_files & listed_commands)}/{len(command_files)} commands documented") \ No newline at end of file diff --git a/reference/commands/comparemqcommand.py b/reference/commands/comparemqcommand.py deleted file mode 100644 index 40abcea5b..000000000 --- a/reference/commands/comparemqcommand.py +++ /dev/null @@ -1,176 +0,0 @@ -import os -import re - -# Get list of existing command files (excluding index.md) -command_files = [f for f in os.listdir() if f.endswith(".md") and f != "index.md"] - -# Extract command names from C++ array -cpp_commands = """ - // Add MQ commands... - struct { const char* szCommand; MQCommandHandler pFunc; bool Parse; bool InGame; } NewCommands[] = { - { "/aa", AltAbility, true, true }, -#if HAS_ADVANCED_LOOT - { "/advloot", AdvLootCmd, true, true }, -#endif - { "/alert", Alert, true, true }, - { "/alias", Alias, false, false }, - { "/altkey", DoAltCmd, false, false }, - { "/assist", AssistCmd, true, true }, - { "/banklist", BankList, true, true }, - { "/beep", MacroBeep, true, false }, - { "/bind", MQ2KeyBindCommand, true, false }, - { "/break", Break, true, false }, - { "/buyitem", BuyItem, true, true }, - { "/cachedbuffs", CachedBuffsCommand, true, true }, - { "/call", Call, true, false }, - { "/cast", Cast, true, true }, - { "/cecho", EchoClean, true, false }, - { "/char", CharInfo, true, true }, - { "/cleanup", Cleanup, true, false }, - { "/clearerrors", ClearErrorsCmd, true, false }, - { "/click", Click, true, false }, - { "/combine", CombineCmd, true, true }, - { "/continue", Continue, true, false }, -#if HAS_ITEM_CONVERT_BUTTON - { "/convertitem", ConvertItemCmd, true, true }, -#endif - { "/ctrlkey", DoCtrlCmd, false, false }, - { "/declare", DeclareVar, true, false }, - { "/delay", Delay, false, false }, // do not parse - { "/deletevar", DeleteVarCmd, true, false }, - { "/destroy", EQDestroyHeldItemOrMoney, true, true }, - { "/doability", DoAbility, true, true }, - { "/docommand", DoCommandCmd, true, false }, - { "/doevents", DoEvents, true, false }, - { "/doors", Doors, true, true }, - { "/doortarget", DoorTarget, true, true }, - { "/dosocial", DoSocial, true, true }, - { "/drop", DropCmd, true, true }, - { "/dumpbinds", DumpBindsCommand, true, false }, - { "/dumpstack", DumpStack, true, false }, - { "/echo", Echo, true, false }, - { "/endmacro", EndMacro, true, false }, - { "/engine", EngineCommand, true, false }, - { "/exec", Exec, true, false }, - { "/executelink", ExecuteLinkCommand, true, true }, - { "/face", Face, true, true }, - { "/filter", Filter, true, false }, - { "/for", For, true, false }, - { "/foreground", ForeGroundCmd, true, false }, - { "/getwintitle", GetWinTitle, true, false }, - { "/goto", Goto, true, false }, - { "/help", Help, true, false }, - { "/hotbutton", DoHotButton, true, true }, - { "/hud", HudCmd, true, false }, - { "/identify", Identify, true, true }, - { "/if", MacroIfCmd, true, false }, - { "/ini", IniOutput, true, false }, - { "/insertaug", InsertAugCmd, true, true }, - { "/invoke", InvokeCmd, true, false }, - { "/items", Items, true, true }, - { "/itemtarget", ItemTarget, true, true }, - { "/keepkeys", KeepKeys, true, false }, - { "/keypress", DoMappable, true, false }, - { "/listmacros", ListMacros, true, false }, - { "/loadcfg", LoadCfgCommand, true, false }, - { "/loadspells", LoadSpells, true, true }, - { "/location", Location, true, true }, - { "/loginname", DisplayLoginName, true, false }, - { "/look", Look, true, true }, - { "/lootall", LootAll, true, false }, - { "/macro", Macro, true, false }, - { "/makemevisible", MakeMeVisible, false, true }, - { "/memspell", MemSpell, true, true }, - { "/mercswitch", MercSwitchCmd, true, true }, - { "/mouseto", MouseTo, true, false }, - { "/mqcopylayout", MQCopyLayout, true, false }, - { "/mqlistmodules", ListModulesCommand, false, false }, - { "/mqlistprocesses", ListProcessesCommand, false, false }, - { "/mqlog", MacroLog, true, false }, - { "/mqpause", MacroPause, true, false }, - { "/mqtarget", Target, true, true }, - { "/msgbox", MQMsgBox, true, false }, - { "/multiline", MultilineCommand, false, false }, - { "/next", Next, true, false }, - { "/nomodkey", NoModKeyCmd, false, false }, - { "/noparse", NoParseCmd, false, false }, - { "/pet", PetCmd, true, true }, - { "/pickzone", PickZoneCmd, true, true }, - { "/popcustom", PopupTextCustom, true, true }, - { "/popup", PopupText, true, true }, - { "/popupecho", PopupTextEcho, true, true }, - { "/profile", ProfileCmd, true, false }, - { "/quit", QuitCmd, true, false }, - { "/ranged", RangedCmd, true, true }, - { "/reloadui", ReloadUICmd, true, true }, - { "/removeaug", RemoveAugCmd, true, true }, - { "/removeaura", RemoveAura, true, true }, - { "/removebuff", RemoveBuff, true, true }, - { "/removelev", RemoveLevCmd, true, false }, - { "/removepetbuff", RemovePetBuff, true, true }, - { "/return", Return, true, false }, - { "/screenmode", ScreenModeCmd, true, false }, - { "/selectitem", SelectItem, true, true }, - { "/sellitem", SellItem, true, true }, - { "/setautorun", SetAutoRun, false, true }, - { "/seterror", SetError, true, false }, - { "/setprio", SetProcessPriority, true, false }, - { "/setwintitle", SetWinTitle, true, false }, - { "/shiftkey", DoShiftCmd, false, false }, - { "/skills", Skills, true, true }, - { "/spellslotinfo", SpellSlotInfo, true, true }, - { "/spewfile", DebugSpewFile, true, false }, - { "/squelch", SquelchCommand, true, false }, - { "/target", Target, true, true }, // TODO: Deprecate /target in favor of /mqtarget so that /target is the actual EQ Command. See #298 - { "/taskquit", TaskQuitCmd, true, true }, - { "/timed", DoTimedCmd, false, false }, - { "/unload", Unload, true, false }, - { "/useitem", UseItemCmd, true, true }, - { "/usercamera", UserCameraCmd, true, false }, - { "/varcalc", VarCalcCmd, true, false }, - { "/vardata", VarDataCmd, true, false }, - { "/varset", VarSetCmd, true, false }, - { "/where", Where, true, true }, - { "/while", MacroWhileCmd, true, false }, - { "/who", SuperWho, true, true }, - { "/whofilter", SWhoFilter, true, true }, - { "/whotarget", SuperWhoTarget, true, true }, - { "/windowstate", WindowState, true, false }, -""".splitlines() - -# Extract command names using regex -command_names = [] -pattern = re.compile(r'\{\s+"(/[^"]+)"') -for line in cpp_commands: - match = pattern.search(line) - if match: - command = match.group(1).lstrip('/') # Remove leading slash - command_names.append(command) - -# Compare files vs commands -existing_docs = [] -missing_docs = [] -extra_docs = [] - -# Check which commands have documentation -for cmd in command_names: - if f"{cmd}.md" in command_files: - existing_docs.append(cmd) - else: - missing_docs.append(cmd) - -# Check for extra documentation files -for f in command_files: - base = f[:-3] # Remove .md extension - if base not in command_names: - extra_docs.append(f) - -# Print results -print("Commands with documentation:") -print("\n".join(existing_docs)) - -print("\nCommands missing documentation:") -print("\n".join(missing_docs)) - -print("\nExtra documentation files (not in command list):") -print("\n".join(extra_docs)) \ No newline at end of file diff --git a/reference/commands/syntaxconvert.py b/reference/commands/syntaxconvert.py deleted file mode 100644 index 76da32430..000000000 --- a/reference/commands/syntaxconvert.py +++ /dev/null @@ -1,68 +0,0 @@ -# this script converts command syntax from markdown to the eqcommand lexer format. - -import os -import re -from pathlib import Path -import argparse - -def convert_syntax_line(line): - # First remove all residual bold markers - line = line.replace('**', '') - # Then handle quoted names and parameters - line = re.sub(r'_"([^"]+)"_', r'<"\1">', line) - # Modified regex to capture phrases with spaces - line = re.sub(r'_([^_]+)_', r'<\1>', line) - return line - -def process_markdown_file(file_path): - with open(file_path, 'r', encoding='utf-8') as f: - content = f.read() - - # Updated regex to capture entire syntax block - converted = re.sub( - r'(## Syntax\n+)(.*?)(?=\n##|\n\n|\Z)', - lambda m: f'{m.group(1)}```eqcommand\n{convert_syntax_line(m.group(2))}\n```', - content, - flags=re.DOTALL - ) - - if converted != content: - with open(file_path, 'w', encoding='utf-8') as f: - f.write(converted) - return True - return False - -def main(): - parser = argparse.ArgumentParser(description='Convert command syntax formatting') - parser.add_argument('--file', help='Process a single file') # <-- Argument definition - args = parser.parse_args() # <-- Argument parsing - - commands_dir = Path(__file__).parent - - if args.file: # <-- Argument check - target_file = commands_dir / args.file - if not target_file.exists(): - print(f"Error: File {args.file} not found") - return - if process_markdown_file(target_file): - print(f"Successfully processed {args.file}") - else: - print(f"No changes needed for {args.file}") - else: - processed_files = 0 - - for md_file in commands_dir.glob('*.md'): - if md_file.name == 'README.md': - continue - - try: - if process_markdown_file(md_file): - print(f'Processed: {md_file.name}') - processed_files += 1 - except Exception as e: - print(f'Error processing {md_file.name}: {str(e)}') - - print(f'\nConversion complete. Modified {processed_files} files.') - -if __name__ == '__main__': - main() From 203e9d10ca8991d6cbdd4bde22ed9a1d572e5319 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 27 Aug 2025 12:00:28 -0500 Subject: [PATCH 30/41] rename to match sourcecode --- .../data-types/{datatype-friends.md => datatype-friend.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename reference/data-types/{datatype-friends.md => datatype-friend.md} (97%) diff --git a/reference/data-types/datatype-friends.md b/reference/data-types/datatype-friend.md similarity index 97% rename from reference/data-types/datatype-friends.md rename to reference/data-types/datatype-friend.md index 3b4e8785e..49e304058 100644 --- a/reference/data-types/datatype-friends.md +++ b/reference/data-types/datatype-friend.md @@ -2,7 +2,7 @@ tags: - datatype --- -# `friends` +# `friend` <!--dt-desc-start--> Provides access to your friends list data. From 6ef768c0f17d3984d5dc37c3058480a97bf400f4 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 27 Aug 2025 12:04:57 -0500 Subject: [PATCH 31/41] adding descriptions --- plugins/core-plugins/README.md | 112 ++++++++++++++++++++++++++++----- 1 file changed, 98 insertions(+), 14 deletions(-) diff --git a/plugins/core-plugins/README.md b/plugins/core-plugins/README.md index f34326e8a..a8ff88ca0 100644 --- a/plugins/core-plugins/README.md +++ b/plugins/core-plugins/README.md @@ -4,17 +4,101 @@ MacroQuest's core plugins are maintained by MacroQuest Authors, and are included ## List of Core Plugins -* [AutoBank](./autobank/index.md) -* [AutoLogin](./autologin/index.md) -* [Bzsrch](./bzsrch/README.md) -* [Chat](./chat/index.md) -* [ChatWnd](./chatwnd/README.md) -* [CustomBinds](./custombinds/README.md) -* [EQBugFix](./eqbugfix/index.md) -* [HUD](./hud/README.md) -* [ItemDisplay](./itemdisplay/README.md) -* [Labels](./labels/index.md) -* [Lua](../../lua/README.md) -* [Map](./map/README.md) -* [TargetInfo](./targetinfo/index.md) -* [XTarInfo](./xtarinfo/index.md) +### [AutoBank](./autobank/index.md) +: {% + include-markdown "plugins/core-plugins/autobank/index.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autobank/index.md') }} + +### [AutoLogin](./autologin/index.md) +: {% + include-markdown "plugins/core-plugins/autologin/index.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/index.md') }} + +### [Bzsrch](./bzsrch/README.md) +: {% + include-markdown "plugins/core-plugins/bzsrch/README.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/bzsrch/README.md') }} + +### [Chat](./chat/index.md) +: {% + include-markdown "plugins/core-plugins/chat/index.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chat/index.md') }} + +### [ChatWnd](./chatwnd/README.md) +: {% + include-markdown "plugins/core-plugins/chatwnd/README.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/README.md') }} + +### [CustomBinds](./custombinds/README.md) +: {% + include-markdown "plugins/core-plugins/custombinds/README.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/custombinds/README.md') }} + +### [EQBugFix](./eqbugfix/index.md) +: {% + include-markdown "plugins/core-plugins/eqbugfix/index.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/eqbugfix/index.md') }} + +### [HUD](./hud/README.md) +: {% + include-markdown "plugins/core-plugins/hud/README.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/README.md') }} + +### [ItemDisplay](./itemdisplay/README.md) +: {% + include-markdown "plugins/core-plugins/itemdisplay/README.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/itemdisplay/README.md') }} + +### [Lua](../../lua/README.md) +: Lua is in general a robust language with a multitude of tutorials and resources widely available. + +### [Map](./map/README.md) +: {% + include-markdown "plugins/core-plugins/map/README.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/README.md') }} + +### [TargetInfo](./targetinfo/index.md) +: {% + include-markdown "plugins/core-plugins/targetinfo/index.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/targetinfo/index.md') }} + +### [XTarInfo](./xtarinfo/index.md) +: {% + include-markdown "plugins/core-plugins/xtarinfo/index.md" + start="<!--desc-start-->" + end="<!--desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/xtarinfo/index.md') }} From edf628590c269f5613a4fcd6314f11aa78238803 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 27 Aug 2025 12:43:57 -0500 Subject: [PATCH 32/41] indenting members of "associated datatypes" for readability --- main/features/framelimiter.md | 25 ++- .../core-plugins/autologin/tlo-autologin.md | 50 +++--- .../core-plugins/bzsrch/bzsrch-tlo-bazaar.md | 58 ++++--- .../itemdisplay/tlo-displayitem.md | 31 ++-- .../top-level-objects/tlo-achievement.md | 25 ++- reference/top-level-objects/tlo-advloot.md | 142 +++++++++--------- reference/top-level-objects/tlo-alert.md | 50 +++--- reference/top-level-objects/tlo-altability.md | 25 ++- reference/top-level-objects/tlo-corpse.md | 25 ++- .../top-level-objects/tlo-dynamiczone.md | 75 +++++---- reference/top-level-objects/tlo-everquest.md | 25 ++- reference/top-level-objects/tlo-familiar.md | 50 +++--- .../top-level-objects/tlo-framelimiter.md | 25 ++- reference/top-level-objects/tlo-friends.md | 37 +++-- reference/top-level-objects/tlo-ground.md | 25 ++- reference/top-level-objects/tlo-group.md | 50 +++--- reference/top-level-objects/tlo-heading.md | 25 ++- reference/top-level-objects/tlo-illusion.md | 50 +++--- reference/top-level-objects/tlo-ini.md | 100 ++++++------ reference/top-level-objects/tlo-int.md | 2 +- reference/top-level-objects/tlo-inventory.md | 25 ++- reference/top-level-objects/tlo-invslot.md | 25 ++- reference/top-level-objects/tlo-macro.md | 33 ++-- reference/top-level-objects/tlo-macroquest.md | 25 ++- reference/top-level-objects/tlo-math.md | 25 ++- reference/top-level-objects/tlo-menu.md | 13 +- reference/top-level-objects/tlo-mercenary.md | 25 ++- reference/top-level-objects/tlo-merchant.md | 25 ++- reference/top-level-objects/tlo-mount.md | 58 ++++--- reference/top-level-objects/tlo-pet.md | 25 ++- reference/top-level-objects/tlo-plugin.md | 25 ++- .../top-level-objects/tlo-pointmerchant.md | 16 +- reference/top-level-objects/tlo-raid.md | 50 +++--- reference/top-level-objects/tlo-range.md | 31 ++-- reference/top-level-objects/tlo-skill.md | 25 ++- reference/top-level-objects/tlo-social.md | 25 ++- reference/top-level-objects/tlo-spell.md | 25 ++- reference/top-level-objects/tlo-switch.md | 25 ++- .../top-level-objects/tlo-switchtarget.md | 9 +- reference/top-level-objects/tlo-target.md | 33 ++-- reference/top-level-objects/tlo-task.md | 75 +++++---- .../tlo-teleportationitem.md | 24 ++- reference/top-level-objects/tlo-time.md | 25 ++- .../top-level-objects/tlo-tradeskilldepot.md | 25 ++- reference/top-level-objects/tlo-type.md | 25 ++- reference/top-level-objects/tlo-window.md | 31 ++-- reference/top-level-objects/tlo-zone.md | 50 +++--- 47 files changed, 814 insertions(+), 879 deletions(-) diff --git a/main/features/framelimiter.md b/main/features/framelimiter.md index a277d74f8..6e5c89c33 100644 --- a/main/features/framelimiter.md +++ b/main/features/framelimiter.md @@ -61,16 +61,15 @@ Frame lmiter settings can be modified in the MacroQuest Settings window. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-framelimiter.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-framelimiter.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-framelimiter.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} diff --git a/plugins/core-plugins/autologin/tlo-autologin.md b/plugins/core-plugins/autologin/tlo-autologin.md index 85a6a1939..9bdac1c8d 100644 --- a/plugins/core-plugins/autologin/tlo-autologin.md +++ b/plugins/core-plugins/autologin/tlo-autologin.md @@ -23,19 +23,18 @@ Returns "AutoLogin" string when plugin is loaded, provides access to AutoLogin f end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('plugins/core-plugins/autologin/datatype-autologin.md') }} - -<h2>Members</h2> -{% - include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "plugins/core-plugins/autologin/datatype-autologin.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [LoginProfile](datatype-loginprofile.md) {% @@ -44,19 +43,18 @@ Returns "AutoLogin" string when plugin is loaded, provides access to AutoLogin f end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('plugins/core-plugins/autologin/datatype-loginprofile.md') }} - -<h2>Members</h2> -{% - include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "plugins/core-plugins/autologin/datatype-loginprofile.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Example diff --git a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md index e780a6416..461de5c86 100644 --- a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md +++ b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md @@ -23,19 +23,18 @@ Provides access to bazaar search functionality and results. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md') }} - -<h2>Members</h2> -{% - include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaar.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [BazaarItem](bzsrch-datatype-bazaaritem.md) {% @@ -44,20 +43,19 @@ Provides access to bazaar search functionality and results. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md') }} - -<h2>Members</h2> -{% - include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} - -<!--tlo-linkrefs-start--> -[bazaar]: bzsrch-datatype-bazaar.md -<!--tlo-linkrefs-end--> +: <h2>Members</h2> + {% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "plugins/core-plugins/bzsrch/bzsrch-datatype-bazaaritem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} + + <!--tlo-linkrefs-start--> + [bazaar]: bzsrch-datatype-bazaar.md + <!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/itemdisplay/tlo-displayitem.md b/plugins/core-plugins/itemdisplay/tlo-displayitem.md index 976d0f1d8..4debe07fb 100644 --- a/plugins/core-plugins/itemdisplay/tlo-displayitem.md +++ b/plugins/core-plugins/itemdisplay/tlo-displayitem.md @@ -27,20 +27,19 @@ Gives information on item windows end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('plugins/core-plugins/itemdisplay/datatype-displayitem.md') }} +: <h2>Members</h2> + {% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} -<h2>Members</h2> -{% - include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "plugins/core-plugins/itemdisplay/datatype-displayitem.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} - -<!--tlo-linkrefs-start--> -[DisplayItem]: datatype-displayitem.md -<!--tlo-linkrefs-end--> + <!--tlo-linkrefs-start--> + [DisplayItem]: datatype-displayitem.md + <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-achievement.md b/reference/top-level-objects/tlo-achievement.md index b81c09674..a234b4c7f 100644 --- a/reference/top-level-objects/tlo-achievement.md +++ b/reference/top-level-objects/tlo-achievement.md @@ -27,19 +27,18 @@ Provides access to achievements. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-achievementmgr.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-achievementmgr.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-achievementmgr.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-achievementmgr.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-achievementmgr.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} diff --git a/reference/top-level-objects/tlo-advloot.md b/reference/top-level-objects/tlo-advloot.md index 90a0962d2..e4748394a 100644 --- a/reference/top-level-objects/tlo-advloot.md +++ b/reference/top-level-objects/tlo-advloot.md @@ -17,19 +17,18 @@ The AdvLoot TLO grants access to items in the Advanced Loot window. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-advloot.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-advloot.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-advloot.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-advloot.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-advloot.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [advlootitem](../data-types/datatype-advlootitem.md) {% @@ -38,19 +37,18 @@ The AdvLoot TLO grants access to items in the Advanced Loot window. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-advlootitem.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-advlootitem.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-advlootitem.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-advlootitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-advlootitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [itemfilterdata](../data-types/datatype-itemfilterdata.md) {% @@ -59,56 +57,22 @@ The AdvLoot TLO grants access to items in the Advanced Loot window. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-itemfilterdata.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-itemfilterdata.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-itemfilterdata.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-itemfilterdata.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-itemfilterdata.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage -=== "MQScript" - - ``` - | Echo the name of the first item in the personal loot list - /echo ${AdvLoot.PList[1].Name} - - | Echo the number of items in the personal loot list. - /echo There are ${AdvLoot.PCount} items in the personal loot list - - | Echo the stack size of the first item in the personal loot list. - /echo The item in index 1 has a StackSize of ${AdvLoot.PList[1].StackSize} - - | If the first item in the shared loot list is marked as Need, then echo. - /if (${AdvLoot.SList[1].Need}==TRUE) /echo I need that item! - - | Echo the NO DROP status of the first item in the personal loot list: TRUE or FALSE. - /echo ${AdvLoot.PList[1].NoDrop} - - | Wait 10 seconds, or until AdvLoot is no longer in the process of looting. - /delay 10s !${AdvLoot.LootInProgress} - - | Give the first item in the shared loot list to myself. - /if (!${AdvLoot.LootInProgress}) { - /echo Its safe to loot! - /if (${AdvLoot.SCount}>=1) { - /echo I am going to give 1 ${AdvLoot.SList[1].Name} to myself - /advloot shared 1 giveto ${Me.Name} 1 - } - } else { - /echo Do something else, loot is already in progress... - } - ``` - === "Lua" ```lua @@ -143,6 +107,40 @@ The AdvLoot TLO grants access to items in the Advanced Loot window. print('Do something else, loot is already in progress...') end ``` + +=== "MQScript" + + ``` + | Echo the name of the first item in the personal loot list + /echo ${AdvLoot.PList[1].Name} + + | Echo the number of items in the personal loot list. + /echo There are ${AdvLoot.PCount} items in the personal loot list + + | Echo the stack size of the first item in the personal loot list. + /echo The item in index 1 has a StackSize of ${AdvLoot.PList[1].StackSize} + + | If the first item in the shared loot list is marked as Need, then echo. + /if (${AdvLoot.SList[1].Need}==TRUE) /echo I need that item! + + | Echo the NO DROP status of the first item in the personal loot list: TRUE or FALSE. + /echo ${AdvLoot.PList[1].NoDrop} + + | Wait 10 seconds, or until AdvLoot is no longer in the process of looting. + /delay 10s !${AdvLoot.LootInProgress} + + | Give the first item in the shared loot list to myself. + /if (!${AdvLoot.LootInProgress}) { + /echo Its safe to loot! + /if (${AdvLoot.SCount}>=1) { + /echo I am going to give 1 ${AdvLoot.SList[1].Name} to myself + /advloot shared 1 giveto ${Me.Name} 1 + } + } else { + /echo Do something else, loot is already in progress... + } + ``` + <!--tlo-linkrefs-start--> [advloot]: ../data-types/datatype-advloot.md [advlootitem]: ../data-types/datatype-advlootitem.md diff --git a/reference/top-level-objects/tlo-alert.md b/reference/top-level-objects/tlo-alert.md index 370ff02c9..465bcf4a6 100644 --- a/reference/top-level-objects/tlo-alert.md +++ b/reference/top-level-objects/tlo-alert.md @@ -27,19 +27,18 @@ Provides access to spawn search filter criteria in alerts. Alerts are created us end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-alert.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-alert.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-alert.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-alert.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-alert.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [alertlist](../data-types/datatype-alertlist.md) {% @@ -48,19 +47,18 @@ Provides access to spawn search filter criteria in alerts. Alerts are created us end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-alertlist.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-alertlist.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-alertlist.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-alertlist.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-alertlist.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-altability.md b/reference/top-level-objects/tlo-altability.md index 90d96cfb5..af15f468a 100644 --- a/reference/top-level-objects/tlo-altability.md +++ b/reference/top-level-objects/tlo-altability.md @@ -31,19 +31,18 @@ tags: end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-altability.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-altability.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-altability.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-altability.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-altability.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-corpse.md b/reference/top-level-objects/tlo-corpse.md index dfcce7d25..1cfff493c 100644 --- a/reference/top-level-objects/tlo-corpse.md +++ b/reference/top-level-objects/tlo-corpse.md @@ -23,19 +23,18 @@ Access to objects of type corpse, which is the currently active corpse (ie. the end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-corpse.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-corpse.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-corpse.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-corpse.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-corpse.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-dynamiczone.md b/reference/top-level-objects/tlo-dynamiczone.md index 472e9bf4c..47f50b527 100644 --- a/reference/top-level-objects/tlo-dynamiczone.md +++ b/reference/top-level-objects/tlo-dynamiczone.md @@ -23,19 +23,18 @@ Provides access to properties of the current dynamic (instanced) zone. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-dynamiczone.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-dynamiczone.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-dynamiczone.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-dynamiczone.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-dynamiczone.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [dzmember](../data-types/datatype-dzmember.md) {% @@ -44,19 +43,18 @@ Provides access to properties of the current dynamic (instanced) zone. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-dzmember.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-dzmember.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-dzmember.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-dzmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-dzmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [dztimer](../data-types/datatype-dztimer.md) {% @@ -65,19 +63,18 @@ Provides access to properties of the current dynamic (instanced) zone. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-dztimer.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-dztimer.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-dztimer.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-dztimer.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-dztimer.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-everquest.md b/reference/top-level-objects/tlo-everquest.md index d6c407448..7b51e755b 100644 --- a/reference/top-level-objects/tlo-everquest.md +++ b/reference/top-level-objects/tlo-everquest.md @@ -21,19 +21,18 @@ Provides access to general information about the game and its state. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-everquest.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-everquest.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-everquest.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-everquest.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-everquest.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-familiar.md b/reference/top-level-objects/tlo-familiar.md index f3aceaab3..cc7011c7b 100644 --- a/reference/top-level-objects/tlo-familiar.md +++ b/reference/top-level-objects/tlo-familiar.md @@ -31,19 +31,18 @@ Used to get information about items on your familiars keyring. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyring.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-keyring.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-keyring.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [keyringitem](../data-types/datatype-keyringitem.md) {% @@ -52,19 +51,18 @@ Used to get information about items on your familiars keyring. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyringitem.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-keyringitem.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-keyringitem.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Examples diff --git a/reference/top-level-objects/tlo-framelimiter.md b/reference/top-level-objects/tlo-framelimiter.md index ad1bb809b..27ae3def8 100644 --- a/reference/top-level-objects/tlo-framelimiter.md +++ b/reference/top-level-objects/tlo-framelimiter.md @@ -24,19 +24,18 @@ The FrameLimiter TLO provides access to the [frame limiter](../../main/features/ end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-framelimiter.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-framelimiter.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-framelimiter.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-framelimiter.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-friends.md b/reference/top-level-objects/tlo-friends.md index 3646f6d37..ff3a0c87f 100644 --- a/reference/top-level-objects/tlo-friends.md +++ b/reference/top-level-objects/tlo-friends.md @@ -5,37 +5,36 @@ tags: # `Friends` <!--tlo-desc-start--> -Grants access to your friends dlist. +Grants access to your friends list. <!--tlo-desc-end--> ## Forms <!--tlo-forms-start--> -### {{ renderMember(type='friends', name='Friends') }} +### {{ renderMember(type='friend', name='Friends') }} : Access friends data <!--tlo-forms-end--> ## Associated DataTypes -## [friends](../data-types/datatype-friends.md) +## [friend](../data-types/datatype-friend.md) {% - include-markdown "reference/data-types/datatype-friends.md" + include-markdown "reference/data-types/datatype-friend.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false -%} {{ readMore('reference/data-types/datatype-friends.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-friends.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-friends.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +%} {{ readMore('reference/data-types/datatype-friend.md') }} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-friend.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-friend.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} @@ -65,5 +64,5 @@ Grants access to your friends dlist. <!--tlo-linkrefs-start--> [string]: ../data-types/datatype-string.md [bool]: ../data-types/datatype-bool.md -[friends]: ../data-types/datatype-friends.md +[friend]: ../data-types/datatype-friend.md <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-ground.md b/reference/top-level-objects/tlo-ground.md index efe39ce4b..644e04760 100644 --- a/reference/top-level-objects/tlo-ground.md +++ b/reference/top-level-objects/tlo-ground.md @@ -23,19 +23,18 @@ Object which references the ground spawn item you have targeted. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-ground.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-ground.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-ground.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-ground.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-ground.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-group.md b/reference/top-level-objects/tlo-group.md index 188ee3b7c..ff7bec897 100644 --- a/reference/top-level-objects/tlo-group.md +++ b/reference/top-level-objects/tlo-group.md @@ -23,19 +23,18 @@ Access to all group-related information. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-group.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-group.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-group.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-group.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-group.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [groupmember](../data-types/datatype-groupmember.md) {% @@ -44,19 +43,18 @@ Access to all group-related information. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-groupmember.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-groupmember.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-groupmember.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-groupmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-groupmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-heading.md b/reference/top-level-objects/tlo-heading.md index f4c455e05..86f1fe720 100644 --- a/reference/top-level-objects/tlo-heading.md +++ b/reference/top-level-objects/tlo-heading.md @@ -31,19 +31,18 @@ Object that refers to the directional heading to of a location or direction. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-heading.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-heading.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-heading.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-heading.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-heading.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-illusion.md b/reference/top-level-objects/tlo-illusion.md index 88fd0f454..4f72cf5cd 100644 --- a/reference/top-level-objects/tlo-illusion.md +++ b/reference/top-level-objects/tlo-illusion.md @@ -31,19 +31,18 @@ Used to get information about items on your illusions keyring. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyring.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-keyring.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-keyring.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [keyringitem](../data-types/datatype-keyringitem.md) {% @@ -52,19 +51,18 @@ Used to get information about items on your illusions keyring. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyringitem.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-keyringitem.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-keyringitem.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-ini.md b/reference/top-level-objects/tlo-ini.md index 5266e0ef9..52f8c7341 100644 --- a/reference/top-level-objects/tlo-ini.md +++ b/reference/top-level-objects/tlo-ini.md @@ -34,19 +34,18 @@ Reads value(s) from an ini file located in a relative or absolute path. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-ini.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-ini.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-ini.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-ini.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-ini.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [inifile](../data-types/datatype-inifile.md) {% @@ -55,19 +54,18 @@ Reads value(s) from an ini file located in a relative or absolute path. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inifile.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-inifile.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-inifile.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-inifile.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-inifile.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [inifilesection](../data-types/datatype-inifilesection.md) {% @@ -76,19 +74,18 @@ Reads value(s) from an ini file located in a relative or absolute path. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inifilesection.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-inifilesection.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-inifilesection.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-inifilesection.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-inifilesection.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [inifilesectionkey](../data-types/datatype-inifilesectionkey.md) {% @@ -97,19 +94,18 @@ Reads value(s) from an ini file located in a relative or absolute path. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inifilesectionkey.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-inifilesectionkey.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-inifilesectionkey.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-inifilesectionkey.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-inifilesectionkey.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-int.md b/reference/top-level-objects/tlo-int.md index f1ab6ad74..a4ddd2966 100644 --- a/reference/top-level-objects/tlo-int.md +++ b/reference/top-level-objects/tlo-int.md @@ -9,7 +9,7 @@ Object that creates an integer from n. <!--tlo-desc-end--> ## Forms <!--tlo-forms-start--> -### {{ renderMember(type='int', name='Int') }} +### {{ renderMember(type='int', name='Int', params='N') }} : Parses whatever value for _n_ is provided and converts it into an [int]. <!--tlo-forms-end--> diff --git a/reference/top-level-objects/tlo-inventory.md b/reference/top-level-objects/tlo-inventory.md index 65ea2bc74..38d6ea4e0 100644 --- a/reference/top-level-objects/tlo-inventory.md +++ b/reference/top-level-objects/tlo-inventory.md @@ -23,19 +23,18 @@ This is a hierarchical container for things relating to inventory (Bank, etc). end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inventory.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-inventory.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-inventory.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-inventory.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-inventory.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-invslot.md b/reference/top-level-objects/tlo-invslot.md index e94a05716..19adcf516 100644 --- a/reference/top-level-objects/tlo-invslot.md +++ b/reference/top-level-objects/tlo-invslot.md @@ -27,19 +27,18 @@ Object used to get information on a specific inventory slot. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-invslot.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-invslot.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-invslot.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-invslot.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-invslot.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-macro.md b/reference/top-level-objects/tlo-macro.md index f002ea707..8f2f5bf92 100644 --- a/reference/top-level-objects/tlo-macro.md +++ b/reference/top-level-objects/tlo-macro.md @@ -29,20 +29,19 @@ Information about the macro that's currently running. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-macro.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-macro.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-macro.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} - -<!--tlo-linkrefs-start--> -[macro]: ../data-types/datatype-macro.md -<!--tlo-linkrefs-end--> +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-macro.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-macro.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} + + <!--tlo-linkrefs-start--> + [macro]: ../data-types/datatype-macro.md + <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-macroquest.md b/reference/top-level-objects/tlo-macroquest.md index fad8d2e33..50988520f 100644 --- a/reference/top-level-objects/tlo-macroquest.md +++ b/reference/top-level-objects/tlo-macroquest.md @@ -21,19 +21,18 @@ Creates an object related to MacroQuest information. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-macroquest.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-macroquest.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-macroquest.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-macroquest.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-macroquest.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-math.md b/reference/top-level-objects/tlo-math.md index 61f1339f3..86309ce21 100644 --- a/reference/top-level-objects/tlo-math.md +++ b/reference/top-level-objects/tlo-math.md @@ -22,19 +22,18 @@ Creates a Math object which gives allows access to the math type members. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-math.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-math.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-math.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-math.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-math.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-menu.md b/reference/top-level-objects/tlo-menu.md index 5852e97be..dfa1eedf1 100644 --- a/reference/top-level-objects/tlo-menu.md +++ b/reference/top-level-objects/tlo-menu.md @@ -20,11 +20,10 @@ Access to menu objects when a menu is open. ## [`menu`](../data-types/datatype-menu.md) {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-menu.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} -<h3>Members</h3> -{% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} -{% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - -<!--tlo-linkrefs-start--> -[menu]: ../data-types/datatype-menu.md -<!--tlo-linkrefs-end--> \ No newline at end of file + <!--tlo-linkrefs-start--> + [menu]: ../data-types/datatype-menu.md + <!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-mercenary.md b/reference/top-level-objects/tlo-mercenary.md index c2e016238..7d83d237f 100644 --- a/reference/top-level-objects/tlo-mercenary.md +++ b/reference/top-level-objects/tlo-mercenary.md @@ -21,19 +21,18 @@ Object used to get information about your mercenary. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-mercenary.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-mercenary.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-mercenary.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-mercenary.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-mercenary.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-merchant.md b/reference/top-level-objects/tlo-merchant.md index 2041faf58..591b1ad5f 100644 --- a/reference/top-level-objects/tlo-merchant.md +++ b/reference/top-level-objects/tlo-merchant.md @@ -21,19 +21,18 @@ Object that interacts with the currently active merchant. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-merchant.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-merchant.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-merchant.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-merchant.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-merchant.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-mount.md b/reference/top-level-objects/tlo-mount.md index db24e968f..a70fed829 100644 --- a/reference/top-level-objects/tlo-mount.md +++ b/reference/top-level-objects/tlo-mount.md @@ -31,19 +31,18 @@ Used to get information about items on your Mount keyring. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyring.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-keyring.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-keyring.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-keyring.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [keyringitem](../data-types/datatype-keyringitem.md) {% @@ -52,21 +51,20 @@ Used to get information about items on your Mount keyring. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyringitem.md') }} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-keyringitem.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-keyringitem.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-keyringitem.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} - -<!--tlo-linkrefs-start--> -[keyring]: ../data-types/datatype-keyring.md -[keyringitem]: ../data-types/datatype-keyringitem.md -<!--tlo-linkrefs-end--> + <!--tlo-linkrefs-start--> + [keyring]: ../data-types/datatype-keyring.md + [keyringitem]: ../data-types/datatype-keyringitem.md + <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-pet.md b/reference/top-level-objects/tlo-pet.md index 7c2b7c434..2fbbf24eb 100644 --- a/reference/top-level-objects/tlo-pet.md +++ b/reference/top-level-objects/tlo-pet.md @@ -24,19 +24,18 @@ Pet object which allows you to get properties of your pet. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pet.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-pet.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-pet.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-pet.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-pet.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-plugin.md b/reference/top-level-objects/tlo-plugin.md index 7471f9851..5e5ec0bc3 100644 --- a/reference/top-level-objects/tlo-plugin.md +++ b/reference/top-level-objects/tlo-plugin.md @@ -27,19 +27,18 @@ Object that has access to members that provide information on a plugin. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-plugin.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-plugin.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-plugin.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-plugin.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-plugin.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-pointmerchant.md b/reference/top-level-objects/tlo-pointmerchant.md index 97ea250b9..7837ff37c 100644 --- a/reference/top-level-objects/tlo-pointmerchant.md +++ b/reference/top-level-objects/tlo-pointmerchant.md @@ -20,19 +20,17 @@ Access to point merchants (such as those found in LDoN) when a window is open. <!--tlo-datatypes-start--> ## [`pointmerchant`](../data-types/datatype-pointmerchant.md) {% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pointmerchant.md') }} - -<h3>Members</h3> -{% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} -{% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} ## [`pointmerchantitem`](../data-types/datatype-pointmerchantitem.md) {% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pointmerchantitem.md') }} - -<h3>Members</h3> -{% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} -{% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} -<!--tlo-datatypes-end--> +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + <!--tlo-datatypes-end--> ## Examples diff --git a/reference/top-level-objects/tlo-raid.md b/reference/top-level-objects/tlo-raid.md index 056a71079..c29ee829c 100644 --- a/reference/top-level-objects/tlo-raid.md +++ b/reference/top-level-objects/tlo-raid.md @@ -21,19 +21,18 @@ Object that has access to members that provide information on your raid. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-raid.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-raid.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-raid.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-raid.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-raid.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [raidmember](../data-types/datatype-raidmember.md) {% @@ -42,19 +41,18 @@ Object that has access to members that provide information on your raid. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-raidmember.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-raidmember.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-raidmember.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-raidmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-raidmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-range.md b/reference/top-level-objects/tlo-range.md index d4cc68ef9..75391e8ef 100644 --- a/reference/top-level-objects/tlo-range.md +++ b/reference/top-level-objects/tlo-range.md @@ -21,20 +21,19 @@ Test if _n_ is inside a range of 2 numbers or between 2 numbers end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-range.md') }} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-range.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-range.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-range.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-range.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} - -<!--tlo-linkrefs-start--> -[range]: ../data-types/datatype-range.md -<!--tlo-linkrefs-end--> + <!--tlo-linkrefs-start--> + [range]: ../data-types/datatype-range.md + <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-skill.md b/reference/top-level-objects/tlo-skill.md index 41a9ea76f..73046ca7f 100644 --- a/reference/top-level-objects/tlo-skill.md +++ b/reference/top-level-objects/tlo-skill.md @@ -27,19 +27,18 @@ Object used to get information on your character's skills. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-skill.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-skill.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-skill.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-skill.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-skill.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-social.md b/reference/top-level-objects/tlo-social.md index 536cdce0c..654f327f0 100644 --- a/reference/top-level-objects/tlo-social.md +++ b/reference/top-level-objects/tlo-social.md @@ -25,19 +25,18 @@ Access data about socials (in-game macro buttons) end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-social.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-social.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-social.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-social.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-social.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-spell.md b/reference/top-level-objects/tlo-spell.md index 066b6f63b..722aac043 100644 --- a/reference/top-level-objects/tlo-spell.md +++ b/reference/top-level-objects/tlo-spell.md @@ -27,19 +27,18 @@ Object used to return information on a spell by name or by ID. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-spell.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-spell.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-spell.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-spell.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-spell.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-switch.md b/reference/top-level-objects/tlo-switch.md index 1c477769b..979ac44ca 100644 --- a/reference/top-level-objects/tlo-switch.md +++ b/reference/top-level-objects/tlo-switch.md @@ -35,19 +35,18 @@ Object used when you want to find information on targetted doors or switches suc end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-switch.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-switch.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-switch.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-switch.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-switch.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-switchtarget.md b/reference/top-level-objects/tlo-switchtarget.md index df555dc99..618a0ad30 100644 --- a/reference/top-level-objects/tlo-switchtarget.md +++ b/reference/top-level-objects/tlo-switchtarget.md @@ -20,11 +20,10 @@ Object used to return information on your switch target. Replaces DoorTarget <!--tlo-datatypes-start--> ## [`switch`](../data-types/datatype-switch.md) {% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-switch.md') }} - -<h3>Members</h3> -{% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} -{% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} -<!--tlo-datatypes-end--> +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + <!--tlo-datatypes-end--> ## Examples diff --git a/reference/top-level-objects/tlo-target.md b/reference/top-level-objects/tlo-target.md index 4ddd211c4..1da85fd39 100644 --- a/reference/top-level-objects/tlo-target.md +++ b/reference/top-level-objects/tlo-target.md @@ -68,20 +68,19 @@ Object used to get information about your current target. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-target.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-target.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-target.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} - -<!--tlo-linkrefs-start--> -[target]: ../data-types/datatype-target.md -<!--tlo-linkrefs-end--> +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-target.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-target.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} + + <!--tlo-linkrefs-start--> + [target]: ../data-types/datatype-target.md + <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-task.md b/reference/top-level-objects/tlo-task.md index 71f6d02fe..21e757a6c 100644 --- a/reference/top-level-objects/tlo-task.md +++ b/reference/top-level-objects/tlo-task.md @@ -21,19 +21,18 @@ Object used to return information on a current Task. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-task.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-task.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-task.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-task.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-task.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [taskmember](../data-types/datatype-taskmember.md) {% @@ -42,19 +41,18 @@ Object used to return information on a current Task. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-taskmember.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-taskmember.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-taskmember.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-taskmember.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-taskmember.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [taskobjective](../data-types/datatype-taskobjective.md) {% @@ -63,19 +61,18 @@ Object used to return information on a current Task. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-taskobjective.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-taskobjective.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-taskobjective.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-taskobjective.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-taskobjective.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-teleportationitem.md b/reference/top-level-objects/tlo-teleportationitem.md index 72bd43ed3..51eff6c65 100644 --- a/reference/top-level-objects/tlo-teleportationitem.md +++ b/reference/top-level-objects/tlo-teleportationitem.md @@ -27,19 +27,17 @@ Returns data on the teleportation item in your keyring. ## Associated DataTypes ## [`keyring`](../data-types/datatype-keyring.md) {% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyring.md') }} - -<h3>Members</h3> -{% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} -{% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} ## [`keyringitem`](../data-types/datatype-keyringitem.md) {% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyringitem.md') }} - -<h3>Members</h3> -{% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} -{% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - -<!--tlo-linkrefs-start--> -[keyring]: ../data-types/datatype-keyring.md -[keyringitem]: ../data-types/datatype-keyringitem.md -<!--tlo-linkrefs-end--> \ No newline at end of file +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + + <!--tlo-linkrefs-start--> + [keyring]: ../data-types/datatype-keyring.md + [keyringitem]: ../data-types/datatype-keyringitem.md + <!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-time.md b/reference/top-level-objects/tlo-time.md index df8e19d64..adcf6ae16 100644 --- a/reference/top-level-objects/tlo-time.md +++ b/reference/top-level-objects/tlo-time.md @@ -21,19 +21,18 @@ Object used to return information on real time, not game time. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-time.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-time.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-time.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-time.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-time.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-tradeskilldepot.md b/reference/top-level-objects/tlo-tradeskilldepot.md index 2edca46db..88f1863cd 100644 --- a/reference/top-level-objects/tlo-tradeskilldepot.md +++ b/reference/top-level-objects/tlo-tradeskilldepot.md @@ -21,19 +21,18 @@ Object that interacts with the personal tradeskill depot, introduced in the Nigh end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-tradeskilldepot.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-tradeskilldepot.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-tradeskilldepot.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-tradeskilldepot.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-tradeskilldepot.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Examples diff --git a/reference/top-level-objects/tlo-type.md b/reference/top-level-objects/tlo-type.md index cf6f00066..1a24bb5a6 100644 --- a/reference/top-level-objects/tlo-type.md +++ b/reference/top-level-objects/tlo-type.md @@ -23,19 +23,18 @@ Used to get information on data types. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-type.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-type.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-type.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-type.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-type.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage diff --git a/reference/top-level-objects/tlo-window.md b/reference/top-level-objects/tlo-window.md index 339b5ecab..3c7fec920 100644 --- a/reference/top-level-objects/tlo-window.md +++ b/reference/top-level-objects/tlo-window.md @@ -25,20 +25,19 @@ You can display a list of window names using the /windows command or by using th end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-window.md') }} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-window.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-window.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-window.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-window.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} - -<!--tlo-linkrefs-start--> -[window]: ../data-types/datatype-window.md -<!--tlo-linkrefs-end--> + <!--tlo-linkrefs-start--> + [window]: ../data-types/datatype-window.md + <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-zone.md b/reference/top-level-objects/tlo-zone.md index 340d816ea..2d880e79e 100644 --- a/reference/top-level-objects/tlo-zone.md +++ b/reference/top-level-objects/tlo-zone.md @@ -33,19 +33,18 @@ Used to find information about a particular zone. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-zone.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-zone.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-zone.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-zone.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-zone.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## [currentzone](../data-types/datatype-currentzone.md) {% @@ -54,19 +53,18 @@ Used to find information about a particular zone. end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-currentzone.md') }} - -<h2>Members</h2> -{% - include-markdown "reference/data-types/datatype-currentzone.md" - start="<!--dt-members-start-->" - end="<!--dt-members-end-->" - heading-offset=0 -%} -{% - include-markdown "reference/data-types/datatype-currentzone.md" - start="<!--dt-linkrefs-start-->" - end="<!--dt-linkrefs-end-->" -%} +: <h2>Members</h2> + {% + include-markdown "reference/data-types/datatype-currentzone.md" + start="<!--dt-members-start-->" + end="<!--dt-members-end-->" + heading-offset=0 + %} + {% + include-markdown "reference/data-types/datatype-currentzone.md" + start="<!--dt-linkrefs-start-->" + end="<!--dt-linkrefs-end-->" + %} ## Usage From 2e61a29a38f574a1a3be5b0004ede023a742b165 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 27 Aug 2025 12:45:36 -0500 Subject: [PATCH 33/41] typo --- reference/data-types/datatype-window.md | 1 - 1 file changed, 1 deletion(-) diff --git a/reference/data-types/datatype-window.md b/reference/data-types/datatype-window.md index dcc59aa10..13ada7477 100644 --- a/reference/data-types/datatype-window.md +++ b/reference/data-types/datatype-window.md @@ -291,7 +291,6 @@ Windows come in many forms, but all are represented with the generic **window** ### {{ renderMember(type='float', name='Value') }} -: ### {{ renderMember(type='int', name='X') }} From be8f50fe56f28ee719bcf5753730461600a602ca Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Tue, 2 Sep 2025 22:17:23 -0500 Subject: [PATCH 34/41] typo --- main/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main/README.md b/main/README.md index 14c9b92ef..940d44383 100644 --- a/main/README.md +++ b/main/README.md @@ -66,7 +66,7 @@ To end a macro, use this command: `/endmacro` -See the [Getting Startaed](../macros/getting-started.md) section for further information on macros, and [/macro](../reference/commands/macro.md) and [/endmacro](../reference/commands/endmacro.md) for starting and stopping. +See the [Getting Started](../macros/getting-started.md) section for further information on macros, and [/macro](../reference/commands/macro.md) and [/endmacro](../reference/commands/endmacro.md) for starting and stopping. ### Plugins From 9461e407e79e6d0fb8ff47d11d71bdd8710af076 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 3 Sep 2025 11:35:32 -0500 Subject: [PATCH 35/41] back to original wording --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 95b1cccd8..6f9e32f1e 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ MacroQuest is as useful as you wish to make it. You can utilize it just for the However, there are some issues you need to understand: -* First and foremost, the use of MacroQuest is a violation of the commercial EverQuest EULA. -* This means that if you use MacroQuest on commercial EverQuest servers, you risk your account being suspended for a period of time, or in extreme cases, having your account(s) permanently banned. +* First and foremost, the use of MacroQuest is a violation of the EULA of EverQuest. +* This means that if you use MacroQuest, you risk your account being suspended for a period of time, or in extreme cases, having your account(s) permanently banned. _If you are not prepared for such circumstances, stop here and do not continue._ From 0493e187c79596e1b47f4324fca93c8958b2f94a Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 3 Sep 2025 13:26:45 -0500 Subject: [PATCH 36/41] fix links --- reference/data-types/datatype-achievement.md | 2 +- reference/data-types/datatype-achievementcat.md | 2 +- reference/data-types/datatype-window.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/data-types/datatype-achievement.md b/reference/data-types/datatype-achievement.md index 6450c7291..aaefa4a47 100644 --- a/reference/data-types/datatype-achievement.md +++ b/reference/data-types/datatype-achievement.md @@ -35,7 +35,7 @@ Provides the details about a single achievement and allows access to an achievem ### {{ renderMember(type='int', name='Index') }} -: The index of the achievement. See [Achievement Indices](../top-level-objects/tlo-achievement.md#note-about-achievement-indices) for more information. +: The index of the achievement. See [Achievement Indices](../top-level-objects/tlo-achievement.md#usage) for more information. ### {{ renderMember(type='string', name='Link', params='opt: Name') }} diff --git a/reference/data-types/datatype-achievementcat.md b/reference/data-types/datatype-achievementcat.md index ef36d3444..ae1cb68fd 100644 --- a/reference/data-types/datatype-achievementcat.md +++ b/reference/data-types/datatype-achievementcat.md @@ -53,7 +53,7 @@ While not required to access achievements, categories may be useful for enumerat ### {{ renderMember(type='int', name='Index') }} -: The index of the category in the achievement manager. For more information see [Achievement Indices](../top-level-objects/tlo-achievement.md#note-about-achievement-indices). +: The index of the category in the achievement manager. For more information see [Achievement Indices](../top-level-objects/tlo-achievement.md#usage). ### {{ renderMember(type='string', name='Name') }} diff --git a/reference/data-types/datatype-window.md b/reference/data-types/datatype-window.md index 13ada7477..c04693e1b 100644 --- a/reference/data-types/datatype-window.md +++ b/reference/data-types/datatype-window.md @@ -61,7 +61,7 @@ Windows come in many forms, but all are represented with the generic **window** : !!! info "Deprecation Notice" - This member is deprecated and discouraged from continued use. Please use [SelectedIndex](#int-selectedindex) instead. + This member is deprecated and discouraged from continued use. Please use [SelectedIndex](#SelectedIndex) instead. Applies to: `Combobox`, `Listbox`, `TreeView` @@ -304,7 +304,7 @@ Windows come in many forms, but all are represented with the generic **window** ### [string][string] To String -: `TRUE` if the window is open, `FALSE` if not, matching [Open](#bool-open) +: `TRUE` if the window is open, `FALSE` if not, matching [Open](#Open) <!--dt-members-end--> ## Methods From 04e5d8dc87add8c865ae0c9bdb680a96ff269b0e Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 3 Sep 2025 13:27:54 -0500 Subject: [PATCH 37/41] use include-markdown on index pages --- reference/commands/README.md | 2422 ++++++++++++++++++++++++- reference/data-types/README.md | 584 +++++- reference/top-level-objects/README.md | 355 +++- 3 files changed, 3228 insertions(+), 133 deletions(-) diff --git a/reference/commands/README.md b/reference/commands/README.md index 68e898c58..61ad516c2 100644 --- a/reference/commands/README.md +++ b/reference/commands/README.md @@ -1,47 +1,2387 @@ # Slash Commands + ## Base -| | | | | | | -| :--- | :--- | :--- | :--- | :--- | :--- | -| [/aa](aa) | [/advloot](advloot) | [/alert](alert) | [/alias](alias) | [/altkey](altkey) | [/banklist](banklist) | -| [/beep](beep) | [/benchmark](benchmark) | [/beepontells](beepontells) | [/bind](bind) | [/buyitem](buyitem) | [/caption](caption) | -| [/captioncolor](captioncolor) | [/cast](cast) | [/cecho](cecho) | [/cleanup](cleanup) | [/char](char) | [/click](click) | -| [/combine](combine) | [/ctrlkey](ctrlkey) | [/custombind](/plugins/core-plugins/custombinds/custombind/) | [/destroy](destroy) | [/docommand](docommand) | [/doors](doors) | -| [/doortarget](doortarget) | [/dosocial](dosocial) | [/drop](drop) | [/dumpbinds](dumpbinds) | [/echo](echo) | [/eqtarget](eqtarget) | -| [/exec](exec) | [/face](face) | [/filter](filter) | [/flashontells](flashontells) | [/foreground](foreground) | [/framelimiter](framelimiter) | -| [/help](help) | [/hotbutton](hotbutton) | [/identify](identify) | [/ini](ini) | [/itemnotify](itemnotify) | [/items](items) | -| [/itemtarget](itemtarget) | [/keepkeys](keepkeys) | [/keypress](keypress) | [/loadcfg](loadcfg) | [/loadspells](loadspells) | [/location](location) | -| [/loginname](loginname) | [/look](look) | [/lootall](lootall) | [/memspell](memspell) | [/mouseto](mouseto) | [/multiline](multiline) | -| [/mqcopylayout](mqcopylayout) | [/mqlog](mqlog) | [/mqsettings](mqsettings) | [/mqtarget](mqtarget) | [/multiline](multiline) | [/netstatusxpos](netstatusxpos) | -| [/netstatusypos](netstatusypos) | [/nomodkey](nomodkey) | [/noparse](noparse) | [/notify](notify) | [/plugin](plugin) | [/popcustom](popcustom) | -| [/popup](popup) | [/popupecho](popupecho) | [/ranged](ranged) | [/reloadui](reloadui) | [/removeaura](removeaura) | [/removebuff](removebuff) | -| [/removelev](removelev) | [/removepetbuff](removepetbuff) | [/screenmode](screenmode) | [/selectitem](selectitem) | [/sellitem](sellitem) | [/setautorun](setautorun) | -| [/setprio](setprio) | [/setwintitle](setwintitle) | [/shiftkey](shiftkey) | [/skills](skills) | [/spellslotinfo](spellslotinfo) | [/spew](spew) | -| [/squelch](squelch) | [/target](target) | [/timed](timed) | [/timestamp](timestamp) | [/unload](unload) | [/useitem](useitem) | -| [/where](where) | [/who](who) | [/whofilter](whofilter) | [/whotarget](whotarget) | [/cachedbuffs](cachedbuffs) | [/convertitem](convertitem) | -| [/crash](crash) | [/doability](doability) | [/dumpstack](dumpstack) | [/engine](engine) | [/executelink](executelink) | [/getwintitle](getwintitle) | -| [/insertaug](insertaug) | [/itemslots](itemslots) | [/makemevisible](makemevisible) | [/mercswitch](mercswitch) | [/mqanon](mqanon) | [/mqconsole](mqconsole) | -| [/mqlistmodules](mqlistmodules) | [/mqlistprocesses](mqlistprocesses) | [/mqoverlay](mqoverlay) | [/msgbox](msgbox) | [/no](no) | [/pet](pet) | -| [/pickzone](pickzone) | [/profile](profile) | [/quit](quit) | [/removeaug](removeaug) | [/taskquit](taskquit) | [/tloc](tloc) | -| [/usercamera](usercamera) | [/yes](yes) | [/windows](windows) | [/windowstate](windowstate) | +<a href="aa/"> +{% + include-markdown "reference/commands/aa.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/aa.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/aa.md') }} + +<a href="advloot/"> +{% + include-markdown "reference/commands/advloot.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/advloot.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/advloot.md') }} + +<a href="alert/"> +{% + include-markdown "reference/commands/alert.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/alert.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/alert.md') }} + +<a href="alias/"> +{% + include-markdown "reference/commands/alias.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/alias.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/alias.md') }} + +<a href="altkey/"> +{% + include-markdown "reference/commands/altkey.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/altkey.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/altkey.md') }} + +<a href="banklist/"> +{% + include-markdown "reference/commands/banklist.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/banklist.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/banklist.md') }} + +<a href="beep/"> +{% + include-markdown "reference/commands/beep.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/beep.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/beep.md') }} + +<a href="beepontells/"> +{% + include-markdown "reference/commands/beepontells.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/beepontells.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/beepontells.md') }} + +<a href="benchmark/"> +{% + include-markdown "reference/commands/benchmark.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/benchmark.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/benchmark.md') }} + +<a href="bind/"> +{% + include-markdown "reference/commands/bind.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/bind.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/bind.md') }} + +<a href="buyitem/"> +{% + include-markdown "reference/commands/buyitem.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/buyitem.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/buyitem.md') }} + +<a href="cachedbuffs/"> +{% + include-markdown "reference/commands/cachedbuffs.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/cachedbuffs.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/cachedbuffs.md') }} + +<a href="caption/"> +{% + include-markdown "reference/commands/caption.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/caption.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/caption.md') }} + +<a href="captioncolor/"> +{% + include-markdown "reference/commands/captioncolor.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/captioncolor.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/captioncolor.md') }} + +<a href="cast/"> +{% + include-markdown "reference/commands/cast.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/cast.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/cast.md') }} + +<a href="cecho/"> +{% + include-markdown "reference/commands/cecho.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/cecho.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/cecho.md') }} + +<a href="char/"> +{% + include-markdown "reference/commands/char.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/char.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/char.md') }} + +<a href="cleanup/"> +{% + include-markdown "reference/commands/cleanup.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/cleanup.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/cleanup.md') }} + +<a href="click/"> +{% + include-markdown "reference/commands/click.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/click.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/click.md') }} + +<a href="combine/"> +{% + include-markdown "reference/commands/combine.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/combine.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/combine.md') }} + +<a href="convertitem/"> +{% + include-markdown "reference/commands/convertitem.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/convertitem.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/convertitem.md') }} + +<a href="crash/"> +{% + include-markdown "reference/commands/crash.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/crash.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/crash.md') }} + +<a href="ctrlkey/"> +{% + include-markdown "reference/commands/ctrlkey.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/ctrlkey.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/ctrlkey.md') }} + +<a href="destroy/"> +{% + include-markdown "reference/commands/destroy.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/destroy.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/destroy.md') }} + +<a href="doability/"> +{% + include-markdown "reference/commands/doability.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/doability.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/doability.md') }} + +<a href="docommand/"> +{% + include-markdown "reference/commands/docommand.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/docommand.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/docommand.md') }} + +<a href="doors/"> +{% + include-markdown "reference/commands/doors.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/doors.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/doors.md') }} + +<a href="doortarget/"> +{% + include-markdown "reference/commands/doortarget.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/doortarget.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/doortarget.md') }} + +<a href="dosocial/"> +{% + include-markdown "reference/commands/dosocial.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/dosocial.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/dosocial.md') }} + +<a href="drop/"> +{% + include-markdown "reference/commands/drop.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/drop.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/drop.md') }} + +<a href="dumpbinds/"> +{% + include-markdown "reference/commands/dumpbinds.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/dumpbinds.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/dumpbinds.md') }} + +<a href="dumpstack/"> +{% + include-markdown "reference/commands/dumpstack.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/dumpstack.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/dumpstack.md') }} + +<a href="echo/"> +{% + include-markdown "reference/commands/echo.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/echo.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/echo.md') }} + +<a href="engine/"> +{% + include-markdown "reference/commands/engine.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/engine.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/engine.md') }} + +<a href="eqtarget/"> +{% + include-markdown "reference/commands/eqtarget.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/eqtarget.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/eqtarget.md') }} + +<a href="exec/"> +{% + include-markdown "reference/commands/exec.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/exec.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/exec.md') }} + +<a href="executelink/"> +{% + include-markdown "reference/commands/executelink.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/executelink.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/executelink.md') }} + +<a href="face/"> +{% + include-markdown "reference/commands/face.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/face.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/face.md') }} + +<a href="filter/"> +{% + include-markdown "reference/commands/filter.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/filter.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/filter.md') }} + +<a href="flashontells/"> +{% + include-markdown "reference/commands/flashontells.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/flashontells.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/flashontells.md') }} + +<a href="foreground/"> +{% + include-markdown "reference/commands/foreground.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/foreground.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/foreground.md') }} + +<a href="framelimiter/"> +{% + include-markdown "reference/commands/framelimiter.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/framelimiter.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/framelimiter.md') }} + +<a href="getwintitle/"> +{% + include-markdown "reference/commands/getwintitle.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/getwintitle.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/getwintitle.md') }} + +<a href="help/"> +{% + include-markdown "reference/commands/help.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/help.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/help.md') }} + +<a href="hotbutton/"> +{% + include-markdown "reference/commands/hotbutton.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/hotbutton.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/hotbutton.md') }} + +<a href="hud/"> +{% + include-markdown "reference/commands/hud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/hud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/hud.md') }} + +<a href="identify/"> +{% + include-markdown "reference/commands/identify.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/identify.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/identify.md') }} + +<a href="ini/"> +{% + include-markdown "reference/commands/ini.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/ini.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/ini.md') }} + +<a href="insertaug/"> +{% + include-markdown "reference/commands/insertaug.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/insertaug.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/insertaug.md') }} + +<a href="itemnotify/"> +{% + include-markdown "reference/commands/itemnotify.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/itemnotify.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/itemnotify.md') }} + +<a href="items/"> +{% + include-markdown "reference/commands/items.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/items.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/items.md') }} + +<a href="itemslots/"> +{% + include-markdown "reference/commands/itemslots.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/itemslots.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/itemslots.md') }} + +<a href="itemtarget/"> +{% + include-markdown "reference/commands/itemtarget.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/itemtarget.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/itemtarget.md') }} + +<a href="keepkeys/"> +{% + include-markdown "reference/commands/keepkeys.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/keepkeys.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/keepkeys.md') }} + +<a href="keypress/"> +{% + include-markdown "reference/commands/keypress.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/keypress.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/keypress.md') }} + +<a href="loadcfg/"> +{% + include-markdown "reference/commands/loadcfg.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/loadcfg.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/loadcfg.md') }} + +<a href="loadspells/"> +{% + include-markdown "reference/commands/loadspells.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/loadspells.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/loadspells.md') }} + +<a href="location/"> +{% + include-markdown "reference/commands/location.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/location.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/location.md') }} + +<a href="loginname/"> +{% + include-markdown "reference/commands/loginname.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/loginname.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/loginname.md') }} + +<a href="look/"> +{% + include-markdown "reference/commands/look.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/look.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/look.md') }} + +<a href="lootall/"> +{% + include-markdown "reference/commands/lootall.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/lootall.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/lootall.md') }} + +<a href="makemevisible/"> +{% + include-markdown "reference/commands/makemevisible.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/makemevisible.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/makemevisible.md') }} + +<a href="memspell/"> +{% + include-markdown "reference/commands/memspell.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/memspell.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/memspell.md') }} + +<a href="mercswitch/"> +{% + include-markdown "reference/commands/mercswitch.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mercswitch.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mercswitch.md') }} + +<a href="mouseto/"> +{% + include-markdown "reference/commands/mouseto.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mouseto.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mouseto.md') }} + +<a href="mqanon/"> +{% + include-markdown "reference/commands/mqanon.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqanon.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqanon.md') }} + +<a href="mqconsole/"> +{% + include-markdown "reference/commands/mqconsole.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqconsole.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqconsole.md') }} + +<a href="mqcopylayout/"> +{% + include-markdown "reference/commands/mqcopylayout.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqcopylayout.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqcopylayout.md') }} + +<a href="mqlistmodules/"> +{% + include-markdown "reference/commands/mqlistmodules.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqlistmodules.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqlistmodules.md') }} + +<a href="mqlistprocesses/"> +{% + include-markdown "reference/commands/mqlistprocesses.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqlistprocesses.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqlistprocesses.md') }} + +<a href="mqlog/"> +{% + include-markdown "reference/commands/mqlog.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqlog.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqlog.md') }} + +<a href="mqoverlay/"> +{% + include-markdown "reference/commands/mqoverlay.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqoverlay.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqoverlay.md') }} + +<a href="mqsettings/"> +{% + include-markdown "reference/commands/mqsettings.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqsettings.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqsettings.md') }} + +<a href="mqtarget/"> +{% + include-markdown "reference/commands/mqtarget.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqtarget.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqtarget.md') }} + +<a href="msgbox/"> +{% + include-markdown "reference/commands/msgbox.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/msgbox.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/msgbox.md') }} + +<a href="multiline/"> +{% + include-markdown "reference/commands/multiline.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/multiline.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/multiline.md') }} + +<a href="netstatusxpos/"> +{% + include-markdown "reference/commands/netstatusxpos.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/netstatusxpos.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/netstatusxpos.md') }} + +<a href="netstatusypos/"> +{% + include-markdown "reference/commands/netstatusypos.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/netstatusypos.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/netstatusypos.md') }} + +<a href="no/"> +{% + include-markdown "reference/commands/no.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/no.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/no.md') }} + +<a href="nomodkey/"> +{% + include-markdown "reference/commands/nomodkey.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/nomodkey.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/nomodkey.md') }} + +<a href="noparse/"> +{% + include-markdown "reference/commands/noparse.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/noparse.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/noparse.md') }} + +<a href="notify/"> +{% + include-markdown "reference/commands/notify.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/notify.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/notify.md') }} + +<a href="pet/"> +{% + include-markdown "reference/commands/pet.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/pet.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/pet.md') }} + +<a href="pickzone/"> +{% + include-markdown "reference/commands/pickzone.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/pickzone.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/pickzone.md') }} + +<a href="plugin/"> +{% + include-markdown "reference/commands/plugin.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/plugin.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/plugin.md') }} + +<a href="popcustom/"> +{% + include-markdown "reference/commands/popcustom.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/popcustom.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/popcustom.md') }} + +<a href="popup/"> +{% + include-markdown "reference/commands/popup.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/popup.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/popup.md') }} + +<a href="popupecho/"> +{% + include-markdown "reference/commands/popupecho.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/popupecho.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/popupecho.md') }} + +<a href="profile/"> +{% + include-markdown "reference/commands/profile.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/profile.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/profile.md') }} + +<a href="quit/"> +{% + include-markdown "reference/commands/quit.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/quit.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/quit.md') }} + +<a href="ranged/"> +{% + include-markdown "reference/commands/ranged.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/ranged.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/ranged.md') }} + +<a href="reloadui/"> +{% + include-markdown "reference/commands/reloadui.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/reloadui.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/reloadui.md') }} + +<a href="removeaug/"> +{% + include-markdown "reference/commands/removeaug.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/removeaug.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/removeaug.md') }} + +<a href="removeaura/"> +{% + include-markdown "reference/commands/removeaura.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/removeaura.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/removeaura.md') }} + +<a href="removebuff/"> +{% + include-markdown "reference/commands/removebuff.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/removebuff.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/removebuff.md') }} + +<a href="removelev/"> +{% + include-markdown "reference/commands/removelev.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/removelev.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/removelev.md') }} + +<a href="removepetbuff/"> +{% + include-markdown "reference/commands/removepetbuff.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/removepetbuff.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/removepetbuff.md') }} + +<a href="screenmode/"> +{% + include-markdown "reference/commands/screenmode.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/screenmode.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/screenmode.md') }} + +<a href="selectitem/"> +{% + include-markdown "reference/commands/selectitem.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/selectitem.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/selectitem.md') }} + +<a href="sellitem/"> +{% + include-markdown "reference/commands/sellitem.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/sellitem.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/sellitem.md') }} + +<a href="setautorun/"> +{% + include-markdown "reference/commands/setautorun.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/setautorun.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/setautorun.md') }} + +<a href="setprio/"> +{% + include-markdown "reference/commands/setprio.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/setprio.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/setprio.md') }} + +<a href="setwintitle/"> +{% + include-markdown "reference/commands/setwintitle.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/setwintitle.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/setwintitle.md') }} + +<a href="shiftkey/"> +{% + include-markdown "reference/commands/shiftkey.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/shiftkey.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/shiftkey.md') }} + +<a href="skills/"> +{% + include-markdown "reference/commands/skills.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/skills.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/skills.md') }} + +<a href="spellslotinfo/"> +{% + include-markdown "reference/commands/spellslotinfo.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/spellslotinfo.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/spellslotinfo.md') }} + +<a href="spew/"> +{% + include-markdown "reference/commands/spew.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/spew.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/spew.md') }} + +<a href="squelch/"> +{% + include-markdown "reference/commands/squelch.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/squelch.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/squelch.md') }} + +<a href="target/"> +{% + include-markdown "reference/commands/target.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/target.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/target.md') }} + +<a href="taskquit/"> +{% + include-markdown "reference/commands/taskquit.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/taskquit.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/taskquit.md') }} + +<a href="timestamp/"> +{% + include-markdown "reference/commands/timestamp.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/timestamp.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/timestamp.md') }} + +<a href="timed/"> +{% + include-markdown "reference/commands/timed.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/timed.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/timed.md') }} + +<a href="tloc/"> +{% + include-markdown "reference/commands/tloc.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/tloc.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/tloc.md') }} + +<a href="unload/"> +{% + include-markdown "reference/commands/unload.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/unload.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/unload.md') }} + +<a href="useitem/"> +{% + include-markdown "reference/commands/useitem.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/useitem.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/useitem.md') }} + +<a href="usercamera/"> +{% + include-markdown "reference/commands/usercamera.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/usercamera.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/usercamera.md') }} + +<a href="where/"> +{% + include-markdown "reference/commands/where.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/where.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/where.md') }} + +<a href="who/"> +{% + include-markdown "reference/commands/who.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/who.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/who.md') }} + +<a href="whofilter/"> +{% + include-markdown "reference/commands/whofilter.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/whofilter.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/whofilter.md') }} + +<a href="whotarget/"> +{% + include-markdown "reference/commands/whotarget.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/whotarget.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/whotarget.md') }} + +<a href="windows/"> +{% + include-markdown "reference/commands/windows.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/windows.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/windows.md') }} + +<a href="windowstate/"> +{% + include-markdown "reference/commands/windowstate.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/windowstate.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/windowstate.md') }} + +<a href="yes/"> +{% + include-markdown "reference/commands/yes.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/yes.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/yes.md') }} ## Macroing/Flow Control -| | | | | -| :--- | :--- | :--- | :--- | -| [/break](break) | [/call](call) | [/clearerrors](clearerrors) | [/continue](continue) | -| [/declare](declare) | [/delay](delay) | [/deletevar](deletevar) | [/doevents](doevents) | -| [/endmacro](endmacro) | [/for](for) | [/goto](goto) | [/if](if) | -| [/invoke](invoke) | [/listmacros](listmacros) | [/macro](macro) | [/mqpause](mqpause) | -| [/next](next) | [/return](return) | [/seterror](seterror) | [/varcalc](varcalc) | -| [/vardata](vardata) | [/varset](varset) | [/while](while) | - -## From Plugins -| [ChatWnd](/plugins/core-plugins/chatwnd/) | [HUD](/plugins/core-plugins/hud/) | [ItemDisplay](/plugins/core-plugins/itemdisplay/) | [Map](/plugins/core-plugins/map/) | -| :--- | :--- | :--- | :--- | -| [/mqfont](/plugins/core-plugins/chatwnd/mqfont) | [/hud](/plugins/core-plugins/hud/hud) | [/inote](/plugins/core-plugins/itemdisplay/inote) | [/highlight](/plugins/core-plugins/map/highlight) | -| | [/defaulthud](/plugins/core-plugins/hud/defaulthud) | | [/mapclick](/plugins/core-plugins/map/mapclick) | -| | [/loadhud](/plugins/core-plugins/hud/loadhud) | | [/mapfilter](/plugins/core-plugins/map/mapfilter) | -| | [/classhud](/plugins/core-plugins/hud/classhud) | | [/maphide](/plugins/core-plugins/map/maphide) | -| | [/zonehud](/plugins/core-plugins/hud/zonehud) | | [/mapnames](/plugins/core-plugins/map/mapnames) | -| | | | [/mapshow](/plugins/core-plugins/map/mapshow) | +<a href="break/"> +{% + include-markdown "reference/commands/break.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/break.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/break.md') }} + +<a href="call/"> +{% + include-markdown "reference/commands/call.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/call.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/call.md') }} + +<a href="clearerrors/"> +{% + include-markdown "reference/commands/clearerrors.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/clearerrors.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/clearerrors.md') }} + +<a href="continue/"> +{% + include-markdown "reference/commands/continue.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/continue.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/continue.md') }} + +<a href="declare/"> +{% + include-markdown "reference/commands/declare.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/declare.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/declare.md') }} + +<a href="delay/"> +{% + include-markdown "reference/commands/delay.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/delay.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/delay.md') }} + +<a href="deletevar/"> +{% + include-markdown "reference/commands/deletevar.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/deletevar.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/deletevar.md') }} + +<a href="doevents/"> +{% + include-markdown "reference/commands/doevents.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/doevents.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/doevents.md') }} + +<a href="endmacro/"> +{% + include-markdown "reference/commands/endmacro.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/endmacro.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/endmacro.md') }} + +<a href="for/"> +{% + include-markdown "reference/commands/for.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/for.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/for.md') }} + +<a href="goto/"> +{% + include-markdown "reference/commands/goto.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/goto.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/goto.md') }} + +<a href="if/"> +{% + include-markdown "reference/commands/if.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/if.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/if.md') }} + +<a href="invoke/"> +{% + include-markdown "reference/commands/invoke.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/invoke.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/invoke.md') }} + +<a href="listmacros/"> +{% + include-markdown "reference/commands/listmacros.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/listmacros.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/listmacros.md') }} + +<a href="macro/"> +{% + include-markdown "reference/commands/macro.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/macro.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/macro.md') }} + +<a href="mqpause/"> +{% + include-markdown "reference/commands/mqpause.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/mqpause.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/mqpause.md') }} + +<a href="next/"> +{% + include-markdown "reference/commands/next.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/next.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/next.md') }} + +<a href="return/"> +{% + include-markdown "reference/commands/return.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/return.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/return.md') }} + +<a href="seterror/"> +{% + include-markdown "reference/commands/seterror.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/seterror.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/seterror.md') }} + +<a href="varcalc/"> +{% + include-markdown "reference/commands/varcalc.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/varcalc.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/varcalc.md') }} + +<a href="vardata/"> +{% + include-markdown "reference/commands/vardata.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/vardata.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/vardata.md') }} + +<a href="varset/"> +{% + include-markdown "reference/commands/varset.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/varset.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/varset.md') }} + +<a href="while/"> +{% + include-markdown "reference/commands/while.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% include-markdown "reference/commands/while.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('reference/commands/while.md') }} + +## From Core Plugins + +### AutoLogin + +<a href="../../plugins/core-plugins/autologin/loginchar/"> +{% + include-markdown "plugins/core-plugins/autologin/loginchar.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/autologin/loginchar.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/loginchar.md') }} + + +<a href="../../plugins/core-plugins/autologin/relog/"> +{% + include-markdown "plugins/core-plugins/autologin/relog.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/autologin/relog.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/relog.md') }} + + +<a href="../../plugins/core-plugins/autologin/switchchar/"> +{% + include-markdown "plugins/core-plugins/autologin/switchchar.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/autologin/switchchar.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/switchchar.md') }} + + +<a href="../../plugins/core-plugins/autologin/switchserver/"> +{% + include-markdown "plugins/core-plugins/autologin/switchserver.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/autologin/switchserver.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/autologin/switchserver.md') }} + + +### Bzsrch + +<a href="../../plugins/core-plugins/bzsrch/breset/"> +{% + include-markdown "plugins/core-plugins/bzsrch/breset.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/bzsrch/breset.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/bzsrch/breset.md') }} + + +<a href="../../plugins/core-plugins/bzsrch/bzquery/"> +{% + include-markdown "plugins/core-plugins/bzsrch/bzquery.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/bzsrch/bzquery.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/bzsrch/bzquery.md') }} + + +<a href="../../plugins/core-plugins/bzsrch/bzsrch/"> +{% + include-markdown "plugins/core-plugins/bzsrch/bzsrch.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/bzsrch/bzsrch.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/bzsrch/bzsrch.md') }} + + +### ChatWnd + +<a href="../../plugins/core-plugins/chatwnd/mqchat/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqchat.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/chatwnd/mqchat.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqchat.md') }} + + +<a href="../../plugins/core-plugins/chatwnd/mqclear/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqclear.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/chatwnd/mqclear.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqclear.md') }} + + +<a href="../../plugins/core-plugins/chatwnd/mqfont/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqfont.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/chatwnd/mqfont.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqfont.md') }} + + +<a href="../../plugins/core-plugins/chatwnd/mqmin/"> +{% + include-markdown "plugins/core-plugins/chatwnd/mqmin.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/chatwnd/mqmin.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/mqmin.md') }} + + +<a href="../../plugins/core-plugins/chatwnd/setchattitle/"> +{% + include-markdown "plugins/core-plugins/chatwnd/setchattitle.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/chatwnd/setchattitle.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/setchattitle.md') }} + + +<a href="../../plugins/core-plugins/chatwnd/style/"> +{% + include-markdown "plugins/core-plugins/chatwnd/style.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/chatwnd/style.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/chatwnd/style.md') }} + + +### CustomBinds + +<a href="../../plugins/core-plugins/custombinds/custombind/"> +{% + include-markdown "plugins/core-plugins/custombinds/custombind.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/custombinds/custombind.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/custombinds/custombind.md') }} + + +### HUD + +<a href="../../plugins/core-plugins/hud/classhud/"> +{% + include-markdown "plugins/core-plugins/hud/classhud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/hud/classhud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/classhud.md') }} + + +<a href="../../plugins/core-plugins/hud/defaulthud/"> +{% + include-markdown "plugins/core-plugins/hud/defaulthud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/hud/defaulthud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/defaulthud.md') }} + + +<a href="../../plugins/core-plugins/hud/loadhud/"> +{% + include-markdown "plugins/core-plugins/hud/loadhud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/hud/loadhud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/loadhud.md') }} + + +<a href="../../plugins/core-plugins/hud/unloadhud/"> +{% + include-markdown "plugins/core-plugins/hud/unloadhud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/hud/unloadhud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/unloadhud.md') }} + + +<a href="../../plugins/core-plugins/hud/zonehud/"> +{% + include-markdown "plugins/core-plugins/hud/zonehud.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/hud/zonehud.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/hud/zonehud.md') }} + + +### ItemDisplay + +<a href="../../plugins/core-plugins/itemdisplay/inote/"> +{% + include-markdown "plugins/core-plugins/itemdisplay/inote.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/itemdisplay/inote.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/itemdisplay/inote.md') }} + + +<a href="../../plugins/core-plugins/itemdisplay/itemdisplay/"> +{% + include-markdown "plugins/core-plugins/itemdisplay/itemdisplay.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/itemdisplay/itemdisplay.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/itemdisplay/itemdisplay.md') }} + + +### Map + +<a href="../../plugins/core-plugins/map/highlight/"> +{% + include-markdown "plugins/core-plugins/map/highlight.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/highlight.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/highlight.md') }} + + +<a href="../../plugins/core-plugins/map/mapactivelayer/"> +{% + include-markdown "plugins/core-plugins/map/mapactivelayer.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/mapactivelayer.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapactivelayer.md') }} + + +<a href="../../plugins/core-plugins/map/mapclick/"> +{% + include-markdown "plugins/core-plugins/map/mapclick.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/mapclick.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapclick.md') }} + + +<a href="../../plugins/core-plugins/map/mapfilter/"> +{% + include-markdown "plugins/core-plugins/map/mapfilter.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/mapfilter.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapfilter.md') }} + + +<a href="../../plugins/core-plugins/map/maphide/"> +{% + include-markdown "plugins/core-plugins/map/maphide.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/maphide.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/maphide.md') }} + + +<a href="../../plugins/core-plugins/map/maploc/"> +{% + include-markdown "plugins/core-plugins/map/maploc.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/maploc.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/maploc.md') }} + + +<a href="../../plugins/core-plugins/map/mapnames/"> +{% + include-markdown "plugins/core-plugins/map/mapnames.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/mapnames.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapnames.md') }} + + +<a href="../../plugins/core-plugins/map/mapshow/"> +{% + include-markdown "plugins/core-plugins/map/mapshow.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/map/mapshow.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/map/mapshow.md') }} + + +### TargetInfo + +<a href="../../plugins/core-plugins/targetinfo/targetinfo/"> +{% + include-markdown "plugins/core-plugins/targetinfo/targetinfo.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/targetinfo/targetinfo.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/targetinfo/targetinfo.md') }} + + +### XTarInfo + +<a href="../../plugins/core-plugins/xtarinfo/xtarinfo/"> +{% + include-markdown "plugins/core-plugins/xtarinfo/xtarinfo.md" + start="<!--cmd-syntax-start-->" + end="<!--cmd-syntax-end-->" +%} +</a> +: {% + include-markdown "plugins/core-plugins/xtarinfo/xtarinfo.md" + start="<!--cmd-desc-start-->" + end="<!--cmd-desc-end-->" + trailing-newlines=false + %} {{ readMore('plugins/core-plugins/xtarinfo/xtarinfo.md') }} diff --git a/reference/data-types/README.md b/reference/data-types/README.md index 2410c7bad..0096131a7 100644 --- a/reference/data-types/README.md +++ b/reference/data-types/README.md @@ -2,50 +2,540 @@ See Also: [Top Level Objects Reference](../top-level-objects/README.md). -See sidebar for full list. -[int]: datatype-int.md -[string]: datatype-string.md -[achievementobj]: datatype-achievementobj.md -[bool]: datatype-bool.md -[time]: datatype-time.md -[achievement]: datatype-achievement.md -[achievementcat]: datatype-achievementcat.md -[altability]: datatype-altability.md -[spell]: datatype-spell.md -[bandolieritem]: #bandolieritem-datatype -[int64]: datatype-int64.md -[timestamp]: datatype-timestamp.md -[float]: datatype-float.md -[buff]: datatype-buff.md -[spawn]: datatype-spawn.md -[auratype]: datatype-auratype.md -[item]: datatype-item.md -[worldlocation]: datatype-worldlocation.md -[ticks]: datatype-ticks.md -[fellowship]: datatype-fellowship.md -[strinrg]: datatype-string.md -[xtarget]: datatype-xtarget.md -[dzmember]: datatype-dzmember.md -[window]: datatype-window.md -[zone]: datatype-zone.md -[fellowshipmember]: datatype-fellowshipmember.md -[class]: datatype-class.md -[heading]: datatype-heading.md -[ground]: datatype-ground.md -[inifile]: datatype-inifile.md -[inifilesection]: datatype-inifilesection.md -[inifilesectionkey]: datatype-inifilesectionkey.md -[double]: datatype-double.md -[invslot]: datatype-invslot.md -[augtype]: datatype-augtype.md -[itemspell]: datatype-itemspell.md -[evolving]: datatype-evolving.md -[keyringitem]: datatype-keyringitem.md -[raidmember]: datatype-raidmember.md -[body]: datatype-body.md -[cachedbuff]: datatype-cachedbuff.md -[deity]: datatype-deity.md -[race]: datatype-race.md -[taskmember]: datatype-task.md -[invslotwindow]: datatype-invslotwindow.md -[taskobjective]: datatype-taskobjective.md +## Data Type List + +## [achievement](datatype-achievement.md) +{% include-markdown "reference/data-types/datatype-achievement.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-achievement.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-achievement.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-achievement.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [achievementcat](datatype-achievementcat.md) +{% include-markdown "reference/data-types/datatype-achievementcat.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-achievementcat.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-achievementcat.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-achievementcat.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [achievementmgr](datatype-achievementmgr.md) +{% include-markdown "reference/data-types/datatype-achievementmgr.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-achievementmgr.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-achievementmgr.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-achievementmgr.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [achievementobj](datatype-achievementobj.md) +{% include-markdown "reference/data-types/datatype-achievementobj.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-achievementobj.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-achievementobj.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-achievementobj.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [advloot](datatype-advloot.md) +{% include-markdown "reference/data-types/datatype-advloot.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-advloot.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-advloot.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-advloot.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [advlootitem](datatype-advlootitem.md) +{% include-markdown "reference/data-types/datatype-advlootitem.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-advlootitem.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-advlootitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-advlootitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [alert](datatype-alert.md) +{% include-markdown "reference/data-types/datatype-alert.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-alert.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-alert.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-alert.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [alertlist](datatype-alertlist.md) +{% include-markdown "reference/data-types/datatype-alertlist.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-alertlist.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-alertlist.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-alertlist.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [altability](datatype-altability.md) +{% include-markdown "reference/data-types/datatype-altability.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-altability.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-altability.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-altability.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [argb](datatype-argb.md) +{% include-markdown "reference/data-types/datatype-argb.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-argb.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-argb.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-argb.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [array](datatype-array.md) +{% include-markdown "reference/data-types/datatype-array.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-array.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-array.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-array.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [augtype](datatype-augtype.md) +{% include-markdown "reference/data-types/datatype-augtype.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-augtype.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-augtype.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-augtype.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [auratype](datatype-auratype.md) +{% include-markdown "reference/data-types/datatype-auratype.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-auratype.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-auratype.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-auratype.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [bandolier](datatype-bandolier.md) +{% include-markdown "reference/data-types/datatype-bandolier.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-bandolier.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-bandolier.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-bandolier.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [bank](datatype-bank.md) +{% include-markdown "reference/data-types/datatype-bank.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-bank.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-bank.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-bank.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [body](datatype-body.md) +{% include-markdown "reference/data-types/datatype-body.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-body.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-body.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-body.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [bool](datatype-bool.md) +{% include-markdown "reference/data-types/datatype-bool.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-bool.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-bool.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-bool.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [buff](datatype-buff.md) +{% include-markdown "reference/data-types/datatype-buff.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-buff.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-buff.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-buff.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [byte](datatype-byte.md) +{% include-markdown "reference/data-types/datatype-byte.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-byte.md') }} +## [cachedbuff](datatype-cachedbuff.md) +{% include-markdown "reference/data-types/datatype-cachedbuff.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-cachedbuff.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-cachedbuff.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-cachedbuff.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [character](datatype-character.md) +{% include-markdown "reference/data-types/datatype-character.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-character.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-character.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-character.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [charselectlist](datatype-charselectlist.md) +{% include-markdown "reference/data-types/datatype-charselectlist.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-charselectlist.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-charselectlist.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-charselectlist.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [class](datatype-class.md) +{% include-markdown "reference/data-types/datatype-class.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-class.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-class.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-class.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [corpse](datatype-corpse.md) +{% include-markdown "reference/data-types/datatype-corpse.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-corpse.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-corpse.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-corpse.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [currentzone](datatype-currentzone.md) +{% include-markdown "reference/data-types/datatype-currentzone.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-currentzone.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-currentzone.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-currentzone.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [deity](datatype-deity.md) +{% include-markdown "reference/data-types/datatype-deity.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-deity.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-deity.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-deity.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [double](datatype-double.md) +{% include-markdown "reference/data-types/datatype-double.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-double.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-double.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-double.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [dynamiczone](datatype-dynamiczone.md) +{% include-markdown "reference/data-types/datatype-dynamiczone.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-dynamiczone.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-dynamiczone.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-dynamiczone.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [dzmember](datatype-dzmember.md) +{% include-markdown "reference/data-types/datatype-dzmember.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-dzmember.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-dzmember.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-dzmember.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [dztimer](datatype-dztimer.md) +{% include-markdown "reference/data-types/datatype-dztimer.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-dztimer.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-dztimer.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-dztimer.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [everquest](datatype-everquest.md) +{% include-markdown "reference/data-types/datatype-everquest.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-everquest.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-everquest.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-everquest.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [evolving](datatype-evolving.md) +{% include-markdown "reference/data-types/datatype-evolving.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-evolving.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-evolving.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-evolving.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [fellowship](datatype-fellowship.md) +{% include-markdown "reference/data-types/datatype-fellowship.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-fellowship.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-fellowship.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-fellowship.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [fellowshipmember](datatype-fellowshipmember.md) +{% include-markdown "reference/data-types/datatype-fellowshipmember.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-fellowshipmember.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-fellowshipmember.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-fellowshipmember.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [float](datatype-float.md) +{% include-markdown "reference/data-types/datatype-float.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-float.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-float.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-float.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [framelimiter](datatype-framelimiter.md) +{% include-markdown "reference/data-types/datatype-framelimiter.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-framelimiter.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-framelimiter.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-framelimiter.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [friend](datatype-friend.md) +{% include-markdown "reference/data-types/datatype-friend.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-friend.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-friend.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-friend.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [ground](datatype-ground.md) +{% include-markdown "reference/data-types/datatype-ground.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-ground.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-ground.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-ground.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [group](datatype-group.md) +{% include-markdown "reference/data-types/datatype-group.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-group.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-group.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-group.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [groupmember](datatype-groupmember.md) +{% include-markdown "reference/data-types/datatype-groupmember.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-groupmember.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-groupmember.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-groupmember.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [heading](datatype-heading.md) +{% include-markdown "reference/data-types/datatype-heading.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-heading.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-heading.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-heading.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [hotbuttonwindow](datatype-hotbuttonwindow.md) +{% include-markdown "reference/data-types/datatype-hotbuttonwindow.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-hotbuttonwindow.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-hotbuttonwindow.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-hotbuttonwindow.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [ini](datatype-ini.md) +{% include-markdown "reference/data-types/datatype-ini.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-ini.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-ini.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-ini.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [inifile](datatype-inifile.md) +{% include-markdown "reference/data-types/datatype-inifile.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inifile.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-inifile.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-inifile.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [inifilesection](datatype-inifilesection.md) +{% include-markdown "reference/data-types/datatype-inifilesection.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inifilesection.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-inifilesection.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-inifilesection.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [inifilesectionkey](datatype-inifilesectionkey.md) +{% include-markdown "reference/data-types/datatype-inifilesectionkey.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inifilesectionkey.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-inifilesectionkey.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-inifilesectionkey.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [int](datatype-int.md) +{% include-markdown "reference/data-types/datatype-int.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-int.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-int.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-int.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [int64](datatype-int64.md) +{% include-markdown "reference/data-types/datatype-int64.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-int64.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-int64.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-int64.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [inventory](datatype-inventory.md) +{% include-markdown "reference/data-types/datatype-inventory.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-inventory.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-inventory.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-inventory.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [invslot](datatype-invslot.md) +{% include-markdown "reference/data-types/datatype-invslot.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-invslot.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-invslot.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-invslot.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [invslotwindow](datatype-invslotwindow.md) +{% include-markdown "reference/data-types/datatype-invslotwindow.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-invslotwindow.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-invslotwindow.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-invslotwindow.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [item](datatype-item.md) +{% include-markdown "reference/data-types/datatype-item.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-item.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-item.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-item.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [itemfilterdata](datatype-itemfilterdata.md) +{% include-markdown "reference/data-types/datatype-itemfilterdata.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-itemfilterdata.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-itemfilterdata.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-itemfilterdata.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [itemspell](datatype-itemspell.md) +{% include-markdown "reference/data-types/datatype-itemspell.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-itemspell.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-itemspell.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-itemspell.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [keyring](datatype-keyring.md) +{% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyring.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [keyringitem](datatype-keyringitem.md) +{% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyringitem.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [macro](datatype-macro.md) +{% include-markdown "reference/data-types/datatype-macro.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-macro.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-macro.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-macro.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [macroquest](datatype-macroquest.md) +{% include-markdown "reference/data-types/datatype-macroquest.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-macroquest.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-macroquest.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-macroquest.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [math](datatype-math.md) +{% include-markdown "reference/data-types/datatype-math.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-math.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-math.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-math.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [menu](datatype-menu.md) +{% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-menu.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [mercenary](datatype-mercenary.md) +{% include-markdown "reference/data-types/datatype-mercenary.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-mercenary.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-mercenary.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-mercenary.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [merchant](datatype-merchant.md) +{% include-markdown "reference/data-types/datatype-merchant.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-merchant.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-merchant.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-merchant.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [pet](datatype-pet.md) +{% include-markdown "reference/data-types/datatype-pet.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pet.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-pet.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-pet.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [plugin](datatype-plugin.md) +{% include-markdown "reference/data-types/datatype-plugin.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-plugin.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-plugin.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-plugin.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [pointmerchant](datatype-pointmerchant.md) +{% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pointmerchant.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-pointmerchant.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [pointmerchantitem](datatype-pointmerchantitem.md) +{% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-pointmerchantitem.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-pointmerchantitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [race](datatype-race.md) +{% include-markdown "reference/data-types/datatype-race.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-race.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-race.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-race.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [raid](datatype-raid.md) +{% include-markdown "reference/data-types/datatype-raid.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-raid.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-raid.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-raid.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [raidmember](datatype-raidmember.md) +{% include-markdown "reference/data-types/datatype-raidmember.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-raidmember.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-raidmember.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-raidmember.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [range](datatype-range.md) +{% include-markdown "reference/data-types/datatype-range.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-range.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-range.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-range.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [skill](datatype-skill.md) +{% include-markdown "reference/data-types/datatype-skill.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-skill.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-skill.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-skill.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [social](datatype-social.md) +{% include-markdown "reference/data-types/datatype-social.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-social.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-social.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-social.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [spawn](datatype-spawn.md) +{% include-markdown "reference/data-types/datatype-spawn.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-spawn.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-spawn.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-spawn.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [spell](datatype-spell.md) +{% include-markdown "reference/data-types/datatype-spell.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-spell.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-spell.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-spell.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [string](datatype-string.md) +{% include-markdown "reference/data-types/datatype-string.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-string.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-string.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-string.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [switch](datatype-switch.md) +{% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-switch.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-switch.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [target](datatype-target.md) +{% include-markdown "reference/data-types/datatype-target.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-target.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-target.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-target.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [task](datatype-task.md) +{% include-markdown "reference/data-types/datatype-task.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-task.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-task.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-task.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [taskmember](datatype-taskmember.md) +{% include-markdown "reference/data-types/datatype-taskmember.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-taskmember.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-taskmember.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-taskmember.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [taskobjective](datatype-taskobjective.md) +{% include-markdown "reference/data-types/datatype-taskobjective.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-taskobjective.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-taskobjective.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-taskobjective.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [ticks](datatype-ticks.md) +{% include-markdown "reference/data-types/datatype-ticks.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-ticks.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-ticks.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-ticks.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [time](datatype-time.md) +{% include-markdown "reference/data-types/datatype-time.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-time.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-time.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-time.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [timer](datatype-timer.md) +{% include-markdown "reference/data-types/datatype-timer.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-timer.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-timer.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-timer.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [timestamp](datatype-timestamp.md) +{% include-markdown "reference/data-types/datatype-timestamp.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-timestamp.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-timestamp.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-timestamp.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [tradeskilldepot](datatype-tradeskilldepot.md) +{% include-markdown "reference/data-types/datatype-tradeskilldepot.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-tradeskilldepot.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-tradeskilldepot.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-tradeskilldepot.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [type](datatype-type.md) +{% include-markdown "reference/data-types/datatype-type.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-type.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-type.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-type.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [window](datatype-window.md) +{% include-markdown "reference/data-types/datatype-window.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-window.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-window.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-window.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [worldlocation](datatype-worldlocation.md) +{% include-markdown "reference/data-types/datatype-worldlocation.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-worldlocation.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-worldlocation.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-worldlocation.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [xtarget](datatype-xtarget.md) +{% include-markdown "reference/data-types/datatype-xtarget.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-xtarget.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-xtarget.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-xtarget.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} + +## [zone](datatype-zone.md) +{% include-markdown "reference/data-types/datatype-zone.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-zone.md') }} +: <h3>Members</h3> + {% include-markdown "reference/data-types/datatype-zone.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} + {% include-markdown "reference/data-types/datatype-zone.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} \ No newline at end of file diff --git a/reference/top-level-objects/README.md b/reference/top-level-objects/README.md index 6bc7aa7b2..2a378191e 100644 --- a/reference/top-level-objects/README.md +++ b/reference/top-level-objects/README.md @@ -32,48 +32,313 @@ A [Beginners Guide to TLOs and MQ2DataVars](../../macros/beginners-guide-datatyp ## TLO List -See sidebar for full list. -[int]: datatype-int.md -[string]: datatype-string.md -[achievementobj]: datatype-achievementobj.md -[bool]: datatype-bool.md -[time]: datatype-time.md -[achievement]: datatype-achievement.md -[achievementcat]: datatype-achievementcat.md -[altability]: datatype-altability.md -[spell]: datatype-spell.md -[bandolieritem]: #bandolieritem-datatype -[int64]: datatype-int64.md -[timestamp]: datatype-timestamp.md -[float]: datatype-float.md -[buff]: datatype-buff.md -[spawn]: datatype-spawn.md -[auratype]: datatype-auratype.md -[item]: datatype-item.md -[worldlocation]: datatype-worldlocation.md -[ticks]: datatype-ticks.md -[fellowship]: datatype-fellowship.md -[strinrg]: datatype-string.md -[xtarget]: datatype-xtarget.md -[dzmember]: datatype-dzmember.md -[window]: datatype-window.md -[zone]: datatype-zone.md -[fellowshipmember]: datatype-fellowshipmember.md -[class]: datatype-class.md -[heading]: datatype-heading.md -[ground]: datatype-ground.md -[inifile]: datatype-inifile.md -[inifilesection]: datatype-inifilesection.md -[inifilesectionkey]: datatype-inifilesectionkey.md -[double]: datatype-double.md -[invslot]: datatype-invslot.md -[augtype]: datatype-augtype.md -[itemspell]: datatype-itemspell.md -[evolving]: datatype-evolving.md -[keyringitem]: datatype-keyringitem.md -[raidmember]: datatype-raidmember.md -[body]: datatype-body.md -[cachedbuff]: datatype-cachedbuff.md -[deity]: datatype-deity.md -[race]: datatype-race.md -[taskmember]: datatype-task.md +## [Achievement](tlo-achievement.md) +{% include-markdown "reference/top-level-objects/tlo-achievement.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-achievement.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-achievement.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-achievement.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [AdvLoot](tlo-advloot.md) +{% include-markdown "reference/top-level-objects/tlo-advloot.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-advloot.md') }} + +## [Alert](tlo-alert.md) +{% include-markdown "reference/top-level-objects/tlo-alert.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-alert.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-alert.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-alert.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Alias](tlo-alias.md) +{% include-markdown "reference/top-level-objects/tlo-alias.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-alias.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-alias.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-alias.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [AltAbility](tlo-altability.md) +{% include-markdown "reference/top-level-objects/tlo-altability.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-altability.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-altability.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-altability.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Bool](tlo-bool.md) +{% include-markdown "reference/top-level-objects/tlo-bool.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-bool.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-bool.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-bool.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Corpse](tlo-corpse.md) +{% include-markdown "reference/top-level-objects/tlo-corpse.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-corpse.md') }} + +## [Cursor](tlo-cursor.md) +{% include-markdown "reference/top-level-objects/tlo-cursor.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-cursor.md') }} + +## [Defined](tlo-defined.md) +{% include-markdown "reference/top-level-objects/tlo-defined.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-defined.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-defined.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-defined.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [DisplayItem](tlo-displayitem.md) +{% include-markdown "reference/top-level-objects/tlo-displayitem.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-displayitem.md') }} + +## [DoorTarget](tlo-doortarget.md) +{% include-markdown "reference/top-level-objects/tlo-doortarget.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-doortarget.md') }} + +## [DynamicZone](tlo-dynamiczone.md) +{% include-markdown "reference/top-level-objects/tlo-dynamiczone.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-dynamiczone.md') }} + +## [EverQuest](tlo-everquest.md) +{% include-markdown "reference/top-level-objects/tlo-everquest.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-everquest.md') }} + +## [Familiar](tlo-familiar.md) +{% include-markdown "reference/top-level-objects/tlo-familiar.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-familiar.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-familiar.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-familiar.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [FindItem](tlo-finditem.md) +{% include-markdown "reference/top-level-objects/tlo-finditem.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-finditem.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-finditem.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-finditem.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [FindItemBank](tlo-finditembank.md) +{% include-markdown "reference/top-level-objects/tlo-finditembank.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-finditembank.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-finditembank.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-finditembank.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [FindItemBankCount](tlo-finditembankcount.md) +{% include-markdown "reference/top-level-objects/tlo-finditembankcount.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-finditembankcount.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-finditembankcount.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-finditembankcount.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [FindItemCount](tlo-finditemcount.md) +{% include-markdown "reference/top-level-objects/tlo-finditemcount.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-finditemcount.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-finditemcount.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-finditemcount.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Float](tlo-float.md) +{% include-markdown "reference/top-level-objects/tlo-float.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-float.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-float.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-float.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [FrameLimiter](tlo-framelimiter.md) +{% include-markdown "reference/top-level-objects/tlo-framelimiter.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-framelimiter.md') }} + +## [Friends](tlo-friends.md) +{% include-markdown "reference/top-level-objects/tlo-friends.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-friends.md') }} + +## [GameTime](tlo-gametime.md) +{% include-markdown "reference/top-level-objects/tlo-gametime.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-gametime.md') }} + +## [Ground](tlo-ground.md) +{% include-markdown "reference/top-level-objects/tlo-ground.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-ground.md') }} + +## [GroundItemCount](tlo-grounditemcount.md) +{% include-markdown "reference/top-level-objects/tlo-grounditemcount.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-grounditemcount.md') }} + +## [Group](tlo-group.md) +{% include-markdown "reference/top-level-objects/tlo-group.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-group.md') }} + +## [Heading](tlo-heading.md) +{% include-markdown "reference/top-level-objects/tlo-heading.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-heading.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-heading.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-heading.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [If](tlo-if.md) +{% include-markdown "reference/top-level-objects/tlo-if.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-if.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-if.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-if.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Illusion](tlo-illusion.md) +{% include-markdown "reference/top-level-objects/tlo-illusion.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-illusion.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-illusion.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-illusion.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Ini](tlo-ini.md) +{% include-markdown "reference/top-level-objects/tlo-ini.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-ini.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-ini.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-ini.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Int](tlo-int.md) +{% include-markdown "reference/top-level-objects/tlo-int.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-int.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-int.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-int.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [InvSlot](tlo-invslot.md) +{% include-markdown "reference/top-level-objects/tlo-invslot.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-invslot.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-invslot.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-invslot.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Inventory](tlo-inventory.md) +{% include-markdown "reference/top-level-objects/tlo-inventory.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-inventory.md') }} + +## [ItemTarget](tlo-itemtarget.md) +{% include-markdown "reference/top-level-objects/tlo-itemtarget.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-itemtarget.md') }} + +## [LastSpawn](tlo-lastspawn.md) +{% include-markdown "reference/top-level-objects/tlo-lastspawn.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-lastspawn.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-lastspawn.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-lastspawn.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [LineOfSight](tlo-lineofsight.md) +{% include-markdown "reference/top-level-objects/tlo-lineofsight.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-lineofsight.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-lineofsight.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-lineofsight.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Macro](tlo-macro.md) +{% include-markdown "reference/top-level-objects/tlo-macro.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-macro.md') }} + +## [MacroQuest](tlo-macroquest.md) +{% include-markdown "reference/top-level-objects/tlo-macroquest.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-macroquest.md') }} + +## [Math](tlo-math.md) +{% include-markdown "reference/top-level-objects/tlo-math.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-math.md') }} + +## [Me](tlo-me.md) +{% include-markdown "reference/top-level-objects/tlo-me.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-me.md') }} + +## [Menu](tlo-menu.md) +{% include-markdown "reference/top-level-objects/tlo-menu.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-menu.md') }} + +## [Mercenary](tlo-mercenary.md) +{% include-markdown "reference/top-level-objects/tlo-mercenary.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-mercenary.md') }} + +## [Merchant](tlo-merchant.md) +{% include-markdown "reference/top-level-objects/tlo-merchant.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-merchant.md') }} + +## [Mount](tlo-mount.md) +{% include-markdown "reference/top-level-objects/tlo-mount.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-mount.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-mount.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-mount.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [NearestSpawn](tlo-nearestspawn.md) +{% include-markdown "reference/top-level-objects/tlo-nearestspawn.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-nearestspawn.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-nearestspawn.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-nearestspawn.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Pet](tlo-pet.md) +{% include-markdown "reference/top-level-objects/tlo-pet.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-pet.md') }} + +## [Plugin](tlo-plugin.md) +{% include-markdown "reference/top-level-objects/tlo-plugin.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-plugin.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-plugin.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-plugin.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [PointMerchant](tlo-pointmerchant.md) +{% include-markdown "reference/top-level-objects/tlo-pointmerchant.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-pointmerchant.md') }} + +## [Raid](tlo-raid.md) +{% include-markdown "reference/top-level-objects/tlo-raid.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-raid.md') }} + +## [Range](tlo-range.md) +{% include-markdown "reference/top-level-objects/tlo-range.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-range.md') }} + +## [Select](tlo-select.md) +{% include-markdown "reference/top-level-objects/tlo-select.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-select.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-select.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-select.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [SelectedItem](tlo-selecteditem.md) +{% include-markdown "reference/top-level-objects/tlo-selecteditem.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-selecteditem.md') }} +## [Skill](tlo-skill.md) +{% include-markdown "reference/top-level-objects/tlo-skill.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-skill.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-skill.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-skill.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Social](tlo-social.md) +{% include-markdown "reference/top-level-objects/tlo-social.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-social.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-social.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-social.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Spawn](tlo-spawn.md) +{% include-markdown "reference/top-level-objects/tlo-spawn.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-spawn.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-spawn.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-spawn.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [SpawnCount](tlo-spawncount.md) +{% include-markdown "reference/top-level-objects/tlo-spawncount.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-spawncount.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-spawncount.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-spawncount.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Spell](tlo-spell.md) +{% include-markdown "reference/top-level-objects/tlo-spell.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-spell.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-spell.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-spell.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [String](tlo-string.md) +{% include-markdown "reference/top-level-objects/tlo-string.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-string.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-string.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-string.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [SubDefined](tlo-subdefined.md) +{% include-markdown "reference/top-level-objects/tlo-subdefined.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-subdefined.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-subdefined.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-subdefined.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Switch](tlo-switch.md) +{% include-markdown "reference/top-level-objects/tlo-switch.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-switch.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-switch.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-switch.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [SwitchTarget](tlo-switchtarget.md) +{% include-markdown "reference/top-level-objects/tlo-switchtarget.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-switchtarget.md') }} + +## [Target](tlo-target.md) +{% include-markdown "reference/top-level-objects/tlo-target.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-target.md') }} + +## [Task](tlo-task.md) +{% include-markdown "reference/top-level-objects/tlo-task.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-task.md') }} + +## [TeleportationItem](tlo-teleportationitem.md) +{% include-markdown "reference/top-level-objects/tlo-teleportationitem.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-teleportationitem.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-teleportationitem.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-teleportationitem.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Time](tlo-time.md) +{% include-markdown "reference/top-level-objects/tlo-time.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-time.md') }} + +## [TradeskillDepot](tlo-tradeskilldepot.md) +{% include-markdown "reference/top-level-objects/tlo-tradeskilldepot.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-tradeskilldepot.md') }} + +## [Type](tlo-type.md) +{% include-markdown "reference/top-level-objects/tlo-type.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-type.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-type.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-type.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Window](tlo-window.md) +{% include-markdown "reference/top-level-objects/tlo-window.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-window.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-window.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-window.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} + +## [Zone](tlo-zone.md) +{% include-markdown "reference/top-level-objects/tlo-zone.md" start="<!--tlo-desc-start-->" end="<!--tlo-desc-end-->" trailing-newlines=false %} {{ readMore('reference/top-level-objects/tlo-zone.md') }} +: <h3>Forms</h3> + {% include-markdown "reference/top-level-objects/tlo-zone.md" start="<!--tlo-forms-start-->" end="<!--tlo-forms-end-->" %} + {% include-markdown "reference/top-level-objects/tlo-zone.md" start="<!--tlo-linkrefs-start-->" end="<!--tlo-linkrefs-end-->" %} From 8f207ace022cc693c0a0a9ae11d3e205b79a94bd Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 3 Sep 2025 13:28:44 -0500 Subject: [PATCH 38/41] add pages to navigation --- mkdocs.yml | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index d7e27a7a5..e8af9cbc7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -502,12 +502,14 @@ nav: - MacroQuest: reference/top-level-objects/tlo-macroquest.md - Math: reference/top-level-objects/tlo-math.md - Me: reference/top-level-objects/tlo-me.md + - Menu: reference/top-level-objects/tlo-menu.md - Mercenary: reference/top-level-objects/tlo-mercenary.md - Merchant: reference/top-level-objects/tlo-merchant.md - Mount: reference/top-level-objects/tlo-mount.md - NearestSpawn: reference/top-level-objects/tlo-nearestspawn.md - Pet: reference/top-level-objects/tlo-pet.md - Plugin: reference/top-level-objects/tlo-plugin.md + - PointMerchant: reference/top-level-objects/tlo-pointmerchant.md - Raid: reference/top-level-objects/tlo-raid.md - Range: reference/top-level-objects/tlo-range.md - Select: reference/top-level-objects/tlo-select.md @@ -517,9 +519,13 @@ nav: - Spawn: reference/top-level-objects/tlo-spawn.md - SpawnCount: reference/top-level-objects/tlo-spawncount.md - Spell: reference/top-level-objects/tlo-spell.md + - String: reference/top-level-objects/tlo-string.md + - SubDefined: reference/top-level-objects/tlo-subdefined.md - Switch: reference/top-level-objects/tlo-switch.md + - SwitchTarget: reference/top-level-objects/tlo-switchtarget.md - Target: reference/top-level-objects/tlo-target.md - Task: reference/top-level-objects/tlo-task.md + - TeleportationItem: reference/top-level-objects/tlo-teleportationitem.md - Time: reference/top-level-objects/tlo-time.md - TradeskillDepot: reference/top-level-objects/tlo-tradeskilldepot.md - Type: reference/top-level-objects/tlo-type.md @@ -531,6 +537,11 @@ nav: - achievement: reference/data-types/datatype-achievement.md - achievementcat: reference/data-types/datatype-achievementcat.md - achievementobj: reference/data-types/datatype-achievementobj.md + - achievementmgr: reference/data-types/datatype-achievementmgr.md + - advloot: reference/data-types/datatype-advloot.md + - advlootitem: reference/data-types/datatype-advlootitem.md + - alert: reference/data-types/datatype-alert.md + - alertlist: reference/data-types/datatype-alertlist.md - altability: reference/data-types/datatype-altability.md - argb: reference/data-types/datatype-argb.md - array: reference/data-types/datatype-array.md @@ -558,7 +569,8 @@ nav: - fellowship: reference/data-types/datatype-fellowship.md - fellowshipmember: reference/data-types/datatype-fellowshipmember.md - float: reference/data-types/datatype-float.md - - framelmiter: reference/data-types/datatype-framelimiter.md + - framelimiter: reference/data-types/datatype-framelimiter.md + - friend: reference/data-types/datatype-friend.md - ground: reference/data-types/datatype-ground.md - group: reference/data-types/datatype-group.md - groupmember: reference/data-types/datatype-groupmember.md @@ -574,16 +586,20 @@ nav: - invslot: reference/data-types/datatype-invslot.md - invslotwindow: reference/data-types/datatype-invslotwindow.md - item: reference/data-types/datatype-item.md + - itemfilterdata: reference/data-types/datatype-itemfilterdata.md - itemspell: reference/data-types/datatype-itemspell.md - keyring: reference/data-types/datatype-keyring.md - keyringitem: reference/data-types/datatype-keyringitem.md - macro: reference/data-types/datatype-macro.md - macroquest: reference/data-types/datatype-macroquest.md - math: reference/data-types/datatype-math.md + - menu: reference/data-types/datatype-menu.md - mercenary: reference/data-types/datatype-mercenary.md - merchant: reference/data-types/datatype-merchant.md - pet: reference/data-types/datatype-pet.md - plugin: reference/data-types/datatype-plugin.md + - pointmerchant: reference/data-types/datatype-pointmerchant.md + - pointmerchantitem: reference/data-types/datatype-pointmerchantitem.md - race: reference/data-types/datatype-race.md - raid: reference/data-types/datatype-raid.md - raidmember: reference/data-types/datatype-raidmember.md From 83f4168e84698831c07c06e1ffc77ecebb5070cf Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 3 Sep 2025 13:50:14 -0500 Subject: [PATCH 39/41] remove indexes from search --- reference/commands/README.md | 5 +++++ reference/data-types/README.md | 5 +++++ reference/top-level-objects/README.md | 5 +++++ 3 files changed, 15 insertions(+) diff --git a/reference/commands/README.md b/reference/commands/README.md index 61ad516c2..df4c96479 100644 --- a/reference/commands/README.md +++ b/reference/commands/README.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Slash Commands ## Base diff --git a/reference/data-types/README.md b/reference/data-types/README.md index 0096131a7..ef22c3cfb 100644 --- a/reference/data-types/README.md +++ b/reference/data-types/README.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Data Types See Also: [Top Level Objects Reference](../top-level-objects/README.md). diff --git a/reference/top-level-objects/README.md b/reference/top-level-objects/README.md index 2a378191e..9e65e93c1 100644 --- a/reference/top-level-objects/README.md +++ b/reference/top-level-objects/README.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Top-Level Objects A "Top-Level Object" is any kind of object that you can start with when trying to find a property. From 5527181d39dcc2b92e45c960972938e07d9000d4 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Wed, 3 Sep 2025 18:54:28 -0500 Subject: [PATCH 40/41] label include blocks, don't count them for "read more" link --- main.py | 30 +++++++++---------- .../core-plugins/autologin/tlo-autologin.md | 3 ++ .../core-plugins/bzsrch/bzsrch-tlo-bazaar.md | 9 ++++-- .../itemdisplay/tlo-displayitem.md | 8 +++-- .../top-level-objects/tlo-achievement.md | 5 ++-- reference/top-level-objects/tlo-advloot.md | 4 +-- reference/top-level-objects/tlo-alert.md | 4 +-- reference/top-level-objects/tlo-altability.md | 3 +- reference/top-level-objects/tlo-corpse.md | 3 +- .../top-level-objects/tlo-dynamiczone.md | 3 +- reference/top-level-objects/tlo-everquest.md | 3 +- reference/top-level-objects/tlo-familiar.md | 3 +- .../top-level-objects/tlo-framelimiter.md | 4 ++- reference/top-level-objects/tlo-friends.md | 5 ++-- reference/top-level-objects/tlo-ground.md | 3 +- reference/top-level-objects/tlo-group.md | 3 +- reference/top-level-objects/tlo-heading.md | 4 ++- reference/top-level-objects/tlo-illusion.md | 3 +- reference/top-level-objects/tlo-ini.md | 3 +- reference/top-level-objects/tlo-inventory.md | 3 +- reference/top-level-objects/tlo-invslot.md | 3 +- reference/top-level-objects/tlo-macro.md | 9 +++--- reference/top-level-objects/tlo-macroquest.md | 3 +- reference/top-level-objects/tlo-math.md | 3 +- reference/top-level-objects/tlo-menu.md | 10 ++++--- reference/top-level-objects/tlo-mercenary.md | 4 +-- reference/top-level-objects/tlo-merchant.md | 3 +- reference/top-level-objects/tlo-mount.md | 12 ++++---- reference/top-level-objects/tlo-pet.md | 7 +++-- reference/top-level-objects/tlo-plugin.md | 3 +- reference/top-level-objects/tlo-raid.md | 4 +-- reference/top-level-objects/tlo-range.md | 10 +++---- reference/top-level-objects/tlo-skill.md | 3 +- reference/top-level-objects/tlo-social.md | 4 +-- reference/top-level-objects/tlo-spell.md | 3 +- reference/top-level-objects/tlo-switch.md | 4 +-- reference/top-level-objects/tlo-target.md | 9 +++--- reference/top-level-objects/tlo-task.md | 4 +-- .../tlo-teleportationitem.md | 10 ++++--- reference/top-level-objects/tlo-time.md | 4 +-- .../top-level-objects/tlo-tradeskilldepot.md | 4 +-- reference/top-level-objects/tlo-type.md | 4 +-- reference/top-level-objects/tlo-window.md | 10 +++---- reference/top-level-objects/tlo-zone.md | 4 +-- 44 files changed, 137 insertions(+), 103 deletions(-) diff --git a/main.py b/main.py index 5be1815b9..8eabf7637 100644 --- a/main.py +++ b/main.py @@ -84,25 +84,23 @@ def relative_link(target_file_path, embedding_page_src_uri, base_dir=None): # extra sections beyond Members/Forms/Description def has_extra_sections(content): SECTION_PATTERN = r'^##\s+(.+?)\s*$' - target_sections = {"Members", "Forms", "Description", "Associated DataTypes", "DataTypes"} + target_sections = {"Syntax", "Members", "Forms", "Description", "Associated DataTypes", "DataTypes", "See also"} lines = content.split('\n') - sections = [] + in_datatypes_section = False - # Find all section headers and their positions + # Find all section headers that aren't within an include block for i, line in enumerate(lines): - match = re.match(SECTION_PATTERN, line) - if match: - sections.append((i, match.group(1).strip())) - - # Find last occurrence of target sections - last_target_index = -1 - for idx, (line_num, section) in enumerate(sections): - if section in target_sections: - last_target_index = idx - - # Check if there are sections after the last target section - if last_target_index != -1 and len(sections) > last_target_index + 1: - return True + if '<!--tlo-datatypes-start-->' in line: + in_datatypes_section = True + elif '<!--tlo-datatypes-end-->' in line: + in_datatypes_section = False + + if not in_datatypes_section: + match = re.match(SECTION_PATTERN, line) + if match: + section = match.group(1).strip() + if section not in target_sections: + return True return False \ No newline at end of file diff --git a/plugins/core-plugins/autologin/tlo-autologin.md b/plugins/core-plugins/autologin/tlo-autologin.md index 9bdac1c8d..4e5d663fa 100644 --- a/plugins/core-plugins/autologin/tlo-autologin.md +++ b/plugins/core-plugins/autologin/tlo-autologin.md @@ -15,6 +15,7 @@ Returns "AutoLogin" string when plugin is loaded, provides access to AutoLogin f <!--tlo-forms-end--> ## Associated DataTypes +<!--tlo-datatypes-start--> ## [AutoLogin](datatype-autologin.md) {% @@ -56,6 +57,8 @@ Returns "AutoLogin" string when plugin is loaded, provides access to AutoLogin f end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> + ## Example ```text diff --git a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md index 461de5c86..d0380d052 100644 --- a/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md +++ b/plugins/core-plugins/bzsrch/bzsrch-tlo-bazaar.md @@ -15,6 +15,7 @@ Provides access to bazaar search functionality and results. <!--tlo-forms-end--> ## Associated DataTypes +<!--tlo-datatypes-start--> ## [Bazaar](bzsrch-datatype-bazaar.md) {% @@ -56,6 +57,8 @@ Provides access to bazaar search functionality and results. end="<!--dt-linkrefs-end-->" %} - <!--tlo-linkrefs-start--> - [bazaar]: bzsrch-datatype-bazaar.md - <!--tlo-linkrefs-end--> +<!--tlo-datatypes-end--> + +<!--tlo-linkrefs-start--> +[bazaar]: bzsrch-datatype-bazaar.md +<!--tlo-linkrefs-end--> diff --git a/plugins/core-plugins/itemdisplay/tlo-displayitem.md b/plugins/core-plugins/itemdisplay/tlo-displayitem.md index 4debe07fb..342485db5 100644 --- a/plugins/core-plugins/itemdisplay/tlo-displayitem.md +++ b/plugins/core-plugins/itemdisplay/tlo-displayitem.md @@ -19,6 +19,7 @@ Gives information on item windows <!--tlo-forms-end--> ## Associated DataTypes +<!--tlo-datatypes-start--> ## [DisplayItem](datatype-displayitem.md) {% @@ -40,6 +41,7 @@ Gives information on item windows end="<!--dt-linkrefs-end-->" %} - <!--tlo-linkrefs-start--> - [DisplayItem]: datatype-displayitem.md - <!--tlo-linkrefs-end--> +<!--tlo-datatypes-end--> +<!--tlo-linkrefs-start--> +[DisplayItem]: datatype-displayitem.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-achievement.md b/reference/top-level-objects/tlo-achievement.md index a234b4c7f..2f6d16939 100644 --- a/reference/top-level-objects/tlo-achievement.md +++ b/reference/top-level-objects/tlo-achievement.md @@ -19,7 +19,7 @@ Provides access to achievements. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [achievementmgr](../data-types/datatype-achievementmgr.md) {% include-markdown "reference/data-types/datatype-achievementmgr.md" @@ -39,8 +39,7 @@ Provides access to achievements. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - - +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-advloot.md b/reference/top-level-objects/tlo-advloot.md index e4748394a..025e27981 100644 --- a/reference/top-level-objects/tlo-advloot.md +++ b/reference/top-level-objects/tlo-advloot.md @@ -9,7 +9,7 @@ The AdvLoot TLO grants access to items in the Advanced Loot window. <!--tlo-desc-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [advloot](../data-types/datatype-advloot.md) {% include-markdown "reference/data-types/datatype-advloot.md" @@ -69,7 +69,7 @@ The AdvLoot TLO grants access to items in the Advanced Loot window. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-alert.md b/reference/top-level-objects/tlo-alert.md index 465bcf4a6..6f26a9f50 100644 --- a/reference/top-level-objects/tlo-alert.md +++ b/reference/top-level-objects/tlo-alert.md @@ -19,7 +19,7 @@ Provides access to spawn search filter criteria in alerts. Alerts are created us <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [alert](../data-types/datatype-alert.md) {% include-markdown "reference/data-types/datatype-alert.md" @@ -59,7 +59,7 @@ Provides access to spawn search filter criteria in alerts. Alerts are created us start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-altability.md b/reference/top-level-objects/tlo-altability.md index af15f468a..b9a701b38 100644 --- a/reference/top-level-objects/tlo-altability.md +++ b/reference/top-level-objects/tlo-altability.md @@ -23,7 +23,7 @@ tags: <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [altability](../data-types/datatype-altability.md) {% include-markdown "reference/data-types/datatype-altability.md" @@ -43,6 +43,7 @@ tags: start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-corpse.md b/reference/top-level-objects/tlo-corpse.md index 1cfff493c..642f620e4 100644 --- a/reference/top-level-objects/tlo-corpse.md +++ b/reference/top-level-objects/tlo-corpse.md @@ -15,7 +15,7 @@ Access to objects of type corpse, which is the currently active corpse (ie. the <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [corpse](../data-types/datatype-corpse.md) {% include-markdown "reference/data-types/datatype-corpse.md" @@ -35,6 +35,7 @@ Access to objects of type corpse, which is the currently active corpse (ie. the start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-dynamiczone.md b/reference/top-level-objects/tlo-dynamiczone.md index 47f50b527..dfc8ca1a1 100644 --- a/reference/top-level-objects/tlo-dynamiczone.md +++ b/reference/top-level-objects/tlo-dynamiczone.md @@ -15,7 +15,7 @@ Provides access to properties of the current dynamic (instanced) zone. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [dynamiczone](../data-types/datatype-dynamiczone.md) {% include-markdown "reference/data-types/datatype-dynamiczone.md" @@ -75,6 +75,7 @@ Provides access to properties of the current dynamic (instanced) zone. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-everquest.md b/reference/top-level-objects/tlo-everquest.md index 7b51e755b..7c9adde57 100644 --- a/reference/top-level-objects/tlo-everquest.md +++ b/reference/top-level-objects/tlo-everquest.md @@ -13,7 +13,7 @@ Provides access to general information about the game and its state. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [everquest](../data-types/datatype-everquest.md) {% include-markdown "reference/data-types/datatype-everquest.md" @@ -33,6 +33,7 @@ Provides access to general information about the game and its state. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-familiar.md b/reference/top-level-objects/tlo-familiar.md index cc7011c7b..ee9887855 100644 --- a/reference/top-level-objects/tlo-familiar.md +++ b/reference/top-level-objects/tlo-familiar.md @@ -23,7 +23,7 @@ Used to get information about items on your familiars keyring. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [keyring](../data-types/datatype-keyring.md) {% include-markdown "reference/data-types/datatype-keyring.md" @@ -63,6 +63,7 @@ Used to get information about items on your familiars keyring. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Examples diff --git a/reference/top-level-objects/tlo-framelimiter.md b/reference/top-level-objects/tlo-framelimiter.md index 27ae3def8..812cbd4b0 100644 --- a/reference/top-level-objects/tlo-framelimiter.md +++ b/reference/top-level-objects/tlo-framelimiter.md @@ -16,7 +16,7 @@ The FrameLimiter TLO provides access to the [frame limiter](../../main/features/ <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [framelimiter](../data-types/datatype-framelimiter.md) {% include-markdown "reference/data-types/datatype-framelimiter.md" @@ -37,6 +37,8 @@ The FrameLimiter TLO provides access to the [frame limiter](../../main/features/ end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> + ## Usage Indicates that the frame limiter is enabled: diff --git a/reference/top-level-objects/tlo-friends.md b/reference/top-level-objects/tlo-friends.md index ff3a0c87f..e63550d60 100644 --- a/reference/top-level-objects/tlo-friends.md +++ b/reference/top-level-objects/tlo-friends.md @@ -15,7 +15,7 @@ Grants access to your friends list. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [friend](../data-types/datatype-friend.md) {% include-markdown "reference/data-types/datatype-friend.md" @@ -35,8 +35,7 @@ Grants access to your friends list. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - - +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-ground.md b/reference/top-level-objects/tlo-ground.md index 644e04760..34ce13fc8 100644 --- a/reference/top-level-objects/tlo-ground.md +++ b/reference/top-level-objects/tlo-ground.md @@ -15,7 +15,7 @@ Object which references the ground spawn item you have targeted. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [ground](../data-types/datatype-ground.md) {% include-markdown "reference/data-types/datatype-ground.md" @@ -35,6 +35,7 @@ Object which references the ground spawn item you have targeted. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-group.md b/reference/top-level-objects/tlo-group.md index ff7bec897..591da2513 100644 --- a/reference/top-level-objects/tlo-group.md +++ b/reference/top-level-objects/tlo-group.md @@ -15,7 +15,7 @@ Access to all group-related information. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [group](../data-types/datatype-group.md) {% include-markdown "reference/data-types/datatype-group.md" @@ -55,6 +55,7 @@ Access to all group-related information. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-heading.md b/reference/top-level-objects/tlo-heading.md index 86f1fe720..c9e771cda 100644 --- a/reference/top-level-objects/tlo-heading.md +++ b/reference/top-level-objects/tlo-heading.md @@ -23,7 +23,7 @@ Object that refers to the directional heading to of a location or direction. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [heading](../data-types/datatype-heading.md) {% include-markdown "reference/data-types/datatype-heading.md" @@ -44,6 +44,8 @@ Object that refers to the directional heading to of a location or direction. end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> + ## Usage ``` diff --git a/reference/top-level-objects/tlo-illusion.md b/reference/top-level-objects/tlo-illusion.md index 4f72cf5cd..e299cda46 100644 --- a/reference/top-level-objects/tlo-illusion.md +++ b/reference/top-level-objects/tlo-illusion.md @@ -23,7 +23,7 @@ Used to get information about items on your illusions keyring. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [keyring](../data-types/datatype-keyring.md) {% include-markdown "reference/data-types/datatype-keyring.md" @@ -63,6 +63,7 @@ Used to get information about items on your illusions keyring. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-ini.md b/reference/top-level-objects/tlo-ini.md index 52f8c7341..071e376c0 100644 --- a/reference/top-level-objects/tlo-ini.md +++ b/reference/top-level-objects/tlo-ini.md @@ -26,7 +26,7 @@ Reads value(s) from an ini file located in a relative or absolute path. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [ini](../data-types/datatype-ini.md) {% include-markdown "reference/data-types/datatype-ini.md" @@ -106,6 +106,7 @@ Reads value(s) from an ini file located in a relative or absolute path. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-inventory.md b/reference/top-level-objects/tlo-inventory.md index 38d6ea4e0..d80445e3c 100644 --- a/reference/top-level-objects/tlo-inventory.md +++ b/reference/top-level-objects/tlo-inventory.md @@ -15,7 +15,7 @@ This is a hierarchical container for things relating to inventory (Bank, etc). <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [inventory](../data-types/datatype-inventory.md) {% include-markdown "reference/data-types/datatype-inventory.md" @@ -35,6 +35,7 @@ This is a hierarchical container for things relating to inventory (Bank, etc). start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-invslot.md b/reference/top-level-objects/tlo-invslot.md index 19adcf516..5d258d6fa 100644 --- a/reference/top-level-objects/tlo-invslot.md +++ b/reference/top-level-objects/tlo-invslot.md @@ -19,7 +19,7 @@ Object used to get information on a specific inventory slot. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [invslot](../data-types/datatype-invslot.md) {% include-markdown "reference/data-types/datatype-invslot.md" @@ -39,6 +39,7 @@ Object used to get information on a specific inventory slot. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-macro.md b/reference/top-level-objects/tlo-macro.md index 8f2f5bf92..cf67e7c44 100644 --- a/reference/top-level-objects/tlo-macro.md +++ b/reference/top-level-objects/tlo-macro.md @@ -21,7 +21,7 @@ Information about the macro that's currently running. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [macro](../data-types/datatype-macro.md) {% include-markdown "reference/data-types/datatype-macro.md" @@ -41,7 +41,8 @@ Information about the macro that's currently running. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> +<!--tlo-linkrefs-start--> +[macro]: ../data-types/datatype-macro.md +<!--tlo-linkrefs-end--> - <!--tlo-linkrefs-start--> - [macro]: ../data-types/datatype-macro.md - <!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-macroquest.md b/reference/top-level-objects/tlo-macroquest.md index 50988520f..2da752269 100644 --- a/reference/top-level-objects/tlo-macroquest.md +++ b/reference/top-level-objects/tlo-macroquest.md @@ -13,7 +13,7 @@ Creates an object related to MacroQuest information. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [macroquest](../data-types/datatype-macroquest.md) {% include-markdown "reference/data-types/datatype-macroquest.md" @@ -33,6 +33,7 @@ Creates an object related to MacroQuest information. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-math.md b/reference/top-level-objects/tlo-math.md index 86309ce21..8581d43bb 100644 --- a/reference/top-level-objects/tlo-math.md +++ b/reference/top-level-objects/tlo-math.md @@ -14,7 +14,7 @@ Creates a Math object which gives allows access to the math type members. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [math](../data-types/datatype-math.md) {% include-markdown "reference/data-types/datatype-math.md" @@ -34,6 +34,7 @@ Creates a Math object which gives allows access to the math type members. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-menu.md b/reference/top-level-objects/tlo-menu.md index dfa1eedf1..e8fdcefbb 100644 --- a/reference/top-level-objects/tlo-menu.md +++ b/reference/top-level-objects/tlo-menu.md @@ -17,13 +17,15 @@ Access to menu objects when a menu is open. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [`menu`](../data-types/datatype-menu.md) {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-menu.md') }} : <h3>Members</h3> {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} {% include-markdown "reference/data-types/datatype-menu.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - <!--tlo-linkrefs-start--> - [menu]: ../data-types/datatype-menu.md - <!--tlo-linkrefs-end--> \ No newline at end of file +<!--tlo-datatypes-end--> + +<!--tlo-linkrefs-start--> +[menu]: ../data-types/datatype-menu.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-mercenary.md b/reference/top-level-objects/tlo-mercenary.md index 7d83d237f..41736adf3 100644 --- a/reference/top-level-objects/tlo-mercenary.md +++ b/reference/top-level-objects/tlo-mercenary.md @@ -13,7 +13,7 @@ Object used to get information about your mercenary. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [mercenary](../data-types/datatype-mercenary.md) {% include-markdown "reference/data-types/datatype-mercenary.md" @@ -33,7 +33,7 @@ Object used to get information about your mercenary. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage ``` diff --git a/reference/top-level-objects/tlo-merchant.md b/reference/top-level-objects/tlo-merchant.md index 591b1ad5f..ed7a024ca 100644 --- a/reference/top-level-objects/tlo-merchant.md +++ b/reference/top-level-objects/tlo-merchant.md @@ -13,7 +13,7 @@ Object that interacts with the currently active merchant. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [merchant](../data-types/datatype-merchant.md) {% include-markdown "reference/data-types/datatype-merchant.md" @@ -33,6 +33,7 @@ Object that interacts with the currently active merchant. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-mount.md b/reference/top-level-objects/tlo-mount.md index a70fed829..d09dc8d5c 100644 --- a/reference/top-level-objects/tlo-mount.md +++ b/reference/top-level-objects/tlo-mount.md @@ -23,7 +23,7 @@ Used to get information about items on your Mount keyring. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [keyring](../data-types/datatype-keyring.md) {% include-markdown "reference/data-types/datatype-keyring.md" @@ -64,7 +64,9 @@ Used to get information about items on your Mount keyring. end="<!--dt-linkrefs-end-->" %} - <!--tlo-linkrefs-start--> - [keyring]: ../data-types/datatype-keyring.md - [keyringitem]: ../data-types/datatype-keyringitem.md - <!--tlo-linkrefs-end--> +<!--tlo-datatypes-end--> + +<!--tlo-linkrefs-start--> +[keyring]: ../data-types/datatype-keyring.md +[keyringitem]: ../data-types/datatype-keyringitem.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-pet.md b/reference/top-level-objects/tlo-pet.md index 2fbbf24eb..a2282704d 100644 --- a/reference/top-level-objects/tlo-pet.md +++ b/reference/top-level-objects/tlo-pet.md @@ -16,7 +16,7 @@ Pet object which allows you to get properties of your pet. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [pet](../data-types/datatype-pet.md) {% include-markdown "reference/data-types/datatype-pet.md" @@ -36,13 +36,13 @@ Pet object which allows you to get properties of your pet. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage ``` /echo My Pet's Stance is currently set to: ${Pet.Stance} ``` - ``` /echo My Pet's Name: ${Pet.CleanName}% ``` @@ -52,4 +52,5 @@ Pet object which allows you to get properties of your pet. ``` <!--tlo-linkrefs-start--> [pet]: ../data-types/datatype-pet.md -<!--tlo-linkrefs-end--> \ No newline at end of file +<!--tlo-linkrefs-end--> + diff --git a/reference/top-level-objects/tlo-plugin.md b/reference/top-level-objects/tlo-plugin.md index 5e5ec0bc3..165a661a7 100644 --- a/reference/top-level-objects/tlo-plugin.md +++ b/reference/top-level-objects/tlo-plugin.md @@ -19,7 +19,7 @@ Object that has access to members that provide information on a plugin. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [plugin](../data-types/datatype-plugin.md) {% include-markdown "reference/data-types/datatype-plugin.md" @@ -39,6 +39,7 @@ Object that has access to members that provide information on a plugin. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-raid.md b/reference/top-level-objects/tlo-raid.md index c29ee829c..8c18640e8 100644 --- a/reference/top-level-objects/tlo-raid.md +++ b/reference/top-level-objects/tlo-raid.md @@ -13,7 +13,7 @@ Object that has access to members that provide information on your raid. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [raid](../data-types/datatype-raid.md) {% include-markdown "reference/data-types/datatype-raid.md" @@ -53,7 +53,7 @@ Object that has access to members that provide information on your raid. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage ``` diff --git a/reference/top-level-objects/tlo-range.md b/reference/top-level-objects/tlo-range.md index 75391e8ef..36111252f 100644 --- a/reference/top-level-objects/tlo-range.md +++ b/reference/top-level-objects/tlo-range.md @@ -13,7 +13,7 @@ Test if _n_ is inside a range of 2 numbers or between 2 numbers <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [range](../data-types/datatype-range.md) {% include-markdown "reference/data-types/datatype-range.md" @@ -33,7 +33,7 @@ Test if _n_ is inside a range of 2 numbers or between 2 numbers start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - - <!--tlo-linkrefs-start--> - [range]: ../data-types/datatype-range.md - <!--tlo-linkrefs-end--> +<!--tlo-datatypes-end--> +<!--tlo-linkrefs-start--> +[range]: ../data-types/datatype-range.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-skill.md b/reference/top-level-objects/tlo-skill.md index 73046ca7f..5cf59c7b5 100644 --- a/reference/top-level-objects/tlo-skill.md +++ b/reference/top-level-objects/tlo-skill.md @@ -19,7 +19,7 @@ Object used to get information on your character's skills. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [skill](../data-types/datatype-skill.md) {% include-markdown "reference/data-types/datatype-skill.md" @@ -39,6 +39,7 @@ Object used to get information on your character's skills. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-social.md b/reference/top-level-objects/tlo-social.md index 654f327f0..e2e9d8c08 100644 --- a/reference/top-level-objects/tlo-social.md +++ b/reference/top-level-objects/tlo-social.md @@ -17,7 +17,7 @@ Access data about socials (in-game macro buttons) <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [social](../data-types/datatype-social.md) {% include-markdown "reference/data-types/datatype-social.md" @@ -37,7 +37,7 @@ Access data about socials (in-game macro buttons) start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage !!! Example diff --git a/reference/top-level-objects/tlo-spell.md b/reference/top-level-objects/tlo-spell.md index 722aac043..92849ef28 100644 --- a/reference/top-level-objects/tlo-spell.md +++ b/reference/top-level-objects/tlo-spell.md @@ -19,7 +19,7 @@ Object used to return information on a spell by name or by ID. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [spell](../data-types/datatype-spell.md) {% include-markdown "reference/data-types/datatype-spell.md" @@ -39,6 +39,7 @@ Object used to return information on a spell by name or by ID. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> ## Usage diff --git a/reference/top-level-objects/tlo-switch.md b/reference/top-level-objects/tlo-switch.md index 979ac44ca..1908d68e9 100644 --- a/reference/top-level-objects/tlo-switch.md +++ b/reference/top-level-objects/tlo-switch.md @@ -27,7 +27,7 @@ Object used when you want to find information on targetted doors or switches suc <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [switch](../data-types/datatype-switch.md) {% include-markdown "reference/data-types/datatype-switch.md" @@ -47,7 +47,7 @@ Object used when you want to find information on targetted doors or switches suc start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage ``` diff --git a/reference/top-level-objects/tlo-target.md b/reference/top-level-objects/tlo-target.md index 1da85fd39..9641736ec 100644 --- a/reference/top-level-objects/tlo-target.md +++ b/reference/top-level-objects/tlo-target.md @@ -60,7 +60,7 @@ Object used to get information about your current target. returns "a_pyre_beetle48 will break mezz in 66s" ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [target](../data-types/datatype-target.md) {% include-markdown "reference/data-types/datatype-target.md" @@ -80,7 +80,8 @@ Object used to get information about your current target. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> - <!--tlo-linkrefs-start--> - [target]: ../data-types/datatype-target.md - <!--tlo-linkrefs-end--> +<!--tlo-linkrefs-start--> +[target]: ../data-types/datatype-target.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-task.md b/reference/top-level-objects/tlo-task.md index 21e757a6c..5a4af60f1 100644 --- a/reference/top-level-objects/tlo-task.md +++ b/reference/top-level-objects/tlo-task.md @@ -13,7 +13,7 @@ Object used to return information on a current Task. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [task](../data-types/datatype-task.md) {% include-markdown "reference/data-types/datatype-task.md" @@ -73,7 +73,7 @@ Object used to return information on a current Task. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage ``` diff --git a/reference/top-level-objects/tlo-teleportationitem.md b/reference/top-level-objects/tlo-teleportationitem.md index 51eff6c65..ec208a26d 100644 --- a/reference/top-level-objects/tlo-teleportationitem.md +++ b/reference/top-level-objects/tlo-teleportationitem.md @@ -25,6 +25,7 @@ Returns data on the teleportation item in your keyring. <!--tlo-forms-end--> ## Associated DataTypes +<!--tlo-datatypes-start--> ## [`keyring`](../data-types/datatype-keyring.md) {% include-markdown "reference/data-types/datatype-keyring.md" start="<!--dt-desc-start-->" end="<!--dt-desc-end-->" trailing-newlines=false %} {{ readMore('reference/data-types/datatype-keyring.md') }} : <h3>Members</h3> @@ -36,8 +37,9 @@ Returns data on the teleportation item in your keyring. : <h3>Members</h3> {% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-members-start-->" end="<!--dt-members-end-->" %} {% include-markdown "reference/data-types/datatype-keyringitem.md" start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} +<!--tlo-datatypes-end--> - <!--tlo-linkrefs-start--> - [keyring]: ../data-types/datatype-keyring.md - [keyringitem]: ../data-types/datatype-keyringitem.md - <!--tlo-linkrefs-end--> \ No newline at end of file +<!--tlo-linkrefs-start--> +[keyring]: ../data-types/datatype-keyring.md +[keyringitem]: ../data-types/datatype-keyringitem.md +<!--tlo-linkrefs-end--> \ No newline at end of file diff --git a/reference/top-level-objects/tlo-time.md b/reference/top-level-objects/tlo-time.md index adcf6ae16..af44ba486 100644 --- a/reference/top-level-objects/tlo-time.md +++ b/reference/top-level-objects/tlo-time.md @@ -13,7 +13,7 @@ Object used to return information on real time, not game time. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [time](../data-types/datatype-time.md) {% include-markdown "reference/data-types/datatype-time.md" @@ -33,7 +33,7 @@ Object used to return information on real time, not game time. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage ``` diff --git a/reference/top-level-objects/tlo-tradeskilldepot.md b/reference/top-level-objects/tlo-tradeskilldepot.md index 88f1863cd..9670d836d 100644 --- a/reference/top-level-objects/tlo-tradeskilldepot.md +++ b/reference/top-level-objects/tlo-tradeskilldepot.md @@ -13,7 +13,7 @@ Object that interacts with the personal tradeskill depot, introduced in the Nigh <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [tradeskilldepot](../data-types/datatype-tradeskilldepot.md) {% include-markdown "reference/data-types/datatype-tradeskilldepot.md" @@ -33,7 +33,7 @@ Object that interacts with the personal tradeskill depot, introduced in the Nigh start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Examples ``` diff --git a/reference/top-level-objects/tlo-type.md b/reference/top-level-objects/tlo-type.md index 1a24bb5a6..74d85278e 100644 --- a/reference/top-level-objects/tlo-type.md +++ b/reference/top-level-objects/tlo-type.md @@ -15,7 +15,7 @@ Used to get information on data types. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [type](../data-types/datatype-type.md) {% include-markdown "reference/data-types/datatype-type.md" @@ -35,7 +35,7 @@ Used to get information on data types. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage Determines if a member of a type exists: diff --git a/reference/top-level-objects/tlo-window.md b/reference/top-level-objects/tlo-window.md index 3c7fec920..412066272 100644 --- a/reference/top-level-objects/tlo-window.md +++ b/reference/top-level-objects/tlo-window.md @@ -17,7 +17,7 @@ You can display a list of window names using the /windows command or by using th <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [window](../data-types/datatype-window.md) {% include-markdown "reference/data-types/datatype-window.md" @@ -37,7 +37,7 @@ You can display a list of window names using the /windows command or by using th start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - - <!--tlo-linkrefs-start--> - [window]: ../data-types/datatype-window.md - <!--tlo-linkrefs-end--> +<!--tlo-datatypes-end--> +<!--tlo-linkrefs-start--> +[window]: ../data-types/datatype-window.md +<!--tlo-linkrefs-end--> diff --git a/reference/top-level-objects/tlo-zone.md b/reference/top-level-objects/tlo-zone.md index 2d880e79e..7fe77b0d2 100644 --- a/reference/top-level-objects/tlo-zone.md +++ b/reference/top-level-objects/tlo-zone.md @@ -25,7 +25,7 @@ Used to find information about a particular zone. <!--tlo-forms-end--> ## Associated DataTypes - +<!--tlo-datatypes-start--> ## [zone](../data-types/datatype-zone.md) {% include-markdown "reference/data-types/datatype-zone.md" @@ -65,7 +65,7 @@ Used to find information about a particular zone. start="<!--dt-linkrefs-start-->" end="<!--dt-linkrefs-end-->" %} - +<!--tlo-datatypes-end--> ## Usage ``` From d88a13ab1958c35ffd554b6c938c6690c721e669 Mon Sep 17 00:00:00 2001 From: Redbot <4406896+Redbot@users.noreply.github.com> Date: Thu, 4 Sep 2025 12:22:28 -0500 Subject: [PATCH 41/41] not needed --- reference/data-types/datatype-class.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/reference/data-types/datatype-class.md b/reference/data-types/datatype-class.md index 315869242..3dbc150b1 100644 --- a/reference/data-types/datatype-class.md +++ b/reference/data-types/datatype-class.md @@ -62,25 +62,6 @@ Data about a particular character class : Same as **Name** <!--dt-members-end--> -## Class name and ShortName list: -| **Name** | **ShortName** | -| :--- | :--- | -| Bard | BRD | -| Beastlord | BST | -| Berserker | BER | -| Cleric | CLR | -| Druid | DRU | -| Enchanter | ENC | -| Magician | MAG | -| Monk | MNK | -| Necromancer | NEC | -| Paladin | PAL | -| Ranger | RNG | -| Shadow Knight | SHD | -| Shaman | SHM | -| Warrior | WAR | -| Wizard | WIZ | -| Mercenary | MER | <!--dt-linkrefs-start--> [bool]: datatype-bool.md [int]: datatype-int.md