Refactorizar para eliminar erratas y dar consistencia a la nomenclatura

[Kencho]

Aplicar las refactorizaciones sugeridas:

• Platformer.Animation.SpriteAnimator
  • [x] Renombrar atributo rendererOfSprites a spriteRenderer.
  • [x] (Opcional) Mueve la inicialización de spriteIndex a su declaración y aumenta su visibilidad a public para que, aunque por defecto siga siendo 12, se pueda editar desde el inspector y no sea algo "incrustado" en el código de la clase. No olvides renombrarlo a SpriteIndex para que sea consistente con el estilo de código.
• Platformer.Animation.OneTimeAnimation
  • [x] (Opcional) Renombrar la clase a OneShotAnimation. Es el término que se suele usar para estos casos.
  • [x] Renombrar atributo animationReproducton (falta una "i") a animationPlaying o playing a secas.
• Platformer.Core.GameController
  • [x] (Opcional) Renombrar método SetPlatformerVariables a SetModelAttributes.
  • [x] Renombrar método InstanceStatingObjects a InstanceStartingObjects.
• Platformer.Core.StartingObject
• DisablePlayerInput
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.EnablePlayerInput
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerDeath
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerEnteredDeathZone
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerEnteredVictoryZone
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerJumped
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerLanded
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerObstacleCollision
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerSpawn
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerStopJump
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
• Platformer.Gameplay.PlayerTokenCollision
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.PlayerEvents
  • [x] Cambiar el nombre del typeparam en la documentación de la clase.
• Platformer.Gameplay.SceneManagement
  • [x] (Opcional) Renombrar el namespace (y directorio) a Platformer.Gameplay.SceneEvents por consistencia con PlayerEvents.
• Platformer.Gameplay.LoadGameMenu
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.Gameplay.SceneManagement
• Platformer.Gameplay.HealthIsZero
  • [x] Moverlo al namespace (y directorio) correspondiente (¿PlayerEvents?), al ser un evento.
• Platformer.Gameplay.KinematicObjectWallCollision
  • [x] Moverlo al namespace (y directorio) correspondiente (¿PlayerEvents?), al ser un evento.
  • [x] Renombrar método UpdateVelocityKinObj a UpdateKinematicObjectVelocity.
• Platformer.Gameplay.SetGameInitialState
  • [x] Moverlo al namespace (y directorio) correspondiente (¿GameEvents?), al ser un evento.
• Platformer.GizmosUI
  • [x] Renombrar el directorio a GizmosUI o el namespace a Gizmos. Se recomienda la primera para minimizar los cambios en el código.
• WallGizmo
  • [x] Está fuera del namespace que se corresponde en el directorio. Mover al namespace Platformer.GizmosUI
• Platformer.Enemies.ObstacleDestroyer, Platformer.Enemies.ObstacleFactory y Platformer.Enemies.TriggerObstacleFactory
  • [x] Cambiar al namespace Platformer.Mechanics.Enemies.ObstacleResources.
  • [x] Renombrar el directorio a ObstacleResources.
• Platformer.Enemies.Obstacle y Platformer.Enemies.MovingObstacle
  • [x] Cambiar al namespace Platformer.Mechanics.Enemies.
• Platformer.Enemies.PatrolObstacle
  • [x] Cambiar al namespace Platformer.Mechanics.Enemies.
  • [x] Renombrar el atributo pathTimeTravel a travelDuration o travelTime.
• Platformer.Mechanics.DenseObstacle
  • [x] Cambiar al namespace Platformer.Mechanics.GravityModifiers.
  • [x] Renombrar el método calculateKineObjDirection a CalculateKinematicObjectDirection. Ten en cuenta la convención de capitalización recomendada por MS. Es algo diferente en Unity, pero en general se adhiere a ella.
• Platformer.Mechanics.GravityInverter
  • [x] Cambiar al namespace Platformer.Mechanics.GravityModifiers.
• Platformer.Mechanics.GravityInverterManager
  • [x] Cambiar al namespace Platformer.Mechanics.GravityModifiers.
  • [x] Renombrar atributo AfectedKineObjs a affectedKineObjs (he visto que estabas usando PascalCase para los atributos y propiedades públicas y camelCase para las privadas). Ojo a las "ff" en "affected".
  • [x] Renombrar método ApplyGravityInversionToAfectedKineObjs a ApplyGravityInversionToAffectedKinematicObjects o simplemente ApplyGravityInversion.
  • [x] Renombrar método InverGravityOfKinematicObject a InvertGravityOfKinematicObject.
  • [x] Renombrar método ResetAfectedKineObjs a ResetAffectedKinematicObjects.
• Platformer.Mechanics.Impulse*
  • [x] Cambiar al namespace Platformer.Mechanics.ImpulseCreators.
• Platformer.Mechanics.KinematicObject
  • [x] Cambiar al namespace Platformer.Mechanics.KinematicObject.
• Platformer.Mechanics.KinematicObjectCollisionManager
  • [x] Cambiar al namespace Platformer.Mechanics.KinematicObject.
  • [x] Renombrar el método manageCollision a HandleCollision.
  • [x] Renombrar el método manageWallCollision a HandleWallCollision.
  • [x] Renombrar el método manageImpulseCreatorCollision a HandleImpulseCreatorCollision.
• Platformer.Mechanics.KinematicObjectGravityManager
  • [x] Cambiar al namespace Platformer.Mechanics.KinematicObject.
  • [x] Renombrar la variable local gravityModifier a aggregatedGravityModifier.
  • [x] Renombrar el atributo gravityAltertions a gravityModifiers. Si no se hace ese renombrado, al menos corregir el error tipográfico altertions por alterations.
  • [x] Renombrar la variable local gravityAltertion a gravityModifier. Si no se hace ese renombrado, al menos corregir el error tipográfico altertion por alteration.
  • [x] Renombrar el método ManageGravity a HandleGravity.
  • [x] Renombrar el método addGravityAlteration a AddGravityAlteration.
• Platformer.Mechanics.PatrolPath
  • [x] Cambiar al namespace Platformer.Mechanics.PatrolPath.
  • [x] Renombrar el método getNextPathPosition a GetNextPathPosition.
  • [x] Renombrar el método isSectiontraveled a IsSectionTraveled.
• Platformer.Mechanics.TimeAfectedPatrolPath
  • [x] Cambiar al namespace Platformer.Mechanics.PatrolPath.
  • [x] Renombrar la clase a TimeAffectedPatrolPath.
• Platformer.Player.PlayerMechanic
  • [x] Cambiar al namespace Platformer.Mechanics.Player.PlayerMechanic.
• Platformer.Player.BulletTime
  • [x] Cambiar al namespace Platformer.Mechanics.Player.PlayerMechanic.
  • [x] Renombrar el atributo bulletTimeColdonw a bulletTimeCooldown.
  • [x] Renombrar el atributo timeWithOutBulletTime a timeWithoutBulletTime.
  • [x] Renombrar el atributo bulletTimeAbble a bulletTimeAvailable.
  • [x] Renombrar el atributo applingBulletTime a bulletTimeEnabled, bulletTimeActive o en última instancia, applyingBulletTime.
  • [x] Renombrar la propiedad ApplingbulletTime siguiendo la misma política que el atributo applingBulletTime.
  • [x] Renombrar el parámetro del constructor bulletTimeColdonw a bulletTimeCooldown.
• Platformer.Player.Dash
  • [x] Cambiar al namespace Platformer.Mechanics.Player.PlayerMechanic.
  • [x] Renombrar el atributo dashColdown a dashCooldown.
  • [x] Renombrar el atributo dashable a dashAvailable.
  • [x] Renombrar el atributo timeWithOutFlash a timeWithoutDash.
  • [x] Renombrar el parámetro del constructor dashColdown a dashCooldown.
  • [x] Cambiar el operador binario de la línea 59 de & (combinación binaria AND) a && (comparación booleana AND).
• Platformer.Player.Jump
  • [x] Cambiar al namespace Platformer.Mechanics.Player.PlayerMechanic.
  • [x] Renombrar el atributo jumpable a jumpAvailable.
• Platformer.Player.Player*State
  • [x] Cambiar al namespace Platformer.Mechanics.Player.PlayerStates.
• Platformer.Player.PlayerDashingState
  • [x] Renombrar el método calculateDashSpeed a CalculateDashSpeed.
• Platformer.Player.PlayerOnAirState
  • [x] Renombrar el método MoveInAir a AerialMovement.
• Platformer.Player.PlayerStopingState
  • [x] Renombrar la clase PlayerStopingState a PlayerStoppingState.
• Platformer.Player.PlayerController
  • [x] Cambiar al namespace Platformer.Mechanics.Player.
  • [x] Renombrar la propiedad ApplingBulletTime según la misma política que Platformer.Player.BulletTime.ApplingBulletTime.
  • [x] Renombrar el método manageInputs a ManageInputs.
  • [x] Renombrar el método manageFlags a ManageFlags.
  • [x] Renombrar el método AnimarMovimientoPlayer a AnimateMovement.

• Platformer.Resources.MathOperations

  • [x] Reemplazar las llamadas a esta clase (clase monoestado cuyo único método es el cálculo de la magnitud de un vector 2D) por

  (vector2 - vector1).magnitude

  magnitude hace esa misma operación, pero más rápido.

  • [x] Eliminar esta clase una vez hecho este cambio al no ser necesaria.
• Platformer.Physics.PhisicsController
  • [x] Cambiar al namespace Platformer.Mechanics.Resources.
  • [x] Renombrar la clase a PhysicsController.
  • [x] Renombrar el método SimulateGarvity a SimulateGravity.
• Platformer.Resources.PlayerTrigger
  • [x] Cambiar al namespace Platformer.Mechanics.Resources.
  • [x] Renombrar el atributo isTrigger a isTriggered.
  • [x] Renombrar la propiedad IsTrigger a IsTriggered.
• Platformer.Mechanics.Time*
  • [x] Cambiar al namespace Platformer.Mechanics.TimeModifiers.
• Platformer.Mechanics.TimeAfectedObject
  • [x] Renombrar la clase a TimeAffectedObject.
• Platformer.Mechanics.TimeAffectedZone
  • [x] Renombrar el atributo timeScaleAplied a timeScaleApplied.
  • [x] Renombrar las variables locales timeAfectedObj a timeAffectedObj.
• Platformer.Mechanics.TimeManager
  • [x] Renombrar el atributo timeAfectedObjects a timeAffectedObjects.
  • [x] Renombrar los parámetros timeAfectedObject de ScaleTime, UnScaleTime y ResetTimeScale a timeAffectedObject.
  • [x] Renombrar ResetTimeAfectedObjects a ResetAffectedObjects (si los afectados son todos cinéticos, sigue la misma nomenclatura que en GravityInverterManager y llámalo ResetAffectedKinematicObjects).
• Platformer.Mechanics.Portal
  • [x] Renombrar el atributo portalAbbled a portalEnabled.
• Platformer.UI.OptionsCanvasManager
  • [x] Renombrar el atributo panelActived a panelActivated.
  • [x] Renombrar el método InitialiceOptionsPanel a InitializeOptionsPanel.
  • [x] Renombrar el método ActivePanel a ActivatePanel.
  • [x] Renombrar el método DisactivePanel a DeactivatePanel.

---

• [x] Eliminar los using no utilizados en todos los ficheros donde proceda (son la mayoría).
• [x] Repasar la consistencia en la capitalización y nomenclatura del código, y renombrar cuando sea necesario.

[mri1001]

La refactorización opcional no se ha llevado a cabo tal y como se ha pedido ya que el error no era el especificado, sino que debido a copiar código se han mantenido fragmentos de código de otra clase. El spriteIndex debería tener en el Start el valor del índice del último elemento del vector (pues en cada llamada del Update se llama primero al siguiente elemento, en este caso se pasa al sprite inicial, y luego opera). En cuanto a renombrar spriteIndex por SpriteIndex, no lo he hecho porque SpriteIndex es el equivalente a los getter y setter de C# pero como no hace falta a las demás clases (salvo OneTimeAnimator) acceder a esa variable se ha prescindido de añadir getter y setter.

[mri1001]

PlayerLanded eliminado en vez de refactorizado ya que no es usada en ningún momento ni se planea que sea usada, así que es código muerto.

[mri1001]

PlayerStopJump se ha eliminado en vez de refactorizarse porque no es usada ni se planea usarla, así que es código muerto.

[mri1001]

PlayerTokenCollision no se puede refactorizar porque fue eliminada en el pasado debido a que es código muerto.

[mri1001]

KinematicObjectWallColision se ha eliminado en vez de refactorizarse porque no es usada ni se planea usarla, así que es código muerto.

[mri1001]

no se ha usado el namespace Platformer.Mechanics.KinematicObject sino Platformer.Mechanics.KinematicObjects debido a que un namespace y una clase no pueden tener el mismo nombre.

[mri1001]

No se ha usado el namespace Platformer.Mechanics.Player.PlayerMechanic sino Platformer.Mechanics.Player.PlayerMechanics debido a que un namespace y una clase no pueden tener el mismo nombre.

[mri1001]

El ultimo commit corresponde a la issue #70 y no a esta issue.

[Kencho]

@mri1001 :

• En Mechanics.Player.PlayerMechanics.BulletTime aún hay algunos "cooldown" escritos como Cooldonw.
• Algunos namespaces están renombrados pero los directorios permanecen con el nombre anterior. Lo ideal sería una correspondencia 1:1.