Torque3D Documentation / _generateds / VSceneJumpEvent.cpp

VSceneJumpEvent.cpp

Engine/source/Verve/Extension/Director/VSceneJumpEvent.cpp

More...

Detailed Description

Public Functions

IMPLEMENT_CONOBJECT(VSceneJumpEvent )

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#include "Verve/Core/VController.h"
25#include "Verve/Extension/Director/VSceneJumpEvent.h"
26#include "Verve/Extension/Director/VDirectorGroup.h"
27#include "Verve/Extension/Director/VDirectorTrack.h"
28#include "Verve/Extension/Director/VDirectorEvent.h"
29
30#include "console/consoleTypes.h"
31
32//-----------------------------------------------------------------------------
33IMPLEMENT_CONOBJECT( VSceneJumpEvent );
34//-----------------------------------------------------------------------------
35
36VSceneJumpEvent::VSceneJumpEvent( void ) :
37        mTarget( String::EmptyString )
38{
39    setLabel( "SceneJumpEvent" );
40}
41
42void VSceneJumpEvent::initPersistFields( void )
43{
44    Parent::initPersistFields();
45
46    addField( "Target", TypeRealString, Offset( mTarget, VSceneJumpEvent ), "The name of the Scene that the controller will jump to upon triggering." );
47}
48
49//-----------------------------------------------------------------------------
50//
51// Controller Methods.
52//
53//-----------------------------------------------------------------------------
54
55//-----------------------------------------------------------------------------
56// 
57// VSceneJumpEvent::onTrigger( pTime, pDelta );
58// 
59// Tell the controller to jump to a new scene.
60// 
61//-----------------------------------------------------------------------------
62void VSceneJumpEvent::onTrigger( const S32 &pTime, const S32 &pDelta )
63{
64    Parent::onTrigger( pTime, pDelta );
65
66    VDirectorTrack *track = getController()->getDirectorTrack();
67    if ( !track )
68    {
69        // Invalid Track.
70        return;
71    }
72
73    // Get Event.
74    VDirectorEvent *event;
75    if ( !track->getObject( mTarget, event ) )
76    {
77        // Can't Jump.
78        return;
79    }
80
81    // Go To Scene.
82    getController()->jump( VController::k_JumpTime, event->getTriggerTime() );
83}
84