loaforcsSoundAPI

Un módulo de reemplazo de sonido portátil diseñado para dar a los creadores de paquetes de sonido más control y una base de código más mantenible.

Para los creadores de paquetes de sonido

A Tutoriales sencillos Los métodos para hacer paquetes de sonido están disponibles en la wiki de github. Ejemplos También disponible.

• Jerarquía de estructura de archivo personalizada
• Mapa de múltiples sonidos al mismo sonido
• Los paquetes de sonido pueden crear opciones de configuración como los módulos regulares
• Intercambia clips de audio en tiempo real según lo que está sucediendo en el juego.

Para desarrolladores

SoundAPI eventualmente incluirá múltiples utilidades para ayudar a cargar sonidos personalizados. Todos los métodos comunes de uso están en SoundAPI Clase.

Condiciones personalizadas

Aquí hay una condición de ejemplo.

[SoundAPICondition("LethalCompany:apparatus_state")]//SoundAPI.RegisterAll propiedades de la función Clase pública ApparatusStateCondition: Condición {public enum StateType {PULLED, PLUGGED_IN} bool estático interno CurrentApparatusPulled=false; public StateType? Value {get; internal set;}}//Public overwrite bool Evaluate(IContext context) {StateType state=CurrentApparatusPulled? StateType.PULLED: StateType.PLUGGED_IN; //o manualmente (si se requiere una lógica más compleja) SoundAPI.RegisterCondition("LethalLevelLoader:dungeon:has_tag ", () = > new LLLTagCondition<ExtendedDungeonFlow>(() = > {if (! RoundManager.Instance) return null; if (! RoundManager.Instance.dungeonGenerator) return null; if (! PatchedContent.TryGetExtendedContent (RoundManager.Instance.dungeonGenerator.DungeonFlow, out ExtendedDungeonFlow llDungeon)) return null; return llDungeon)) return null;}));

Los creadores de paquetes de sonido utilizarán

{"condición":{"tipo":"LethalCompany:apparatus_state"}}

Porque Valor Es vacío, el creador del paquete de sonido no necesita proporcionar un valor, será predeterminado en verdadero. De lo contrario, pueden configurarlo manualmente como Enchufado Compruebe que el instrumento esté enchufado. Incluso si actualmente solo hay dos opciones de compatibilidad hacia adelante, se recomienda usar enumeraciones.

Mapeo

Mapping es un acceso directo para que los desarrolladores de mods escriban una o más coincidencias de sonido. Se recomienda que los creadores de paquetes de sonido utilicen mapas siempre que sea posible para lograr la compatibilidad hacia adelante (ya que los desarrolladores de mods pueden actualizar los archivos de mapas a través de actualizaciones de mod sin necesidad de actualizar el paquete de sonido).

Para utilizar el mapeo, debe incluir un Paquete de sonido.json En su mod zip (este es SoundAPI para cargarlo automáticamente, uno a través de SoundAPI La clase puede venir más tarde). No es necesario incluir Alternativas O Sonido Carpeta. A Los archivos se colocan entonces en la misma carpeta.

Ejemplos DOCUMENTO:

{"FacilityMeltdown:music":["MeltdownHandler: MeltdownMusic "]," FacilityMeltdown:warning_voice":["MeltdownHandler: warning1 "," MeltdownHandler: warning2 "," MeltdownHandler: warning3 "," MeltdownHandler: warning4 "]}

Notas: soundapi_mappings.json Los nombres de archivos pueden cambiarse más adelante, pero la compatibilidad se mantendrá.

Los creadores de paquetes de sonido entonces usarán su mapeo en sus sustitutos. El prefijo de mapeo en la coincidencia tiene #.

{"replacements ": [{"matches": "#FacilityMeltdown: música", "sonidos": [{"sound ":" meltdown.ogg"}]}]}

Convención de nombres

Se recomienda seguir las convenciones de nomenclatura para sus condiciones y mapas. No tenga 1 “pieza” o más de 3. Cada sección debe estar separada por dos puntos.

• Nombre de su MOD: NOMBRE O
• Nombre de su MOD: Subcategoría: Nombres