2023-01-05 12:25:55 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* editor_run.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/**************************************************************************/
|
2018-01-04 23:50:27 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
#ifndef EDITOR_RUN_H
|
|
|
|
#define EDITOR_RUN_H
|
|
|
|
|
2018-09-11 16:13:45 +00:00
|
|
|
#include "core/os/os.h"
|
2022-11-19 11:45:49 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
class EditorRun {
|
|
|
|
public:
|
|
|
|
enum Status {
|
|
|
|
STATUS_PLAY,
|
|
|
|
STATUS_PAUSED,
|
|
|
|
STATUS_STOP
|
|
|
|
};
|
|
|
|
|
2020-02-07 01:52:05 +00:00
|
|
|
List<OS::ProcessID> pids;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
private:
|
2014-02-10 01:10:30 +00:00
|
|
|
Status status;
|
2020-04-05 14:19:24 +00:00
|
|
|
String running_scene;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2023-03-28 18:24:29 +00:00
|
|
|
Vector<String> _split_cmdline_args(const String &arg_string);
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2014-02-10 01:10:30 +00:00
|
|
|
Status get_status() const;
|
2020-04-05 14:19:24 +00:00
|
|
|
String get_running_scene() const;
|
Implement Running Godot as Movie Writer
* Allows running the game in "movie writer" mode.
* It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time).
* If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult.
* Implements a simple, default MJPEG writer.
This new features has two main use cases, which have high demand:
* Saving game videos in high quality and ensuring the frame rate is *completely* stable, always.
* Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this).
**Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly).
Usage:
$ godot --write-movie movie.avi [scene_file.tscn]
Missing:
* Options for configuring video writing via GLOBAL_DEF
* UI Menu for launching with this mode from the editor.
* Add to list of command line options.
* Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
|
|
|
Error run(const String &p_scene, const String &p_write_movie = "");
|
2015-08-06 05:37:40 +00:00
|
|
|
void run_native_notify() { status = STATUS_PLAY; }
|
2014-02-10 01:10:30 +00:00
|
|
|
void stop();
|
2015-09-20 16:03:46 +00:00
|
|
|
|
2020-02-07 01:52:05 +00:00
|
|
|
void stop_child_process(OS::ProcessID p_pid);
|
|
|
|
bool has_child_process(OS::ProcessID p_pid) const;
|
|
|
|
int get_child_process_count() const { return pids.size(); }
|
2016-09-14 02:02:18 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
EditorRun();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // EDITOR_RUN_H
|