2023-12-20 18:49:25 +01:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" / >
< title > Unix-like Command style — Evennia latest documentation< / title >
< link rel = "stylesheet" href = "../_static/nature.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< script id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/language_data.js" > < / script >
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "EvscapeRoom" href = "Contrib-Evscaperoom.html" / >
< link rel = "prev" title = "Legacy Comms-commands" href = "Contrib-Mux-Comms-Cmds.html" / >
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Evscaperoom.html" title = "EvscapeRoom"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Mux-Comms-Cmds.html" title = "Legacy Comms-commands"
accesskey="P">previous< / a > |< / li >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia latest< / a > » < / li >
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" accesskey = "U" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Unix-like Command style< / a > < / li >
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > Unix-like Command style< / a > < ul >
< li > < a class = "reference internal" href = "#installation" > Installation< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "Contrib-Mux-Comms-Cmds.html"
title="previous chapter">Legacy Comms-commands< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Contrib-Evscaperoom.html"
title="next chapter">EvscapeRoom< / a > < / p >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Contribs/Contrib-Unixcommand.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / div > < h3 > Links< / h3 >
< ul >
< li > < a href = "https://www.evennia.com/docs/latest/index.html" > Documentation Top< / a > < / li >
< li > < a href = "https://www.evennia.com" > Evennia Home< / a > < / li >
< li > < a href = "https://github.com/evennia/evennia" > Github< / a > < / li >
< li > < a href = "http://games.evennia.com" > Game Index< / a > < / li >
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
< a href = "https://evennia.blogspot.com/" > Blog< / a >
< / li >
< / ul >
2023-12-20 18:20:20 +00:00
< h3 > Doc Versions< / h3 >
< ul >
< li > < a href = "Contrib-Unixcommand.html" > latest (main branch)< / a > < / li >
2023-12-20 19:10:36 +00:00
2023-12-20 22:47:51 +00:00
< li > < a href = "../../3.x/index.html" > v3.0.0 branch (outdated)< / a > < / li >
2023-12-20 22:23:04 +00:00
2023-12-20 22:47:51 +00:00
< li > < a href = "../../2.x/index.html" > v2.0.0 branch (outdated)< / a > < / li >
2023-12-20 18:20:20 +00:00
2023-12-20 22:47:51 +00:00
< li > < a href = "../../1.x/index.html" > v1.0.0 branch (outdated)< / a > < / li >
2023-12-20 18:20:20 +00:00
2023-12-20 22:47:51 +00:00
< li > < a href = "../../0.x/index.html" > v0.9.5 branch (outdated)< / a > < / li >
2023-12-20 18:20:20 +00:00
< / ul >
2023-12-20 18:49:25 +01:00
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section class = "tex2jax_ignore mathjax_ignore" id = "unix-like-command-style" >
< h1 > Unix-like Command style< a class = "headerlink" href = "#unix-like-command-style" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Contribution by Vincent Le Geoff (vlgeoff), 2017< / p >
< p > This module contains a command class with an alternate syntax parser implementing
Unix-style command syntax in-game. This means < code class = "docutils literal notranslate" > < span class = "pre" > --options< / span > < / code > , positional arguments
and stuff like < code class = "docutils literal notranslate" > < span class = "pre" > -n< / span > < span class = "pre" > 10< / span > < / code > . It might not the best syntax for the average player
but can be really useful for builders when they need to have a single command do
many things with many options. It uses the < code class = "docutils literal notranslate" > < span class = "pre" > ArgumentParser< / span > < / code > from Python’
library under the hood.< / p >
< section id = "installation" >
< h2 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > To use, inherit < code class = "docutils literal notranslate" > < span class = "pre" > UnixCommand< / span > < / code > from this module from your own commands. You need
to override two methods:< / p >
< ul class = "simple" >
< li > < p > The < code class = "docutils literal notranslate" > < span class = "pre" > init_parser< / span > < / code > method, which adds options to the parser. Note that you
should normally < em > not< / em > override the normal < code class = "docutils literal notranslate" > < span class = "pre" > parse< / span > < / code > method when inheriting from
< code class = "docutils literal notranslate" > < span class = "pre" > UnixCommand< / span > < / code > .< / p > < / li >
< li > < p > The < code class = "docutils literal notranslate" > < span class = "pre" > func< / span > < / code > method, called to execute the command once parsed (like any Command).< / p > < / li >
< / ul >
< p > Here’ < / p >
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > from< / span > < span class = "nn" > evennia.contrib.base_systems.unixcommand< / span > < span class = "kn" > import< / span > < span class = "n" > UnixCommand< / span >
< span class = "k" > class< / span > < span class = "nc" > CmdPlant< / span > < span class = "p" > (< / span > < span class = "n" > UnixCommand< / span > < span class = "p" > ):< / span >
< span class = "w" > < / span > < span class = "sd" > ' ' ' < / span >
< span class = "sd" > Plant a tree or plant.< / span >
< span class = "sd" > This command is used to plant something in the room you are in.< / span >
< span class = "sd" > Examples:< / span >
< span class = "sd" > plant orange -a 8< / span >
< span class = "sd" > plant strawberry --hidden< / span >
< span class = "sd" > plant potato --hidden --age 5< / span >
< span class = "sd" > ' ' ' < / span >
< span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "s2" > " plant" < / span >
< span class = "k" > def< / span > < span class = "nf" > init_parser< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "s2" > " Add the arguments to the parser." < / span >
< span class = "c1" > # ' self.parser' inherits `argparse.ArgumentParser`< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > parser< / span > < span class = "o" > .< / span > < span class = "n" > add_argument< / span > < span class = "p" > (< / span > < span class = "s2" > " key" < / span > < span class = "p" > ,< / span >
< span class = "n" > help< / span > < span class = "o" > =< / span > < span class = "s2" > " the key of the plant to be planted here" < / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > parser< / span > < span class = "o" > .< / span > < span class = "n" > add_argument< / span > < span class = "p" > (< / span > < span class = "s2" > " -a" < / span > < span class = "p" > ,< / span > < span class = "s2" > " --age" < / span > < span class = "p" > ,< / span > < span class = "nb" > type< / span > < span class = "o" > =< / span > < span class = "nb" > int< / span > < span class = "p" > ,< / span >
< span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "n" > help< / span > < span class = "o" > =< / span > < span class = "s2" > " the age of the plant to be planted" < / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > parser< / span > < span class = "o" > .< / span > < span class = "n" > add_argument< / span > < span class = "p" > (< / span > < span class = "s2" > " --hidden" < / span > < span class = "p" > ,< / span > < span class = "n" > action< / span > < span class = "o" > =< / span > < span class = "s2" > " store_true" < / span > < span class = "p" > ,< / span >
< span class = "n" > help< / span > < span class = "o" > =< / span > < span class = "s2" > " should the newly-planted plant be hidden to players?" < / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > func< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "s2" > " func is called only if the parser succeeded." < / span >
< span class = "c1" > # ' self.opts' contains the parsed options< / span >
< span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > opts< / span > < span class = "o" > .< / span > < span class = "n" > key< / span >
< span class = "n" > age< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > opts< / span > < span class = "o" > .< / span > < span class = "n" > age< / span >
< span class = "n" > hidden< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > opts< / span > < span class = "o" > .< / span > < span class = "n" > hidden< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > msg< / span > < span class = "p" > (< / span > < span class = "s2" > " Going to plant ' < / span > < span class = "si" > {}< / span > < span class = "s2" > ' , age=< / span > < span class = "si" > {}< / span > < span class = "s2" > , hidden=< / span > < span class = "si" > {}< / span > < span class = "s2" > ." < / span > < span class = "o" > .< / span > < span class = "n" > format< / span > < span class = "p" > (< / span >
< span class = "n" > key< / span > < span class = "p" > ,< / span > < span class = "n" > age< / span > < span class = "p" > ,< / span > < span class = "n" > hidden< / span > < span class = "p" > ))< / span >
< / pre > < / div >
< / div >
< p > To see the full power of argparse and the types of supported options, visit
< a class = "reference external" href = "https://docs.python.org/2/library/argparse.html" > the documentation of argparse< / a > .< / p >
< hr class = "docutils" / >
< p > < small > This document page is generated from < code class = "docutils literal notranslate" > < span class = "pre" > evennia/contrib/base_systems/unixcommand/README.md< / span > < / code > . Changes to this
file will be overwritten, so edit that file rather than this one.< / small > < / p >
< / section >
< / section >
< / div >
< / div >
< / div >
< / div >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
>index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Evscaperoom.html" title = "EvscapeRoom"
>next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Mux-Comms-Cmds.html" title = "Legacy Comms-commands"
>previous< / a > |< / li >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia latest< / a > » < / li >
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Unix-like Command style< / a > < / li >
< / ul >
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2023, The Evennia developer community.
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >
