package
0.0.0-20231019115643-d76522940a9b
Repository: https://github.com/alacrity-engine/core.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

No description provided by the author
AddScene adds a new scene to the buffer.
No description provided by the author
CurrentScene returns the scene currently being played by the engine.
NewErrorIncorrectSceneLoader returns a new error when the plugin doesn't have a correct scene loader function.
NewErrorLoaderAlreadyExists creates a new error that is returned when the scene already has a loader under the specidied name.
NewErrorObjectAlreadyNotDestroyedOnSceneSwitch creates a new error that is returned when the caller tried to set the object to be not destroyed on scene switch but it has been done already.
NewErrorSceneAlreadyExists creates a new error that is returned when the scene with the specified name is already loaded and exists in the system.
NewErrorSceneDoesntExist creates a new error that is returned when the scene under the specified name is not loaded and doesn't exist in the system.
NewGameObject creates a new game object with no components.
NewScene creates a new scene to place game objects onto.
RaiseErrorNoComponentOnGameObject returns a new error about absence of the component on the game object.
RaiseErrorNoGameObjectOnScene returns a new error about absence of the game object on the scene.
RaiseErrorWrongComponentType returns a new error about wrong type assertion of the component.
RemoveScene removes the existing scene from the buffer.
RegisterScene registers all the components of the scene scripts.
StartLoadingScene starts an asynchronous process of loading a new scene.

# Structs

BaseComponent is the base type to be included into any component.
ComponentTypeEntry contains the info about the game component type.
ComponentTypeFieldEntry contains the info about the component's fields.
ErrorIncorrectSceneLoader is returned when the plugin doesn't have a correct scene loader function.
ErrorLoaderAlreadyExists is returned when the scene already has a loader under the specidied name.
ErrorNoComponentOnGameObject is returned when there is no component with certain name on the game object.
ErrorNoGameObjectOnScene is returned when there is no game object with certain name on the scene.
ErrorObjectAlreadyNotDestroyedOnSceneSwitch is returned when the caller tried to set the object to be not destroyed on scene switch but it has been done already.
ErrorSceneAlreadyExists is returned when the scene with the specified name is already loaded and exists in the system.
ErrorSceneDoesntExist is returned when the scene under the specified name is not loaded and doesn't exist in the system.
ErrorWrongComponentType is returned when the component is not of the type it should be.
GameObject represents a single object in the game world which contains components to be updated once per frame.
Scene is a collection of game objects to be updated and drawn.

# Interfaces

Component is a single script which contains data and instructions.
No description provided by the author
No description provided by the author
System stores data shared between its components.