Unified javadoc format and related cleanups.

This commit is contained in:
MobiusDevelopment
2020-03-03 23:04:44 +00:00
parent 6d8addc784
commit 18b3e6d3f2
1830 changed files with 14879 additions and 14883 deletions

View File

@@ -223,17 +223,17 @@ public class CabaleBuffer extends AbstractNpcAI
}
/**
* For each known player in range, cast either the positive or negative buff. <BR>
* The stats affected depend on the player type, either a fighter or a mystic. <BR>
* <BR>
* Curse of Destruction (Loser)<BR>
* - Fighters: -25% Accuracy, -25% Effect Resistance<BR>
* - Mystics: -25% Casting Speed, -25% Effect Resistance<BR>
* <BR>
* <BR>
* For each known player in range, cast either the positive or negative buff.<br>
* The stats affected depend on the player type, either a fighter or a mystic.<br>
* <br>
* Curse of Destruction (Loser)<br>
* - Fighters: -25% Accuracy, -25% Effect Resistance<br>
* - Mystics: -25% Casting Speed, -25% Effect Resistance<br>
* <br>
* <br>
* Blessing of Prophecy (Winner)<br>
* - Fighters: +25% Max Load, +25% Effect Resistance<BR>
* - Mystics: +25% Magic Cancel Resist, +25% Effect Resistance<BR>
* - Fighters: +25% Max Load, +25% Effect Resistance<br>
* - Mystics: +25% Magic Cancel Resist, +25% Effect Resistance<br>
* @param player
* @param skillId
* @return

View File

@@ -26,18 +26,15 @@ import org.l2jmobius.gameserver.model.actor.instance.PlayerInstance;
public class ArtefactInstanceAction implements IActionHandler
{
/**
* Manage actions when a player click on the ArtefactInstance.<BR>
* <BR>
* <B><U> Actions</U> :</B><BR>
* <BR>
* Manage actions when a player click on the ArtefactInstance.<br>
* <br>
* <b><u>Actions</u>:</b><br>
* <li>Set the NpcInstance as target of the PlayerInstance player (if necessary)</li>
* <li>Send a Server->Client packet MyTargetSelected to the PlayerInstance player (display the select window)</li>
* <li>Send a Server->Client packet ValidateLocation to correct the NpcInstance position and heading on the client</li><BR>
* <BR>
* <B><U> Example of use </U> :</B><BR>
* <BR>
* <li>Client packet : Action, AttackRequest</li><BR>
* <BR>
* <li>Send a Server->Client packet ValidateLocation to correct the NpcInstance position and heading on the client</li><br>
* <br>
* <b><u>Example of use</u>:</b><br>
* <li>Client packet : Action, AttackRequest</li>
*/
@Override
public boolean action(PlayerInstance player, WorldObject target, boolean interact)

View File

@@ -36,27 +36,22 @@ import org.l2jmobius.gameserver.network.serverpackets.MoveToPawn;
public class NpcAction implements IActionHandler
{
/**
* Manage actions when a player click on the Npc.<BR>
* <BR>
* <B><U> Actions on first click on the Npc (Select it)</U> :</B><BR>
* <BR>
* Manage actions when a player click on the Npc.<br>
* <br>
* <b><u>Actions on first click on the Npc (Select it)</u>:</b><br>
* <li>Set the Npc as target of the PlayerInstance player (if necessary)</li>
* <li>Send a Server->Client packet MyTargetSelected to the PlayerInstance player (display the select window)</li>
* <li>If Npc is autoAttackable, send a Server->Client packet StatusUpdate to the PlayerInstance in order to update Npc HP bar</li>
* <li>Send a Server->Client packet ValidateLocation to correct the Npc position and heading on the client</li><BR>
* <BR>
* <B><U> Actions on second click on the Npc (Attack it/Intercat with it)</U> :</B><BR>
* <BR>
* <li>Send a Server->Client packet ValidateLocation to correct the Npc position and heading on the client</li><br>
* <br>
* <b><u>Actions on second click on the Npc (Attack it/Intercat with it)</u>:</b><br>
* <li>Send a Server->Client packet MyTargetSelected to the PlayerInstance player (display the select window)</li>
* <li>If Npc is autoAttackable, notify the PlayerInstance AI with AI_INTENTION_ATTACK (after a height verification)</li>
* <li>If Npc is NOT autoAttackable, notify the PlayerInstance AI with AI_INTENTION_INTERACT (after a distance verification) and show message</li><BR>
* <BR>
* <FONT COLOR=#FF0000><B> <U>Caution</U> : Each group of Server->Client packet must be terminated by a ActionFailed packet in order to avoid that client wait an other packet</B></FONT><BR>
* <BR>
* <B><U> Example of use </U> :</B><BR>
* <BR>
* <li>Client packet : Action, AttackRequest</li><BR>
* <BR>
* <li>If Npc is NOT autoAttackable, notify the PlayerInstance AI with AI_INTENTION_INTERACT (after a distance verification) and show message</li><br>
* <font color=#FF0000><b><u>Caution</u>: Each group of Server->Client packet must be terminated by a ActionFailed packet in order to avoid that client wait an other packet</b></font><br>
* <br>
* <b><u>Example of use</u>:</b><br>
* <li>Client packet : Action, AttackRequest</li><br>
* @param player The PlayerInstance that start an action on the Npc
*/
@Override

View File

@@ -32,25 +32,20 @@ public class PlayerInstanceAction implements IActionHandler
private static final int CURSED_WEAPON_VICTIM_MIN_LEVEL = 21;
/**
* Manage actions when a player click on this PlayerInstance.<BR>
* <BR>
* <B><U> Actions on first click on the PlayerInstance (Select it)</U> :</B><BR>
* <BR>
* Manage actions when a player click on this PlayerInstance.<br>
* <br>
* <b><u>Actions on first click on the PlayerInstance (Select it)</u>:</b><br>
* <li>Set the target of the player</li>
* <li>Send a Server->Client packet MyTargetSelected to the player (display the select window)</li><BR>
* <BR>
* <B><U> Actions on second click on the PlayerInstance (Follow it/Attack it/Intercat with it)</U> :</B><BR>
* <BR>
* <li>Send a Server->Client packet MyTargetSelected to the player (display the select window)</li><br>
* <br>
* <b><u>Actions on second click on the PlayerInstance (Follow it/Attack it/Intercat with it)</u>:</b><br>
* <li>Send a Server->Client packet MyTargetSelected to the player (display the select window)</li>
* <li>If target PlayerInstance has a Private Store, notify the player AI with AI_INTENTION_INTERACT</li>
* <li>If target PlayerInstance is autoAttackable, notify the player AI with AI_INTENTION_ATTACK</li> <BR>
* <BR>
* <li>If target PlayerInstance is NOT autoAttackable, notify the player AI with AI_INTENTION_FOLLOW</li><BR>
* <BR>
* <B><U> Example of use </U> :</B><BR>
* <BR>
* <li>Client packet : Action, AttackRequest</li><BR>
* <BR>
* <li>If target PlayerInstance is autoAttackable, notify the player AI with AI_INTENTION_ATTACK</li>
* <li>If target PlayerInstance is NOT autoAttackable, notify the player AI with AI_INTENTION_FOLLOW</li><br>
* <br>
* <b><u>Example of use</u>:</b><br>
* <li>Client packet : Action, AttackRequest</li><br>
* @param player The player that start an action on target PlayerInstance
*/
@Override

View File

@@ -38,21 +38,17 @@ import handlers.bypasshandlers.NpcViewMod;
public class NpcActionShift implements IActionShiftHandler
{
/**
* Manage and Display the GM console to modify the NpcInstance (GM only).<BR>
* <BR>
* <B><U> Actions (If the PlayerInstance is a GM only)</U> :</B><BR>
* <BR>
* Manage and Display the GM console to modify the NpcInstance (GM only).<br>
* <br>
* <b><u>Actions (If the PlayerInstance is a GM only)</u>:</b><br>
* <li>Set the NpcInstance as target of the PlayerInstance player (if necessary)</li>
* <li>Send a Server->Client packet MyTargetSelected to the PlayerInstance player (display the select window)</li>
* <li>If NpcInstance is autoAttackable, send a Server->Client packet StatusUpdate to the PlayerInstance in order to update NpcInstance HP bar</li>
* <li>Send a Server->Client NpcHtmlMessage() containing the GM console about this NpcInstance</li><BR>
* <BR>
* <FONT COLOR=#FF0000><B> <U>Caution</U> : Each group of Server->Client packet must be terminated by a ActionFailed packet in order to avoid that client wait an other packet</B></FONT><BR>
* <BR>
* <B><U> Example of use </U> :</B><BR>
* <BR>
* <li>Client packet : Action</li><BR>
* <BR>
* <li>Send a Server->Client NpcHtmlMessage() containing the GM console about this NpcInstance</li><br>
* <font color=#FF0000><b><u>Caution</u>: Each group of Server->Client packet must be terminated by a ActionFailed packet in order to avoid that client wait an other packet</b></font><br>
* <br>
* <b><u>Example of use</u>:</b><br>
* <li>Client packet : Action</li>
*/
@Override
public boolean action(PlayerInstance player, WorldObject target, boolean interact)

View File

@@ -29,7 +29,7 @@ public class PlayerInstanceActionShift implements IActionShiftHandler
{
if (player.isGM())
{
// Check if the gm already target this l2pcinstance
// Check if the GM already target this l2pcinstance
if (player.getTarget() != target)
{
// Set the target of the PlayerInstance player

View File

@@ -78,13 +78,13 @@ public class AdminAdmin implements IAdminCommandHandler
else if (command.startsWith("admin_gmliston"))
{
AdminData.getInstance().showGm(activeChar);
BuilderUtil.sendSysMessage(activeChar, "Registered into gm list");
BuilderUtil.sendSysMessage(activeChar, "Registered into GM list");
AdminHtml.showAdminHtml(activeChar, "gm_menu.htm");
}
else if (command.startsWith("admin_gmlistoff"))
{
AdminData.getInstance().hideGm(activeChar);
BuilderUtil.sendSysMessage(activeChar, "Removed from gm list");
BuilderUtil.sendSysMessage(activeChar, "Removed from GM list");
AdminHtml.showAdminHtml(activeChar, "gm_menu.htm");
}
else if (command.startsWith("admin_silence"))

View File

@@ -494,7 +494,7 @@ public class AdminEventEngine implements IAdminCommandHandler
sb.append("<td><edit var=\"event_npcid\" width=100 height=20></td></tr>");
sb.append("<tr><td><button value=\"Set number of teams\" action=\"bypass -h admin_event_change_teams_number $event_teams_number\" width=140 height=32 back=\"L2UI_ct1.button_df\" fore=\"L2UI_ct1.button_df\"></td>");
sb.append("<td><edit var=\"event_teams_number\" width=100 height=20></td></tr>");
sb.append("</table><br><center> <br><br>");
sb.append("</table><br><center><br><br>");
sb.append("<font color=\"LEVEL\">Teams' names:</font><br><table width=100% cellspacing=8>");
for (int i = 1; (i - 1) < teamnumbers; i++) // Team names params
{

View File

@@ -30,7 +30,7 @@ import org.l2jmobius.gameserver.network.SystemMessageId;
import org.l2jmobius.gameserver.network.serverpackets.NpcHtmlMessage;
/**
* This class handles following admin commands: - gm = turns gm mode on/off
* This class handles following admin commands: - GM = turns GM mode on/off
* @version $Revision: 1.1.2.1 $ $Date: 2005/03/15 21:32:48 $
*/
public class AdminFightCalculator implements IAdminCommandHandler

View File

@@ -24,7 +24,7 @@ import org.l2jmobius.gameserver.model.actor.instance.PlayerInstance;
import org.l2jmobius.gameserver.util.BuilderUtil;
/**
* This class handles following admin commands: - gm = turns gm mode off
* This class handles following admin commands: - GM = turns GM mode off
* @version $Revision: 1.2.4.4 $ $Date: 2005/04/11 10:06:06 $
*/
public class AdminGm implements IAdminCommandHandler

View File

@@ -34,7 +34,7 @@ import org.l2jmobius.gameserver.network.serverpackets.NpcHtmlMessage;
import org.l2jmobius.gameserver.util.BuilderUtil;
/**
* This class handles commands for gm to forge packets
* This class handles commands for GM to forge packets
* @author Maktakien, HorridoJoho
*/
public class AdminPForge implements IAdminCommandHandler

View File

@@ -30,14 +30,14 @@ import org.l2jmobius.gameserver.network.serverpackets.SystemMessage;
import org.l2jmobius.gameserver.util.BuilderUtil;
/**
* <B>Pledge Manipulation:</B><BR>
* <LI>With target in a character without clan:<BR>
* <b>Pledge Manipulation:</b><br>
* <li>With target in a character without clan:<br>
* //pledge create clanname
* <LI>With target in a clan leader:<BR>
* //pledge info<BR>
* //pledge dismiss<BR>
* //pledge setlevel level<BR>
* //pledge rep reputation_points<BR>
* <li>With target in a clan leader:<br>
* //pledge info<br>
* //pledge dismiss<br>
* //pledge setlevel level<br>
* //pledge rep reputation_points
*/
public class AdminPledge implements IAdminCommandHandler
{

View File

@@ -71,13 +71,12 @@ public class Loto implements IBypassHandler
}
/**
* Open a Loto window on client with the text of the NpcInstance.<BR>
* <BR>
* <B><U> Actions</U> :</B><BR>
* <BR>
* Open a Loto window on client with the text of the NpcInstance.<br>
* <br>
* <b><u>Actions</u>:</b><br>
* <li>Get the text of the selected HTML file in function of the npcId and of the page number</li>
* <li>Send a Server->Client NpcHtmlMessage containing the text of the NpcInstance to the PlayerInstance</li>
* <li>Send a Server->Client ActionFailed to the PlayerInstance in order to avoid that the client wait another packet</li><BR>
* <li>Send a Server->Client ActionFailed to the PlayerInstance in order to avoid that the client wait another packet</li><br>
* @param player The PlayerInstance that talk with the NpcInstance
* @param npc Npc loto instance
* @param value The number of the page of the NpcInstance to display

View File

@@ -84,8 +84,9 @@ public class QuestLink implements IBypassHandler
/**
* Open a choose quest window on client with all quests available of the NpcInstance.<br>
* <br>
* <b><u>Actions</u>:</b><br>
* <li>Send a Server->Client NpcHtmlMessage containing the text of the NpcInstance to the PlayerInstance</li>
* <li>Send a Server->Client NpcHtmlMessage containing the text of the NpcInstance to the PlayerInstance</li><br>
* @param player The PlayerInstance that talk with the NpcInstance
* @param npc The table containing quests of the NpcInstance
* @param quests
@@ -202,6 +203,7 @@ public class QuestLink implements IBypassHandler
/**
* Open a quest window on client with the text of the NpcInstance.<br>
* <br>
* <b><u>Actions</u>:</b><br>
* <ul>
* <li>Get the text of the quest state in the folder data/scripts/quests/questId/stateId.htm</li>

View File

@@ -38,7 +38,7 @@ import org.l2jmobius.gameserver.util.Util;
* <li>Fly Radius means the distance between starting point and final point, it must be an integer.</li>
* <li>Fly Course means the movement direction: imagine a compass above player's head, making north player's heading. So if fly course is 180, player will go backwards (good for blink, e.g.).</li>
* </ul>
* By the way, if flyCourse = 360 or 0, player will be moved in in front of him. <br>
* By the way, if flyCourse = 360 or 0, player will be moved in in front of him.<br>
* If target is effector, put in XML self="1", this will make _actor = getEffector(). This, combined with target type, allows more complex actions like flying target's backwards or player's backwards.
* @author DrHouse
*/

View File

@@ -98,7 +98,7 @@ public class Fishing extends AbstractEffect
return;
}
// check for equiped fishing rod
// check for equipped fishing rod
final Weapon equipedWeapon = player.getActiveWeaponItem();
if (((equipedWeapon == null) || (equipedWeapon.getItemType() != WeaponType.FISHINGROD)))
{
@@ -106,7 +106,7 @@ public class Fishing extends AbstractEffect
return;
}
// check for equiped lure
// check for equipped lure
final ItemInstance equipedLeftHand = player.getInventory().getPaperdollItem(Inventory.PAPERDOLL_LHAND);
if ((equipedLeftHand == null) || (equipedLeftHand.getItemType() != EtcItemType.LURE))
{

View File

@@ -691,7 +691,7 @@ public class CrystalCaverns extends AbstractInstance
{
if (player.getParty() == null)
{
// This can happen only if gm enters solo.
// This can happen only if GM enters solo.
player.sendMessage("Welcome to Crystal Caverns.");
teleportPlayer(player, START_LOC, world.getInstanceId());
world.addAllowed(player);