Examples.SceneLoader Class Reference

Dynamic scene loader. More...

Inherits Node.

Public Member Functions
delegate void	ScenesLoaded ()
	Signal sent when all scenes are loaded More...
List< string >	GetCurrentChapterSampleNames ()
	Get current chapter sample names. More...
int	GetCurrentChapterSamplesCount ()
	Get current chapter sample count. More...
List< string >	GetChapterNames ()
	Get chapter names. More...
PackedScene	GetCurrentSample ()
	Get current sample scene. More...
void	SetCurrentSample (string name)
	Set current sample from name. More...
void	SetCurrentChapter (string name)
	Set current chapter from name. More...
int	GetNextSampleId ()
	Get next sample index. Returns '-1' if next sample does not exist. More...
int	GetPrevSampleId ()
	Get previous sample index. Returns '-1' if previous sample does not exist. More...
int	GetNextChapterId ()
	Get next chapter index. Returns '-1' if next chapter does not exist. More...
int	GetPrevChapterId ()
	Get previous chapter index. Returns '-1' if previous chapter does not exist. More...

Static Public Attributes
const int	SampleNameMaxLength = 30
	Sample name max length More...

Detailed Description

Dynamic scene loader.

Definition at line 10 of file SceneLoader.cs.

Member Function Documentation

GetChapterNames()

List<string> Examples.SceneLoader.GetChapterNames ( )

inline

Get chapter names.

Returns

Chapter names

Definition at line 71 of file SceneLoader.cs.

        {
            return chaptersList;
        }

GetCurrentChapterSampleNames()

List<string> Examples.SceneLoader.GetCurrentChapterSampleNames ( )

inline

Get current chapter sample names.

Returns

Sample names

Definition at line 41 of file SceneLoader.cs.

        {
            if (currentChapter != "")
            {
                return scenesList[currentChapter];
            }
            else
            {
                return new List<string>();
            }
        }

GetCurrentChapterSamplesCount()

int Examples.SceneLoader.GetCurrentChapterSamplesCount ( )

inline

Get current chapter sample count.

Returns

Sample count

Definition at line 57 of file SceneLoader.cs.

        {
            if (currentChapter != "")
            {
                return scenesDict[currentChapter].Count;
            }
 
            return -1;
        }

GetCurrentSample()

PackedScene Examples.SceneLoader.GetCurrentSample ( )

inline

Get current sample scene.

Returns

Sample scene

Definition at line 80 of file SceneLoader.cs.

        {
            if (currentChapter != "" && currentScene != "")
            {
                return scenesDict[currentChapter][currentScene];
            }
 
            return null;
        }

GetNextChapterId()

int Examples.SceneLoader.GetNextChapterId ( )

inline

Get next chapter index. Returns '-1' if next chapter does not exist.

Returns

Chapter index

Definition at line 159 of file SceneLoader.cs.

        {
            if (currentChapter != "")
            {
                int chapPos = chaptersList.IndexOf(currentChapter);
                if (chapPos == chaptersList.Count - 1)
                {
                    return 0;
                }
                else
                {
                    return chapPos + 1;
                }
            }
 
            return -1;
        }

GetNextSampleId()

int Examples.SceneLoader.GetNextSampleId ( )

inline

Get next sample index. Returns '-1' if next sample does not exist.

Returns

Sample index

Definition at line 113 of file SceneLoader.cs.

        {
            if (currentChapter != "" && currentScene != "")
            {
                var scenePos = scenesList[currentChapter].IndexOf(currentScene);
                if (scenePos == scenesList[currentChapter].Count - 1)
                {
                    return -1;
                }
                else
                {
                    return scenePos + 1;
                }
            }
 
            return -1;
        }

GetPrevChapterId()

int Examples.SceneLoader.GetPrevChapterId ( )

inline

Get previous chapter index. Returns '-1' if previous chapter does not exist.

Returns

Chapter index

Definition at line 182 of file SceneLoader.cs.

        {
            if (currentChapter != "")
            {
                int chapPos = chaptersList.IndexOf(currentChapter);
                if (chapPos == 0)
                {
                    return chaptersList.Count - 1;
                }
                else
                {
                    return chapPos - 1;
                }
            }
 
            return -1;
        }

GetPrevSampleId()

int Examples.SceneLoader.GetPrevSampleId ( )

inline

Get previous sample index. Returns '-1' if previous sample does not exist.

Returns

Sample index

Definition at line 136 of file SceneLoader.cs.

        {
            if (currentChapter != "" && currentScene != "")
            {
                var scenePos = scenesList[currentChapter].IndexOf(currentScene);
                if (scenePos == 0)
                {
                    return -1;
                }
                else
                {
                    return scenePos - 1;
                }
            }
 
            return -1;
        }

ScenesLoaded()

delegate void Examples.SceneLoader.ScenesLoaded

(

)

Signal sent when all scenes are loaded

SetCurrentChapter()

void Examples.SceneLoader.SetCurrentChapter ( string  name )

inline

Set current chapter from name.

Parameters

name	Chapter name

Definition at line 103 of file SceneLoader.cs.

        {
            currentChapter = name;
        }

SetCurrentSample()

void Examples.SceneLoader.SetCurrentSample ( string  name )

inline

Set current sample from name.

Parameters

name	Sample name

Definition at line 94 of file SceneLoader.cs.

        {
            currentScene = name;
        }

Member Data Documentation

SampleNameMaxLength

const int Examples.SceneLoader.SampleNameMaxLength = 30

static

Sample name max length

Definition at line 18 of file SceneLoader.cs.

---

The documentation for this class was generated from the following file:

• chapters/SceneLoader.cs