The wiki has been upgraded to MediaWiki 1.43. The wiki's theme is still being adapted to work with the new version, and may appear broken for the time being. --RanAS

es/Hitman Tool files and formats

From SnesLab
Jump to: navigation, search
English Português Español 日本語

Hitman Tool lee archivos que definen propiedades, cambian sus valores para sprites específicos o describen las cajas de colisión de un recurso.

Tipos de archivos

Tipo Para qué sirve Dónde se coloca
Definición de propiedad (JSON) Crea una propiedad y fija sus valores iniciales. CustomProperties/
Configuración por sprite (JSON) Cambia propiedades para un tipo de sprite normal y permite asignarle callbacks de interacciones vanilla. Junto al recurso, mediante ;#inchmprop, o en CustomProperties/PerSprite/.
Archivo .hitboxinfo Define cajas de colisión y las asigna a poses. Junto al recurso, mediante ;#inchbi, o en HitboxInfo/.

Las carpetas CustomProperties/ y HitboxInfo/ están dentro de la carpeta de Hitman Tool.

Inclusión de archivos desde PIXI y UberASMTool

Coloca las directivas en el archivo ASM principal del recurso. Las rutas se escriben desde la carpeta de ese archivo.

;#inchbi "MiSprite.hitboxinfo"
;#inchmprop "MiSprite.hitman.json"

Puedes incluir varios archivos .hitboxinfo desde un mismo ASM de PIXI o UberASMTool. Cada archivo genera un define de contexto a partir de su nombre. Por ejemplo, MiSprite.hitboxinfo genera !MiSpriteHitboxContext en HitmanDefines.asm. Si un archivo vinculado tiene el mismo nombre que otro de HitboxInfo/, se usa el vinculado.

Usa ;#inchmprop una sola vez en el ASM principal de un sprite normal de PIXI. Para instalar los recursos y regenerar sus definiciones, consulta el Quick Start.

Definir propiedades

Crea un JSON en CustomProperties/ con el nombre de la propiedad y un valor inicial para sprites normales vanilla y otro para sprites normales custom. Cada valor ocupa un byte y se escribe en hexadecimal entre comillas.

{
  "Name": "IsLarge",
  "DefaultValueVanilla": "00",
  "DefaultValueCustom": "00"
}

En este ejemplo, todos los sprites empiezan con 00 (pequeño). Puedes asignar 01 a un sprite grande. Otros sprites pueden leer la propiedad para decidir cómo reaccionar según su tamaño.

Cambiar propiedades para un sprite

El siguiente JSON asigna 01 a IsLarge para todas las instancias de un sprite custom. Las propiedades que omitas conservan su valor inicial.

{
  "Name": "MiSprite",
  "IsCustom": true,
  "Properties": [
    { "PropertyName": "IsLarge", "Value": "01" }
  ]
}

Si colocas el JSON en CustomProperties/PerSprite/, el campo Name de un sprite custom debe coincidir con el nombre base de su archivo CFG o JSON en PIXI. Por ejemplo, usa MiSprite para MiSprite.json. Si usas ;#inchmprop, Hitman Tool obtiene ese nombre de la entrada de PIXI. Para configurar un sprite vanilla desde la carpeta central, usa "IsCustom": false e indica su número hexadecimal en ID.

El mismo JSON admite un bloque opcional VanillaCallbacks. Sus campos son SpriteSprite, Fireball, YoshiFireball, Quake y CapeDive. Cada valor es el nombre de una rutina. Para recibir el evento, habilita su bit en la propiedad VanillaEventMask. Los archivos anteriores también pueden usar VanillaInteractionCallback como respaldo y para explosiones.

HitboxInfo

Cada archivo .hitboxinfo define las cajas de un contexto. Una pose puede tener varias cajas, compartirlas con otras poses o quedar vacía. Puedes usar archivos de ambos formatos en una instalación. Cada archivo debe seguir un solo formato.

Formato actual

AllHitboxes:
    .XOffset $08
    .XPivot $08

HitboxesPerPose:
    .Pose0 0
    .Pose1..2 0,1
    .Pose[4,6] 1
    .Pose7

AllHitboxCallbacks:
    .OnPlayerNonCollision CheckPlayerIsAbove

Hitbox0:
    .YOffset $FFFF
    .Width $10
    .Height $08
    .OnPlayerCollision CheckBounce

Hitbox1:
    .XOffset $0C
    .Width $08
  • HitboxesPerPose: indica qué cajas usa cada pose, en el orden en que se comprueban. Los números de pose y de caja son decimales. .Pose1..2 asigna las mismas cajas a las poses 1 y 2. .Pose[4,6] selecciona solo las poses 4 y 6. Una pose sin cajas, como la 7, queda vacía. Los números omitidos también quedan vacíos.
  • HitboxN: define una caja. .XOffset y .YOffset desplazan la caja desde el origen del recurso. Empiezan en $00. .Width y .Height son sus dimensiones en píxeles. Deben ser positivas y empiezan en $10. Para desplazar la caja un píxel hacia arriba, usa $FFFF (−1) en Y. $FF representa +255 en este formato.
  • AllHitboxes: permite desplazar todas las cajas. .XPivot y .YPivot fijan el punto alrededor del cual se refleja cada eje al voltear la caja. Una caja puede fijar su propio pivote, incluso a $00. Si no hay pivote para un eje, su desplazamiento se mantiene al voltear. El desplazamiento global se suma después de calcular el reflejo.
  • AllHitboxCallbacks: define callbacks comunes. Cada caja puede sustituirlos por separado. .OnPlayerCollision se usa al tocar a Mario y .OnPlayerNonCollision cuando la caja no lo toca. El lector reconoce campos para otras familias, pero el parche actual solo ejecuta estos dos callbacks por caja del formato actual.

Algunos archivos del formato actual usan AllHitboxXOffset: y AllHitboxYOffset:. Esas secciones siguen funcionando y aplican el desplazamiento antes de reflejar la caja. Usa esas secciones o AllHitboxes: en un mismo archivo.

Valores por defecto

Si omites un campo, Hitman Tool usa estos valores.

Campo Valor al omitirlo
.XOffset y .YOffset $00. Si hay un desplazamiento en AllHitboxes:, se suma al de la caja.
.Width y .Height $10 (16 píxeles) por eje.
.XPivot y .YPivot Se usa el pivote de AllHitboxes:. Si tampoco se define allí, el desplazamiento de ese eje se conserva al voltear.
.OnPlayerCollision y .OnPlayerNonCollision Se usa el callback de AllHitboxCallbacks: para ese campo. Si tampoco se define allí, se usa Nothing.

Formato legacy

El formato legacy organiza las cajas en tablas paralelas. La primera entrada de cada tabla corresponde a la caja $00.

PoseHitBoxes:
    db $00,$FF
    db $FF

HitboxXOffset:
    dw $0000
HitboxYOffset:
    dw $FFFF
HitboxWidth:
    dw $0010
HitboxHeight:
    dw $0008
HitboxAction1:
    dw $0000
HitboxAction2:
    dw $0002
Actions:
    dw CheckBounce
    dw CheckPlayerIsAbove
  • La pose 0 usa la caja $00. Cada pose termina en $FF. La pose 1 solo contiene el terminador y queda vacía.
  • Las tablas de desplazamiento, ancho y alto tienen una entrada por caja. Las tablas opcionales HitboxXOffsetFlip y HitboxYOffsetFlip permiten indicar desplazamientos al voltear. Si se omiten, se usan los desplazamientos normales.
  • HitboxAction1 selecciona la rutina de contacto y HitboxAction2 la de ausencia de contacto. Los valores son desplazamientos dentro de Actions:. Usa $0000 para la primera rutina, $0002 para la segunda y así sucesivamente. Si no declaras acciones, se usa Nothing.

Incluir rutinas auxiliares

Usa Dependencies: cuando un callback necesite una rutina auxiliar que Hitman Tool no pueda detectar por sí solo, por ejemplo si el nombre de la rutina aparece únicamente dentro de una macro. Escribe dw seguido del nombre de la rutina, sin la extensión .asm. Hitman Tool busca el archivo en Routines/ y lo incluye al instalar el parche.

Dependencies:
    dw PlayerFloor

Este ejemplo incluye Routines/PlayerFloor.asm. La declaración no llama a la rutina ni le asigna una caja. Los valores de HitboxAction1 y HitboxAction2 siguen apuntando a las entradas de Actions:.