fix Java doc comments

removed unused param
This commit is contained in:
Aaron Kimbre 2022-05-04 19:26:56 -05:00
parent ad5c679d2d
commit b11b516641
2 changed files with 9 additions and 6 deletions

View File

@ -37,7 +37,7 @@ void RocketLaunchLupComponent::OnUse(Entity* originator) {
rocket->Equip(true); rocket->Equip(true);
} }
void RocketLaunchLupComponent::OnSelectWorld(Entity* originator, uint32_t index, const SystemAddress& sysAddr) { void RocketLaunchLupComponent::OnSelectWorld(Entity* originator, uint32_t index) {
// Add one to index because the actual LUP worlds start at index 1. // Add one to index because the actual LUP worlds start at index 1.
index++; index++;

View File

@ -12,25 +12,28 @@ class RocketLaunchLupComponent : public Component {
public: public:
static const uint32_t ComponentType = eReplicaComponentType::COMPONENT_TYPE_ROCKET_LAUNCH_LUP; static const uint32_t ComponentType = eReplicaComponentType::COMPONENT_TYPE_ROCKET_LAUNCH_LUP;
/**
* Constructor for this component, builds the m_LUPWorlds vector
* @param parent parent that contains this component
*/
RocketLaunchLupComponent(Entity* parent); RocketLaunchLupComponent(Entity* parent);
~RocketLaunchLupComponent() override; ~RocketLaunchLupComponent() override;
/** /**
* Handles an OnUse event from some entity, preparing it for launch to some other world * Handles an OnUse event from some entity, preparing it for launch to some other world
* Builds m_LUPWorlds
* @param originator the entity that triggered the event * @param originator the entity that triggered the event
*/ */
void OnUse(Entity* originator) override; void OnUse(Entity* originator) override;
/** /**
* Handles an OnUse event from some entity, preparing it for launch to some other world * Handles an OnUse event from some entity, preparing it for launch to some other world
*
* @param originator the entity that triggered the event * @param originator the entity that triggered the event
* @param index index of the world that was selected * @param index index of the world that was selected
* @param sysAddr the address to send gamemessage responses to
*/ */
void OnSelectWorld(Entity* originator, uint32_t index, const SystemAddress& sysAddr); void OnSelectWorld(Entity* originator, uint32_t index);
private: private:
// vector of the LUP World Zone IDs, built from CDServer's LUPZoneIDs table /**
* vector of the LUP World Zone IDs, built from CDServer's LUPZoneIDs table
*/
std::vector<LWOMAPID> m_LUPWorlds {}; std::vector<LWOMAPID> m_LUPWorlds {};
}; };