fyrox_scripts/
lib.rs

1// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! A set of useful scripts that can be used to in your game.
22
23use crate::camera::FlyingCameraController;
24use fyrox::script::constructor::ScriptConstructorContainer;
25
26pub mod camera;
27
28/// Registers every script from the crate in the given constructor container. Use it, if you want to register all
29/// available scripts at once. Typical usage could be like this:
30///
31/// ```rust,no_run
32/// # use fyrox::{
33/// #     core::pool::Handle, core::visitor::prelude::*, core::reflect::prelude::*,
34/// #     plugin::{Plugin, PluginContext, PluginRegistrationContext},
35/// #     scene::Scene,
36/// # };
37/// #
38/// # #[derive(Visit, Reflect, Debug)]
39/// # struct Game;
40/// #
41/// # impl Plugin for Game {
42///   // This is PluginConstructor::register method of your GameConstructor.
43///   fn register(&self, context: PluginRegistrationContext) {
44///       fyrox_scripts::register(&context.serialization_context.script_constructors)
45///   }
46/// # }
47/// ```
48pub fn register(container: &ScriptConstructorContainer) {
49    container.add::<FlyingCameraController>("Fyrox Flying Camera Controller");
50}
fyrox_scripts/lib.rs

fyrox_scripts/
lib.rs
