Package org.godot.utilities.project

Class Project

java.lang.Object

org.godot.utilities.core.io.DirectoryResource

org.godot.utilities.project.BaseProject

org.godot.utilities.project.Project

All Implemented Interfaces:

IResolver, IResource, IProjectInfo

public final class Project
extends BaseProject
implements IProjectInfo

Field Summary

Fields inherited from class org.godot.utilities.project.BaseProject

projectFile, projectVersion

Fields inherited from class org.godot.utilities.core.io.DirectoryResource

location

Constructor Summary

Constructors

Constructor	Description
Project(@NotNull Path l)	Project without version.
Project(@NotNull Path l, @NotNull Version v)	Project constructor.

Method Summary

Modifier and Type	Method	Description
Ini	getConfig()	Get current project config
@Nullable Scene	getMainScene()	Get project main scene.
@Nullable String	getProjectDescription()	Get project description.
@Nullable ProjectResource	getProjectIcon()	Get project icon.
@Nullable String	getProjectName()	Get project title name.
@Nullable VideoDriver	getProjectVideoDriver()	Get current project video driver.
SceneInspector	getSceneInspector()	Get current scene inspector
@NotNull String	toString()	Object string representation

Methods inherited from class org.godot.utilities.core.io.DirectoryResource

getResourcePath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.godot.utilities.core.io.IResolver

resolvePath, resolveResource

Methods inherited from interface org.godot.utilities.core.io.IResource

exists

Constructor Detail

Project

public Project(@NotNull
               @NotNull Path l,
               @NotNull
               @NotNull Version v)
        throws IOException

Project constructor.

Parameters:

l - Project location

v - Project version

Throws:

IOException - Error if location not exists or is not valid directory

Project

public Project(@NotNull
               @NotNull Path l)
        throws IOException

Project without version. Use recommended version.

Parameters:

l - Project location

Throws:

IOException - Error if location not exists or is not valid directory

Method Detail

getConfig

public Ini getConfig()

Get current project config

Returns:

Return all project configuration

getSceneInspector

public SceneInspector getSceneInspector()

Get current scene inspector

Returns:

Return a scene inspector

getProjectName

@Contract(pure=true)
@Nullable
public @Nullable String getProjectName()

Get project title name.

This name is defined in "project.godot" or "engine.cfg", it depends on the version

Specified by:

getProjectName in interface IProjectInfo

Returns:

Project title name

getProjectDescription

@Contract(pure=true)
@Nullable
public @Nullable String getProjectDescription()

Get project description.

Specified by:

getProjectDescription in interface IProjectInfo

Returns:

Project description or null if property is not defined

getMainScene

@Nullable
public @Nullable Scene getMainScene()

Get project main scene. This is useful when you can run the project.

Specified by:

getMainScene in interface IProjectInfo

Returns:

Returns a special godot location or null if property is not defined.

getProjectIcon

@Nullable
public @Nullable ProjectResource getProjectIcon()

Get project icon.

Specified by:

getProjectIcon in interface IProjectInfo

Returns:

Return a special godot location or null if property is not defined.

getProjectVideoDriver

@Nullable
public @Nullable VideoDriver getProjectVideoDriver()

Get current project video driver.

This is useful if you want to change before to launch.

Specified by:

getProjectVideoDriver in interface IProjectInfo

Returns:

Return a project driver or null if property is not defined

toString

@Contract(pure=true)
@NotNull
public @NotNull String toString()

Object string representation

Overrides:

toString in class BaseProject

Returns:

Object string representation