1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
#![warn(missing_docs)]
//! Script is used to add custom logic to scene nodes. See [ScriptTrait] for more info.
use crate::{
asset::manager::ResourceManager,
core::{
log::Log,
pool::Handle,
reflect::{FieldInfo, Reflect, ReflectArray, ReflectList},
type_traits::ComponentProvider,
uuid::Uuid,
visitor::{Visit, VisitResult, Visitor},
TypeUuidProvider,
},
engine::{task::TaskPoolHandler, GraphicsContext, ScriptMessageDispatcher},
event::Event,
plugin::Plugin,
scene::{node::Node, Scene},
};
use fyrox_ui::UserInterface;
use std::{
any::{Any, TypeId},
fmt::{Debug, Formatter},
ops::{Deref, DerefMut},
sync::mpsc::Sender,
};
pub mod constructor;
/// A script message's payload.
pub trait ScriptMessagePayload: Any + Send + Debug {
/// Returns `self` as `&dyn Any`
fn as_any_ref(&self) -> &dyn Any;
/// Returns `self` as `&dyn Any`
fn as_any_mut(&mut self) -> &mut dyn Any;
}
impl dyn ScriptMessagePayload {
/// Tries to cast the payload to a particular type.
pub fn downcast_ref<T: 'static>(&self) -> Option<&T> {
self.as_any_ref().downcast_ref::<T>()
}
/// Tries to cast the payload to a particular type.
pub fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> {
self.as_any_mut().downcast_mut::<T>()
}
}
impl<T> ScriptMessagePayload for T
where
T: 'static + Send + Debug,
{
fn as_any_ref(&self) -> &dyn Any {
self
}
fn as_any_mut(&mut self) -> &mut dyn Any {
self
}
}
/// Defines how a script message will be delivered for each node in a hierarchy.
#[derive(Debug)]
pub enum RoutingStrategy {
/// An message will be passed to the specified root node and then to every node up in the hierarchy.
Up,
/// An message will be passed to every node down the tree in the hierarchy.
Down,
}
/// A script message of a particular kind.
#[derive(Debug)]
pub struct ScriptMessage {
/// Actual message payload.
pub payload: Box<dyn ScriptMessagePayload>,
/// Actual script message kind.
pub kind: ScriptMessageKind,
}
/// An message for a node with a script.
#[derive(Debug)]
pub enum ScriptMessageKind {
/// An message for a specific scene node. It will be delivered only if the node is subscribed to receive
/// messages of a particular type.
Targeted(Handle<Node>),
/// An message for a hierarchy of nodes.
Hierarchical {
/// Starting node in a scene graph. Message will be delivered to each node in hierarchy in the order
/// defined by `routing` if the node is subscribed to receive messages of a particular type.
root: Handle<Node>,
/// [Routing strategy](RoutingStrategy) for the message.
routing: RoutingStrategy,
},
/// An message that will be delivered for **every** scene node that is subscribed to receive messages
/// of a particular type.
Global,
}
/// A script message sender.
#[derive(Clone)]
pub struct ScriptMessageSender {
pub(crate) sender: Sender<ScriptMessage>,
}
impl Debug for ScriptMessageSender {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "ScriptMessageSender")
}
}
impl ScriptMessageSender {
/// Send a generic script message.
pub fn send(&self, message: ScriptMessage) {
if self.sender.send(message).is_err() {
Log::err("Failed to send script message, it means the scene is already deleted!");
}
}
/// Sends a targeted script message with the given payload.
pub fn send_to_target<T>(&self, target: Handle<Node>, payload: T)
where
T: ScriptMessagePayload,
{
self.send(ScriptMessage {
payload: Box::new(payload),
kind: ScriptMessageKind::Targeted(target),
})
}
/// Sends a global script message with the given payload.
pub fn send_global<T>(&self, payload: T)
where
T: ScriptMessagePayload,
{
self.send(ScriptMessage {
payload: Box::new(payload),
kind: ScriptMessageKind::Global,
})
}
/// Sends a hierarchical script message with the given payload.
pub fn send_hierarchical<T>(&self, root: Handle<Node>, routing: RoutingStrategy, payload: T)
where
T: ScriptMessagePayload,
{
self.send(ScriptMessage {
payload: Box::new(payload),
kind: ScriptMessageKind::Hierarchical { root, routing },
})
}
}
/// Base script trait is used to automatically implement some trait to reduce amount of boilerplate code.
pub trait BaseScript: Visit + Reflect + Send + Debug + 'static {
/// Creates exact copy of the script.
fn clone_box(&self) -> Box<dyn ScriptTrait>;
/// Casts self as `Any`
fn as_any_ref(&self) -> &dyn Any;
/// Casts self as `Any`
fn as_any_ref_mut(&mut self) -> &mut dyn Any;
/// Script instance type UUID. The value will be used for serialization, to write type
/// identifier to a data source so the engine can restore the script from data source.
///
/// # Important notes
///
/// Do **not** use [`Uuid::new_v4`] or any other [`Uuid`] methods that generates ids, ids
/// generated using these methods are **random** and are not suitable for serialization!
///
/// # Example
///
/// All you need to do in the method is to return `Self::type_uuid`.
///
/// ```rust
/// use std::str::FromStr;
/// use fyrox::{
/// core::visitor::prelude::*,
/// core::reflect::prelude::*,
/// core::uuid::Uuid,
/// script::ScriptTrait,
/// core::TypeUuidProvider,
/// core::uuid::uuid, core::type_traits::prelude::*
/// };
///
/// #[derive(Reflect, Visit, Debug, Clone, ComponentProvider)]
/// struct MyScript { }
///
/// // Implement TypeUuidProvider trait that will return type uuid of the type.
/// // Every script must implement the trait so the script can be registered in
/// // serialization context of the engine.
/// impl TypeUuidProvider for MyScript {
/// fn type_uuid() -> Uuid {
/// // Use https://www.uuidgenerator.net/ to generate new UUID.
/// uuid!("4cfbe65e-a2c1-474f-b123-57516d80b1f8")
/// }
/// }
///
/// impl ScriptTrait for MyScript { }
/// ```
fn id(&self) -> Uuid;
}
impl<T> BaseScript for T
where
T: Clone + ScriptTrait + Any + TypeUuidProvider,
{
fn clone_box(&self) -> Box<dyn ScriptTrait> {
Box::new(self.clone())
}
fn as_any_ref(&self) -> &dyn Any {
self
}
fn as_any_ref_mut(&mut self) -> &mut dyn Any {
self
}
fn id(&self) -> Uuid {
T::type_uuid()
}
}
/// A simple wrapper for a reference to plugins container. It has some useful methods to fetch
/// a plugin of certain type. See [`PluginsRefMut::of_type_ref`] and [`PluginsRefMut::of_type_mut`].
pub struct PluginsRefMut<'a>(pub &'a mut [Box<dyn Plugin>]);
impl<'a> Deref for PluginsRefMut<'a> {
type Target = [Box<dyn Plugin>];
fn deref(&self) -> &Self::Target {
self.0
}
}
impl<'a> DerefMut for PluginsRefMut<'a> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.0
}
}
impl<'a> PluginsRefMut<'a> {
/// Searches for a plugin of the given type `T`.
#[inline]
pub fn of_type_ref<T>(&self) -> Option<&T>
where
T: Plugin,
{
self.0.iter().find_map(|p| p.cast::<T>())
}
/// Searches for a plugin of the given type `T`.
#[inline]
pub fn of_type_mut<T>(&mut self) -> Option<&mut T>
where
T: Plugin,
{
self.0.iter_mut().find_map(|p| p.cast_mut::<T>())
}
/// Searches for a plugin of the given type `T`. Panics if there's no such plugin.
#[inline]
pub fn get<T>(&self) -> &T
where
T: Plugin,
{
self.of_type_ref().unwrap()
}
/// Searches for a plugin of the given type `T`. Panics if there's no such plugin.
#[inline]
pub fn get_mut<T>(&mut self) -> &mut T
where
T: Plugin,
{
self.of_type_mut().unwrap()
}
}
/// A set of data, that provides contextual information for script methods.
pub struct ScriptContext<'a, 'b, 'c> {
/// Amount of time that passed from last call. It has valid values only when called from `on_update`.
pub dt: f32,
/// Amount of time (in seconds) that passed from creation of the engine. Keep in mind, that
/// this value is **not** guaranteed to match real time. A user can change delta time with
/// which the engine "ticks" and this delta time affects elapsed time.
pub elapsed_time: f32,
/// A reference to the plugin which the script instance belongs to. You can use it to access plugin data
/// inside script methods. For example you can store some "global" data in the plugin - for example a
/// controls configuration, some entity managers and so on.
pub plugins: PluginsRefMut<'a>,
/// Handle of a node to which the script instance belongs to. To access the node itself use `scene` field:
///
/// ```rust
/// # use fyrox::script::ScriptContext;
/// # fn foo(context: ScriptContext) {
/// let node_mut = &mut context.scene.graph[context.handle];
/// # }
/// ```
pub handle: Handle<Node>,
/// A reference to a scene the script instance belongs to. You have full mutable access to scene content
/// in most of the script methods.
pub scene: &'b mut Scene,
/// A handle of a scene the script instance belongs to.
pub scene_handle: Handle<Scene>,
/// A reference to resource manager, use it to load resources.
pub resource_manager: &'a ResourceManager,
/// An message sender. Every message sent via this sender will be then passed to every [`ScriptTrait::on_message`]
/// method of every script.
pub message_sender: &'c ScriptMessageSender,
/// A message dispatcher. If you need to receive messages of a particular type, you must subscribe to a type
/// explicitly. See [`ScriptTrait::on_message`] for more examples.
pub message_dispatcher: &'c mut ScriptMessageDispatcher,
/// Task pool for asynchronous task management.
pub task_pool: &'a mut TaskPoolHandler,
/// Current graphics context of the engine. See [`GraphicsContext`] docs for more info.
pub graphics_context: &'a mut GraphicsContext,
/// A reference to the user interface.
pub user_interface: &'a mut UserInterface,
}
/// A set of data, that provides contextual information for script methods.
pub struct ScriptMessageContext<'a, 'b, 'c> {
/// Amount of time that passed from last call. It has valid values only when called from `on_update`.
pub dt: f32,
/// Amount of time (in seconds) that passed from creation of the engine. Keep in mind, that
/// this value is **not** guaranteed to match real time. A user can change delta time with
/// which the engine "ticks" and this delta time affects elapsed time.
pub elapsed_time: f32,
/// A reference to the plugin which the script instance belongs to. You can use it to access plugin data
/// inside script methods. For example you can store some "global" data in the plugin - for example a
/// controls configuration, some entity managers and so on.
pub plugins: PluginsRefMut<'a>,
/// Handle of a node to which the script instance belongs to. To access the node itself use `scene` field:
///
/// ```rust
/// # use fyrox::script::ScriptContext;
/// # fn foo(context: ScriptContext) {
/// let node_mut = &mut context.scene.graph[context.handle];
/// # }
/// ```
pub handle: Handle<Node>,
/// A reference to a scene the script instance belongs to. You have full mutable access to scene content
/// in most of the script methods.
pub scene: &'b mut Scene,
/// A handle of a scene the script instance belongs to.
pub scene_handle: Handle<Scene>,
/// A reference to resource manager, use it to load resources.
pub resource_manager: &'a ResourceManager,
/// An message sender. Every message sent via this sender will be then passed to every [`ScriptTrait::on_message`]
/// method of every script.
pub message_sender: &'c ScriptMessageSender,
/// Task pool for asynchronous task management.
pub task_pool: &'a mut TaskPoolHandler,
/// Current graphics context of the engine. See [`GraphicsContext`] docs for more info.
pub graphics_context: &'a mut GraphicsContext,
/// A reference to the user interface.
pub user_interface: &'a mut UserInterface,
}
/// A set of data that will be passed to a script instance just before its destruction.
pub struct ScriptDeinitContext<'a, 'b, 'c> {
/// Amount of time (in seconds) that passed from creation of the engine. Keep in mind, that
/// this value is **not** guaranteed to match real time. A user can change delta time with
/// which the engine "ticks" and this delta time affects elapsed time.
pub elapsed_time: f32,
/// A reference to the plugin which the script instance belongs to. You can use it to access plugin data
/// inside script methods. For example you can store some "global" data in the plugin - for example a
/// controls configuration, some entity managers and so on.
pub plugins: PluginsRefMut<'a>,
/// A reference to resource manager, use it to load resources.
pub resource_manager: &'a ResourceManager,
/// A reference to a scene the script instance was belonging to. You have full mutable access to scene content
/// in most of the script methods.
pub scene: &'b mut Scene,
/// A handle of a scene the script instance belongs to.
pub scene_handle: Handle<Scene>,
/// Handle to a parent scene node. Use it with caution because parent node could be deleted already and
/// any unchecked borrowing using the handle will cause panic!
pub node_handle: Handle<Node>,
/// An message sender. Every message sent via this sender will be then passed to every [`ScriptTrait::on_message`]
/// method of every script.
pub message_sender: &'c ScriptMessageSender,
/// Task pool for asynchronous task management.
pub task_pool: &'a mut TaskPoolHandler,
/// Current graphics context of the engine. See [`GraphicsContext`] docs for more info.
pub graphics_context: &'a mut GraphicsContext,
/// A reference to the user interface.
pub user_interface: &'a mut UserInterface,
}
/// Script is a set predefined methods that are called on various stages by the engine. It is used to add
/// custom behaviour to game entities.
pub trait ScriptTrait: BaseScript + ComponentProvider {
/// The method is called when the script wasn't initialized yet. It is guaranteed to be called once,
/// and before any other methods of the script.
///
/// # Important
///
/// The method **will not** be called in case if you serialized initialized script instance and then
/// loaded the instance. Internal flag will tell the engine that the script is initialized and this
/// method **will not** be called. This is intentional design decision to be able to create save files
/// in games. If you need a method that will be called in any case, use [`ScriptTrait::on_start`].
fn on_init(&mut self, #[allow(unused_variables)] ctx: &mut ScriptContext) {}
/// The method is called after [`ScriptTrait::on_init`], but in separate pass, which means that all
/// script instances are already initialized. However, if implementor of this method creates a new
/// node with a script, there will be a second pass of initialization. The method is guaranteed to
/// be called once.
fn on_start(&mut self, #[allow(unused_variables)] ctx: &mut ScriptContext) {}
/// The method is called when the script is about to be destroyed. It is guaranteed to be called last.
fn on_deinit(&mut self, #[allow(unused_variables)] ctx: &mut ScriptDeinitContext) {}
/// Called when there is an event from the OS. The method allows you to "listen" for events
/// coming from the main window of your game. It could be used to react to pressed keys, mouse movements,
/// etc.
fn on_os_event(
&mut self,
#[allow(unused_variables)] event: &Event<()>,
#[allow(unused_variables)] ctx: &mut ScriptContext,
) {
}
/// Performs a single update tick of the script. The method may be called multiple times per frame, but it is guaranteed
/// that the rate of call is stable and by default it will be called 60 times per second, but can be changed by using
/// [`crate::engine::executor::Executor::set_desired_update_rate`] method.
fn on_update(&mut self, #[allow(unused_variables)] ctx: &mut ScriptContext) {}
/// Allows you to react to certain script messages. It could be used for communication between scripts; to
/// bypass borrowing issues. If you need to receive messages of a particular type, you must subscribe to a type
/// explicitly. Usually it is done in [`ScriptTrait::on_start`] method:
///
/// ```rust
/// use fyrox::{
/// core::{reflect::prelude::*, uuid::Uuid, visitor::prelude::*, type_traits::prelude::*},
/// core::TypeUuidProvider,
/// script::ScriptTrait,
/// script::{ScriptContext, ScriptMessageContext, ScriptMessagePayload},
/// };
///
/// struct Message;
///
/// #[derive(Reflect, Visit, Debug, Clone, ComponentProvider)]
/// struct MyScript {}
///
/// # impl TypeUuidProvider for MyScript {
/// # fn type_uuid() -> Uuid {
/// # todo!();
/// # }
/// # }
///
/// impl ScriptTrait for MyScript {
/// fn on_start(&mut self, ctx: &mut ScriptContext) {
/// // Subscription is mandatory to receive any message of the type!
/// ctx.message_dispatcher.subscribe_to::<Message>(ctx.handle)
/// }
///
/// fn on_message(
/// &mut self,
/// message: &mut dyn ScriptMessagePayload,
/// ctx: &mut ScriptMessageContext,
/// ) {
/// if let Some(message) = message.downcast_ref::<Message>() {
/// // Do something.
/// }
/// }
/// }
/// ```
fn on_message(
&mut self,
#[allow(unused_variables)] message: &mut dyn ScriptMessagePayload,
#[allow(unused_variables)] ctx: &mut ScriptMessageContext,
) {
}
}
/// A wrapper for actual script instance internals, it used by the engine.
#[derive(Debug)]
pub struct Script {
instance: Box<dyn ScriptTrait>,
pub(crate) initialized: bool,
pub(crate) started: bool,
}
impl Reflect for Script {
fn type_name(&self) -> &'static str {
self.instance.type_name()
}
fn doc(&self) -> &'static str {
self.instance.doc()
}
fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo])) {
self.instance.fields_info(func)
}
fn into_any(self: Box<Self>) -> Box<dyn Any> {
self.instance.into_any()
}
fn as_any(&self, func: &mut dyn FnMut(&dyn Any)) {
self.instance.deref().as_any(func)
}
fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any)) {
self.instance.deref_mut().as_any_mut(func)
}
fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect)) {
self.instance.deref().as_reflect(func)
}
fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect)) {
self.instance.deref_mut().as_reflect_mut(func)
}
fn set(&mut self, value: Box<dyn Reflect>) -> Result<Box<dyn Reflect>, Box<dyn Reflect>> {
self.instance.deref_mut().set(value)
}
fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect])) {
self.instance.deref().fields(func)
}
fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect])) {
self.instance.deref_mut().fields_mut(func)
}
fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>)) {
self.instance.deref().field(name, func)
}
fn field_mut(&mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>)) {
self.instance.deref_mut().field_mut(name, func)
}
fn as_array(&self, func: &mut dyn FnMut(Option<&dyn ReflectArray>)) {
self.instance.deref().as_array(func)
}
fn as_array_mut(&mut self, func: &mut dyn FnMut(Option<&mut dyn ReflectArray>)) {
self.instance.deref_mut().as_array_mut(func)
}
fn as_list(&self, func: &mut dyn FnMut(Option<&dyn ReflectList>)) {
self.instance.deref().as_list(func)
}
fn as_list_mut(&mut self, func: &mut dyn FnMut(Option<&mut dyn ReflectList>)) {
self.instance.deref_mut().as_list_mut(func)
}
}
impl Deref for Script {
type Target = dyn ScriptTrait;
fn deref(&self) -> &Self::Target {
&*self.instance
}
}
impl DerefMut for Script {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut *self.instance
}
}
impl Visit for Script {
fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult {
let mut region_guard = visitor.enter_region(name)?;
// Check for new format first, this branch will fail only on attempt to deserialize
// scripts in old format.
if self.instance.visit("Data", &mut region_guard).is_ok() {
// Visit flags.
self.initialized.visit("Initialized", &mut region_guard)?;
} else {
Log::warn(format!(
"Unable to load script instance of id {} in new format! Trying to load in old format...",
self.id()
));
// Leave region and try to load in old format.
drop(region_guard);
self.instance.visit(name, visitor)?;
Log::warn(format!(
"Script instance of id {} loaded successfully using compatibility loader! Resave the script!",
self.id()
));
}
Ok(())
}
}
impl Clone for Script {
fn clone(&self) -> Self {
Self {
instance: self.instance.clone_box(),
initialized: false,
started: false,
}
}
}
impl Script {
/// Creates new script wrapper using given script instance.
#[inline]
pub fn new<T: ScriptTrait>(script_object: T) -> Self {
Self {
instance: Box::new(script_object),
initialized: false,
started: false,
}
}
/// Performs downcasting to a particular type.
#[inline]
pub fn cast<T: ScriptTrait>(&self) -> Option<&T> {
self.instance.deref().as_any_ref().downcast_ref::<T>()
}
/// Performs downcasting to a particular type.
#[inline]
pub fn cast_mut<T: ScriptTrait>(&mut self) -> Option<&mut T> {
self.instance
.deref_mut()
.as_any_ref_mut()
.downcast_mut::<T>()
}
/// Tries to borrow a component of given type.
#[inline]
pub fn query_component_ref<T: Any>(&self) -> Option<&T> {
self.instance
.query_component_ref(TypeId::of::<T>())
.and_then(|c| c.downcast_ref())
}
/// Tries to borrow a component of given type.
#[inline]
pub fn query_component_mut<T: Any>(&mut self) -> Option<&mut T> {
self.instance
.query_component_mut(TypeId::of::<T>())
.and_then(|c| c.downcast_mut())
}
}
#[cfg(test)]
mod test {
use crate::{
core::{
impl_component_provider, reflect::prelude::*, variable::try_inherit_properties,
variable::InheritableVariable, visitor::prelude::*,
},
scene::base::Base,
script::{Script, ScriptTrait},
};
use fyrox_core::uuid_provider;
#[derive(Reflect, Visit, Debug, Clone, Default)]
struct MyScript {
field: InheritableVariable<f32>,
}
impl_component_provider!(MyScript);
uuid_provider!(MyScript = "eed9bf56-7d71-44a0-ba8e-0f3163c59669");
impl ScriptTrait for MyScript {}
#[test]
fn test_script_property_inheritance_on_nodes() {
let mut child = Base::default();
child.script = Some(Script::new(MyScript {
field: InheritableVariable::new_non_modified(1.23),
}));
let mut parent = Base::default();
parent.script = Some(Script::new(MyScript {
field: InheritableVariable::new_non_modified(3.21),
}));
child.as_reflect_mut(&mut |child| {
parent.as_reflect(&mut |parent| {
try_inherit_properties(child, parent, &[]).unwrap();
})
});
assert_eq!(
*child.script().unwrap().cast::<MyScript>().unwrap().field,
3.21
);
}
#[test]
fn test_script_property_inheritance() {
let mut child = Script::new(MyScript {
field: InheritableVariable::new_non_modified(1.23),
});
let parent = Script::new(MyScript {
field: InheritableVariable::new_non_modified(3.21),
});
child.as_reflect_mut(&mut |child| {
parent.as_reflect(&mut |parent| {
try_inherit_properties(child, parent, &[]).unwrap();
})
});
assert_eq!(*child.cast::<MyScript>().unwrap().field, 3.21);
}
#[test]
fn test_script_property_inheritance_option() {
let mut child = Some(Script::new(MyScript {
field: InheritableVariable::new_non_modified(1.23),
}));
let parent = Some(Script::new(MyScript {
field: InheritableVariable::new_non_modified(3.21),
}));
child.as_reflect_mut(&mut |child| {
parent.as_reflect(&mut |parent| {
try_inherit_properties(child, parent, &[]).unwrap();
})
});
assert_eq!(
*child.as_ref().unwrap().cast::<MyScript>().unwrap().field,
3.21
);
}
}