PSF-LoginServer/net/psforever/objects/serverobject/mount/Mountable$.html

7 lines
45 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.serverobject.mount.Mountable</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.mount.Mountable" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.mount.Mountable" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../../lib/index.js"></script><script type="text/javascript" src="../../../../../index.js"></script><script type="text/javascript" src="../../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject"></a><a id="serverobject:serverobject"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a
The player was previously seated at the given index.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>Mountable</code> object</p></dd><dt class="param">seat_num</dt><dd class="cmt"><p>the seat index</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable.CanMount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CanMountextendsMountable.ExchangewithProductwithSerializable"></a><a id="CanMount:CanMount"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/Mountable$$CanMount.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Mountable$$CanMount.html" title="Message sent in response to the player succeeding to access a Mountable object."><span class="name">CanMount</span></a><span class="params">(<span name="obj">obj: <a href="Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></span>, <span name="seat_number">seat_number: <span name="scala.Int" class="extype">Int</span></span>, <span name="mount_point">mount_point: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="Mountable$$Exchange.html" name="net.psforever.objects.serverobject.mount.Mountable.Exchange" id="net.psforever.objects.serverobject.mount.Mountable.Exchange" class="extype">Exchange</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message sent in response to the player succeeding to access a <code>Mountable</code> object.</p><div class="fullcomment"><div class="comment cmt"><p>Message sent in response to the player succeeding to access a <code>Mountable</code> object.
The player should be seated at the given index.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>Mountable</code> object</p></dd><dt class="param">mount_point</dt><dd class="cmt"><p>the mount index</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable.CanNotDismount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CanNotDismountextendsMountable.ExchangewithProductwithSerializable"></a><a id="CanNotDismount:CanNotDismount"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/Mountable$$CanNotDismount.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Mountable$$CanNotDismount.html" title="Message sent in response to the player failing to disembark a Mountable object."><span class="name">CanNotDismount</span></a><span class="params">(<span name="obj">obj: <a href="Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></span>, <span name="seat_num">seat_num: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="Mountable$$Exchange.html" name="net.psforever.objects.serverobject.mount.Mountable.Exchange" id="net.psforever.objects.serverobject.mount.Mountable.Exchange" class="extype">Exchange</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message sent in response to the player failing to disembark a <code>Mountable</code> object.</p><div class="fullcomment"><div class="comment cmt"><p>Message sent in response to the player failing to disembark a <code>Mountable</code> object.
The player is still seated at the given index.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>Mountable</code> object</p></dd><dt class="param">seat_num</dt><dd class="cmt"><p>the seat index</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable.CanNotMount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CanNotMountextendsMountable.ExchangewithProductwithSerializable"></a><a id="CanNotMount:CanNotMount"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/Mountable$$CanNotMount.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Mountable$$CanNotMount.html" title="Message sent in response to the player failing to access a Mountable object."><span class="name">CanNotMount</span></a><span class="params">(<span name="obj">obj: <a href="Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></span>, <span name="mount_point">mount_point: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="Mountable$$Exchange.html" name="net.psforever.objects.serverobject.mount.Mountable.Exchange" id="net.psforever.objects.serverobject.mount.Mountable.Exchange" class="extype">Exchange</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message sent in response to the player failing to access a <code>Mountable</code> object.</p><div class="fullcomment"><div class="comment cmt"><p>Message sent in response to the player failing to access a <code>Mountable</code> object.
The player would have been be seated at the given index.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>Mountable</code> object</p></dd><dt class="param">mount_point</dt><dd class="cmt"><p>the mount index</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable.Exchange" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="ExchangeextendsAnyRef"></a><a id="Exchange:Exchange"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/Mountable$$Exchange.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="Mountable$$Exchange.html" title="A basic Trait connecting all of the actionable Mountable response messages."><span class="name">Exchange</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">A basic <code>Trait</code> connecting all of the actionable <code>Mountable</code> response messages.</p></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable.MountMessages" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MountMessagesextendsProductwithSerializable"></a><a id="MountMessages:MountMessages"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/Mountable$$MountMessages.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Mountable$$MountMessages.html" title="Message that carries the result of the processed request message back to the original user (player)."><span class="name">MountMessages</span></a><span class="params">(<span name="player">player: <a href="../../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="response">response: <a href="Mountable$$Exchange.html" name="net.psforever.objects.serverobject.mount.Mountable.Exchange" id="net.psforever.objects.serverobject.mount.Mountable.Exchange" class="extype">Exchange</a></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message that carries the result of the processed request message back to the original user (<code>player</code>).</p><div class="fullcomment"><div class="comment cmt"><p>Message that carries the result of the processed request message back to the original user (<code>player</code>).</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player who sent this request message</p></dd><dt class="param">response</dt><dd class="cmt"><p>the result of the processed request</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable.TryDismount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryDismountextendsProductwithSerializable"></a><a id="TryDismount:TryDismount"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/Mountable$$TryDismount.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Mountable$$TryDismount.html" title="Message used by the player to indicate the desire to escape a Mountable object."><span class="name">TryDismount</span></a><span class="params">(<span name="player">player: <a href="../../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="seat_num">seat_num: <span name="scala.Int" class="extype">Int</spa