package funkin.play.event; import flixel.tweens.FlxEase; // Data from the chart import funkin.data.song.SongData; import funkin.data.song.SongData.SongEventData; // Data from the event schema import funkin.play.event.SongEvent; import funkin.data.event.SongEventSchema; import funkin.data.event.SongEventSchema.SongEventFieldType; /** * This class represents a handler for a type of song event. * It is used by the ScriptedSongEvent class to handle user-defined events. * * Example: Focus on Boyfriend: * ``` * { * "e": "FocusCamera", * "v": { * "char": 0, * } * } * ``` * * Example: Focus on 10px above Girlfriend: * ``` * { * "e": "FocusCamera", * "v": { * "char": 2, * "y": -10, * } * } * ``` * * Example: Focus on (100, 100): * ``` * { * "e": "FocusCamera", * "v": { * "char": -1, * "x": 100, * "y": 100, * } * } * ``` */ class FocusCameraSongEvent extends SongEvent { public function new() { super('FocusCamera'); } public override function handleEvent(data:SongEventData):Void { // Does nothing if there is no PlayState camera or stage. if (PlayState.instance == null || PlayState.instance.currentStage == null) return; // Does nothing if we are minimal mode. if (PlayState.instance.isMinimalMode) return; var posX:Null = data.getFloat('x'); if (posX == null) posX = 0.0; var posY:Null = data.getFloat('y'); if (posY == null) posY = 0.0; var char:Null = data.getInt('char'); if (char == null) char = cast data.value; var useTween:Null = data.getBool('useTween'); if (useTween == null) useTween = false; var duration:Null = data.getFloat('duration'); if (duration == null) duration = 4.0; var ease:Null = data.getString('ease'); if (ease == null) ease = 'linear'; switch (char) { case -1: // Position trace('Focusing camera on static position.'); var xTarget:Float = posX; var yTarget:Float = posY; PlayState.instance.cameraFollowPoint.setPosition(xTarget, yTarget); case 0: // Boyfriend // Focus the camera on the player. if (PlayState.instance.currentStage.getBoyfriend() == null) { trace('No BF to focus on.'); return; } trace('Focusing camera on player.'); var xTarget:Float = PlayState.instance.currentStage.getBoyfriend().cameraFocusPoint.x + posX; var yTarget:Float = PlayState.instance.currentStage.getBoyfriend().cameraFocusPoint.y + posY; PlayState.instance.cameraFollowPoint.setPosition(xTarget, yTarget); case 1: // Dad // Focus the camera on the dad. if (PlayState.instance.currentStage.getDad() == null) { trace('No dad to focus on.'); return; } trace('Focusing camera on dad.'); trace(PlayState.instance.currentStage.getDad()); var xTarget:Float = PlayState.instance.currentStage.getDad().cameraFocusPoint.x + posX; var yTarget:Float = PlayState.instance.currentStage.getDad().cameraFocusPoint.y + posY; PlayState.instance.cameraFollowPoint.setPosition(xTarget, yTarget); case 2: // Girlfriend // Focus the camera on the girlfriend. if (PlayState.instance.currentStage.getGirlfriend() == null) { trace('No GF to focus on.'); return; } trace('Focusing camera on girlfriend.'); var xTarget:Float = PlayState.instance.currentStage.getGirlfriend().cameraFocusPoint.x + posX; var yTarget:Float = PlayState.instance.currentStage.getGirlfriend().cameraFocusPoint.y + posY; PlayState.instance.cameraFollowPoint.setPosition(xTarget, yTarget); default: trace('Unknown camera focus: ' + data); } if (useTween) { switch (ease) { case 'INSTANT': PlayState.instance.tweenCameraToFollowPoint(0); default: var durSeconds = Conductor.instance.stepLengthMs * duration / 1000; var easeFunction:NullFloat> = Reflect.field(FlxEase, ease); if (easeFunction == null) { trace('Invalid ease function: $ease'); return; } PlayState.instance.tweenCameraToFollowPoint(durSeconds, easeFunction); } } } public override function getTitle():String { return 'Focus Camera'; } /** * ``` * { * "char": ENUM, // Which character to point to * "x": FLOAT, // Optional x offset * "y": FLOAT, // Optional y offset * } * @return SongEventSchema */ public override function getEventSchema():SongEventSchema { return new SongEventSchema([ { name: "char", title: "Target", defaultValue: 0, type: SongEventFieldType.ENUM, keys: ["Position" => -1, "Player" => 0, "Opponent" => 1, "Girlfriend" => 2] }, { name: "x", title: "X Position", defaultValue: 0, step: 10.0, type: SongEventFieldType.FLOAT, units: "px" }, { name: "y", title: "Y Position", defaultValue: 0, step: 10.0, type: SongEventFieldType.FLOAT, units: "px" }, { name: 'useTween', title: 'Use Tween', type: SongEventFieldType.BOOL, defaultValue: false }, { name: 'duration', title: 'Duration', defaultValue: 4.0, step: 0.5, type: SongEventFieldType.FLOAT, units: 'steps' }, { name: 'ease', title: 'Easing Type', defaultValue: 'linear', type: SongEventFieldType.ENUM, keys: [ 'Linear' => 'linear', 'Instant' => 'INSTANT', 'Quad In' => 'quadIn', 'Quad Out' => 'quadOut', 'Quad In/Out' => 'quadInOut', 'Cube In' => 'cubeIn', 'Cube Out' => 'cubeOut', 'Cube In/Out' => 'cubeInOut', 'Quart In' => 'quartIn', 'Quart Out' => 'quartOut', 'Quart In/Out' => 'quartInOut', 'Quint In' => 'quintIn', 'Quint Out' => 'quintOut', 'Quint In/Out' => 'quintInOut', 'Smooth Step In' => 'smoothStepIn', 'Smooth Step Out' => 'smoothStepOut', 'Smooth Step In/Out' => 'smoothStepInOut', 'Sine In' => 'sineIn', 'Sine Out' => 'sineOut', 'Sine In/Out' => 'sineInOut', 'Elastic In' => 'elasticIn', 'Elastic Out' => 'elasticOut', 'Elastic In/Out' => 'elasticInOut', ] } ]); } }