Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

# TribesGUI.TribesSlideshowMenu

00001 00002 00003 00004 00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114
00115
00116
00117
00118
00119
00120
00121
00122
00123
00124
00125
00126
00127
00128
00129
00130
00131
00132
00133
00134
00135
00136
00137
00138
00139
00140
00141
00142
00143
00144
00145
00146
00147

    // ====================================================================
    //  Class:  TribesGui.TribesSlideshowMenu
    //
    // ====================================================================

    class TribesSlideshowMenu extends TribesGUIPage
         ;

    var(TribesGui) EditInline Config GUIImage slideshowImage "A component of this page which has its behavior defined in the code for this page's class.";
    var() bool bDontQuitOnClick;
    var(TribesGui) config array<Material> imageList "A component of this page which has its behavior defined in the code for this page's class.";
    var(TribesGui) config  int imageDelay			"The number of seconds to wait before auto-advancing the slideshow.  0 to disable auto-advancement";
    var(TribesGui) config bool bAllowClickToAdvance "If true, clicking the mouse button on the screen will advance it";

    var int currentImageIndex;
    var bool bActivated;
    var int numTicks;

    function InitComponent(GUIComponent MyOwner)
    {
    	Super.InitComponent(MyOwner);
    	OnShow=InternalOnShow;
        OnKeyEvent=InternalOnKeyEvent;
    	slideshowImage.OnClick=OnSlideshowClick;
    	slideshowImage.OnKeyEvent=InternalOnKeyEvent;
    }

    function InternalOnShow()
    {
    	// Prevent queued mouse clicks from being processed
    	SetTimer(0.2, false);
    }

    function StartSlideshow()
    {
    	//Log("Starting slideshow");
    	currentImageIndex = 0;
    	if (imageList.Length == 0)
    	{
    		Log("Slideshow warning:  there are no images to show in the slideshow");
    		return;
    	}

    	slideshowImage.Image = imageList[0];
    	if (imageDelay > 0)
    		SetTimer(imageDelay, false);
    }

    function EndSlideshow()
    {
    	//Log("Ending slideshow");
    	SetTimer(0, false);

    	if (!bDontQuitOnClick)
    		Controller.CloseMenu();

    	OnSlideshowEnd();
    }

    function OnSlideShowEnd()
    {
    	// Overridden
    }

    function AdvanceSlideshow()
    {
    	//Log("Advancing slideshow");
    	if (!advanceImage())
    	{
    		EndSlideshow();
    	}

    	// Set timer again if applicable
    	if (imageDelay > 0)
    		SetTimer(imageDelay, false);
    }

    event Timer()
    {
    	numTicks++;

    	if (numTicks < 2)
    	{
    		setTimer(0.2);
    		return;
    	}

    	if (!bActivated)
    	{
    		bActivated = true;
    		bAcceptsInput = true;
    		slideshowImage.bAcceptsInput=true;
    		slideshowImage.bCaptureMouse=true;
    		StartSlideshow();
    	}
    	else
    		AdvanceSlideshow();
    }

    function bool InternalOnKeyEvent(out byte Key, out byte State, float delta)
    {
    	if (!bActivated || numTicks < 2)
    		return true;

    	if (bDontQuitOnClick)
    		return false;

        if( bVisible && bActiveInput && State == EInputAction.IST_Press && (Key == EInputKey.IK_Escape))
        {
    		AdvanceSlideshow();
            return true;
        }
        return false;
    }

    function OnSlideshowClick(GUIComponent Sender)
    {
    	if (!bActivated || numTicks < 2)
    		return;

    	if (bAllowClickToAdvance)
    		AdvanceSlideshow();
    }

    function bool advanceImage()
    {
    	currentImageIndex++;
    	//Log("CurrentImageIndex set to "$currentImageIndex$" with imageList.Length set to "$imageList.Length);
    	if (currentImageIndex >= imageList.Length)
    		return false;

    	slideshowImage.Image = imageList[currentImageIndex];
    	return true;
    }

    function bool isLastSlide()
    {
    	return currentImageIndex == imageList.Length - 1;
    }

    defaultproperties
    {
    	imageDelay=6
    	bHideMouseCursor=true
    	bAcceptsInput=false
    }

Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

Class file time: st 16.4.2014 10:20:44.000 - Creation time: st 23.5.2018 00:10:48.836 - Created with UnCodeX