Misleading documentation for drop zone events

Abierto
#7,146 0 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
javascript

Línea de trabajo

Comienza por la sección de zonas de soltar de la documentación enlazada de Phaser sobre la entrada y revisa los ejemplos que usan gameObject.setInteractive y el drop event. Cambia el nombre de la variable del ejemplo o distingue de otra forma la zona de soltar del objeto arrastrado, e indica qué objeto recibe los eventos de la zona de soltar; la documentación debe eliminar la ambigüedad descrita en el issue.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Version

  • Phaser Version: 3.88.2

Description

The documentation explains drop zone concept and provides examples like so:

gameObject.setInteractive({ dropZone: true });

So we instinctively think that gameObject is a drop zone. In next paragraphs the following code can be found:

gameObject.on(
  "drop",
  function (pointer, target) {
    /* ... */
  },
  scope
);

Which suggests that drop event is triggered on the zone itself. However after 1hr of experimentation I found out that it is not exactly right. The drop event is not triggered on the zone, but rather on the object that is being dragged. It would be great to rename the gameObject to something more meaningful in the documentation and provide an explicit comment on which game object the drop and other dropZone events are triggered. That way some time on debugging and experimenting can be saved for the developers. I'd propose a change in documentation via a PR but could not find the repo containing the docs.

Link: https://docs.phaser.io/phaser/concepts/input#drop-zone:~:text=gameObject.on(%0A%20%20%22drop%22%2C%0A%20%20function%20(pointer%2C%20target)%20%7B%0A%20%20%20%20/*%20...%20*/%0A%20%20%7D%2C%0A%20%20scope%0A)%3B

Lenguaje dominante
JavaScript
Estrellas
40.7k
Forks
7.2k
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de phaserjs/phaser

Todos los issues de phaserjs/phaser

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.