NutshellEngine
Table of Contents
Starting with NutshellEngine
As a game developer
If you don’t use Windows or Linux
As an engine developer
Contribute to NutshellEngine
Developing your own modules
Scripting
Scripting Basics
Scripting API
Resources
Scenes
Entity-Component-System
Input
Windows
Graphics
Physics
Audio
Animation
User Interface
Frame Limiter
Job System
Networking
Scripting
Profiling
Module
Asset Loader Module
Audio Module
Graphics Module
Physics Module
Window Module
Asset Loader Module
Audio Module
Graphics Module
Physics Module
Window Module
Entity-Component-System
Entity
Creation
Destruction
Name
Persistence
Component
System
Asset Manager
Frame Limiter
Job System
Networking
Scene
File Formats
.ntim - Image
.ntmh - Mesh
.ntsp - Image Sampler
.ntml - Material
.ntmd - Model
.ntsd - Sound
.ntop - Options
.ntsn - Scene
Types
Animation
Variables
AnimationChannel
Variables
AnimationChannelInterpolationType
Declaration
Notes
AnimationChannelKeyframe
Variables
AnimationChannelTransformType
Declaration
Notes
AssetLoaderModuleInterface
Variables
Functions
loadSound
loadModel
loadMaterial
loadImage
loadFont
AssetManager
Functions
createModel
loadModel
createImage
loadImage
createMaterial
loadMaterial
createFont
loadFont
createSound
loadSound
destroyModel
destroyMaterial
destroyImage
destroyFont
destroySound
findModelByName
getModelName
findMaterialByName
getMaterialName
findImageByName
getImageName
findFontByName
getFontName
findSoundByName
getSoundName
calculateTangents
calculateAABB
AssetManagerInterface
Functions
createModel
loadModel
createImage
loadImage
createMaterial
loadMaterial
createFont
loadFont
createSound
loadSound
destroyModel
destroyMaterial
destroyImage
destroyFont
destroySound
findModelByName
getModelName
findMaterialByName
getMaterialName
findImageByName
getImageName
findFontByName
getFontName
findSoundByName
getSoundName
calculateTangents
calculateAABB
AudioModuleInterface
Functions
load
playSound
playSoundAtPosition
resumeSoundSource
pauseSoundSource
stopSoundSource
getSoundSourceState
isSoundPlaying
setSoundSourcePosition
getSoundSourcePosition
setSoundSourceGain
getSoundSourceGain
setSoundSourcePitch
getSoundSourcePitch
Bimap
Functions
erase
exist
insert_or_assign
operator[]
size
BlockSuballocator
Functions
BlockSuballocator
addBlock
freeBlock
Buffer
Functions
Buffer
operator=
write
read
setCursorPosition
getData
getSize
Camera
Variables
Notes
CameraProjectionType
Declaration
Notes
ClientSocket
Functions
connectToServer
sendDataToServer
setServerDisconnectCallback
setDataReceivedCallback
getConnectedServer
ClientSocketInterface
Functions
connectToServer
sendDataToServer
setServerDisconnectCallback
setDataReceivedCallback
getConnectedServer
Collidable
Variables
Notes
ColliderBox
Variables
Notes
ColliderCapsule
Variables
Notes
ColliderShape
Declaration
Functions
Notes
getType
ColliderShapeType
Declaration
Notes
ColliderSphere
Variables
Notes
CollisionInfo
Variables
Component
Declaration
ConnectedClient
Variables
ConnectedClientID
Declaration
ConnectedServer
Variables
ECS
Functions
createEntity
destroyEntity
destroyAllEntities
destroyNonPersistentEntities
entityExists
setEntityName
entityHasName
getEntityName
findEntityByName
setEntityPersistence
isEntityPersistent
addEntityToEntityGroup
removeEntityFromEntityGroup
entityGroupExists
isEntityInEntityGroup
getEntitiesInEntityGroup
getEntityGroupsOfEntity
ECSInterface
Functions
createEntity
destroyEntity
destroyAllEntities
destroyNonPersistentEntities
entityExists
setEntityName
entityHasName
getEntityName
findEntityByName
setEntityPersistence
isEntityPersistent
addEntityToEntityGroup
removeEntityFromEntityGroup
entityGroupExists
isEntityInEntityGroup
getEntitiesInEntityGroup
getEntityGroupsOfEntity
addComponent
removeComponent
hasComponent
getComponent
getComponentID
Entity
Declaration
File
Functions
readAscii
readUtf8
readBinary
writeAscii
writeBinary
filename
extension
directory
Font
Variables
FontGlyph
Variables
FontID
Declaration
Notes
FrameLimiter
Functions
getMaxFPS
setMaxFPS
FrameLimiterInterface
Functions
getMaxFPS
setMaxFPS
GamepadID
Declaration
Notes
GraphicsModuleInterface
Functions
load
setBackgroundColor
playAnimation
pauseAnimation
stopAnimation
setAnimationCurrentTime
isAnimationPlaying
emitParticles
destroyParticles
drawUIText
drawUILine
drawUIRectangle
drawUIImage
Image
Declaration
Variables
ImageColorSpace
Declaration
ImageFormat
Declaration
ImageID
Declaration
Notes
ImageSampler
Variables
ImageSamplerAddressMode
Declaration
ImageSamplerBorderColor
Declaration
ImageSamplerFilter
Declaration
InputGamepadButton
Declaration
Notes
InputGamepadStick
Declaration
InputKeyboardKey
Declaration
InputMouseButton
Declaration
InputState
Declaration
Notes
IntersectionInformation
Variables
JobDispatchArguments
Variables
JobSystem
Functions
execute
dispatch
isBusy
wait
getNumThreads
JobSystemInterface
Functions
execute
dispatch
isBusy
wait
getNumThreads
Joint
Variables
JSON
Functions
Static Functions
read
to_string
JSON::Node
JSON::Type
Light
Variables
Notes
LightType
Declaration
Notes
Material
Variables
Math
Mesh
Variables
MeshID
Declaration
Notes
MeshTopology
Declaration
Model
Variables
ModelPrimitive
Variables
ModuleInterface
Variables
Functions
Notes
ModuleInterface
getType
getName
ModuleType
Declaration
NativeWindowAdditionalInformation
Declaration
Notes
NativeWindowHandle
Declaration
Notes
Networking
Functions
createServerSocket
createClientSocket
closeServerSocket
closeClientSocket
NetworkingInterface
Functions
createServerSocket
createClientSocket
closeServerSocket
closeClientSocket
NetworkType
Declaration
Octree
Functions
Octree
execute
insert
Octree::Entry
ParticleEmitter
Variables
PhysicsModuleInterface
Functions
intersect
raycast
raycastAll
setConstantForces
getConstantForces
Profiler
Functions
start
getResults
end
isRunning
startBlock
endBlock
ProfilerInterface
Functions
start
getResults
end
isRunning
startBlock
endBlock
ProfilerResultNode
Variables
Static Functions
to_string
RaycastInformation
Variables
Notes
Renderable
Variables
Notes
Rigidbody
Variables
Notes
SceneManager
Functions
goToScene
getCurrentScenePath
SceneManagerInterface
Functions
goToScene
getCurrentScenePath
Script
Variables
Functions
init
update
destroy
goToScene
getCurrentScenePath
createEntity
destroyEntity
destroyAllEntities
destroyNonPersistentEntities
entityExists
setEntityName
entityHasName
getEntityName
findEntityByName
setEntityPersistence
isEntityPersistent
addEntityToEntityGroup
removeEntityFromEntityGroup
entityGroupExists
isEntityInEntityGroup
getEntitiesInEntityGroup
getEntityGroupsOfEntity
addEntityComponent
removeEntityComponent
hasEntityComponent
getEntityComponent
createModel
loadModel
getMeshID
destroyModel
findModelByName
getModelName
createMaterial
loadMaterial
destroyMaterial
findMaterialByName
getMaterialName
createImage
loadImage
getImageID
destroyImage
findImageByName
getImageName
createFont
loadFont
getFontID
destroyFont
findFontByName
getFontName
createSound
loadSound
getSoundID
destroySound
findSoundByName
getSoundName
getKeyState
getMouseButtonState
setCursorPosition
getCursorPositionX
getCursorPositionY
getMouseScrollOffsetX
getMouseScrollOffsetY
setCursorVisibility
isCursorVisible
getConnectedGamepads
getGamepadButtonState
getGamepadStickAxisX
getGamepadStickAxisY
getGamepadLeftTrigger
getGamepadRightTrigger
getGamepadName
openWindow
isWindowOpen
closeWindow
getMainWindowID
windowCount
setWindowSize
getWindowWidth
getWindowHeight
setWindowPosition
getWindowPositionX
getWindowPositionY
setWindowFullscreen
isWindowFullscreen
setWindowBorderless
isWindowBorderless
setWindowResizable
isWindowResizable
setWindowOpacity
getWindowOpacity
getWindowDroppedFiles
setWindowTitle
getWindowTitle
setWindowIcon
getMonitorWidth
getMonitorHeight
getMonitorRefreshRate
getMonitorDisplayScaling
setBackgroundColor
emitParticles
destroyParticles
playSound
playSoundAtPosition
resumeSoundSource
pauseSoundSource
stopSoundSource
getSoundSourceState
isSoundPlaying
setSoundSourcePosition
getSoundSourcePosition
setSoundSourceGain
getSoundSourceGain
setSoundSourcePitch
getSoundSourcePitch
intersect
raycast
raycastAll
setConstantForces
getConstantForces
playAnimation
pauseAnimation
stopAnimation
setAnimationCurrentTime
isAnimationPlaying
drawUIText
drawUILine
drawUIRectangle
drawUIImage
setMaxFPS
getMaxFPS
executeJob
dispatchJob
waitAllThreads
getNumThreads
createServerSocket
createClientSocket
closeServerSocket
closeClientSocket
createScript
startProfiling
getProfilingResults
endProfiling
isProfilerRunning
startProfilingBlock
endProfilingBlock
Scriptable
Variables
Notes
ScriptBase
Functions
onCollisionEnter
onCollisionStill
onCollisionExit
ServerSocket
Functions
sendDataToClient
setClientConnectCallback
setClientDisconnectCallback
setDataReceivedCallback
getPort
getConnectedClients
ServerSocketInterface
Functions
sendDataToClient
setClientConnectCallback
setClientDisconnectCallback
setDataReceivedCallback
getPort
getConnectedClients
Skin
Variables
Socket
Declaration
Sound
Variables
SoundID
Declaration
Notes
SoundListener
Variables
Notes
SoundSourceID
Declaration
Notes
SoundSourceState
Declaration
Notes
System
Variables
Functions
Notes
onEntityComponentAdded
onEntityComponentRemoved
SystemModuleInterface
Variables
Functions
init
update
destroy
getComponentMask
Texture
Variables
ThreadSafeQueue
Functions
push_back
pop_front
Transform
Variables
Notes
Vertex
Variables
WindowID
Declaration
Notes
WindowModuleInterface
Functions
openWindow
isWindowOpen
closeWindow
getMainWindowID
windowCount
setWindowSize
getWindowWidth
getWindowHeight
setWindowPosition
getWindowPositionX
getWindowPositionY
setWindowFullscreen
isWindowFullscreen
setWindowBorderless
isWindowBorderless
setWindowResizable
isWindowResizable
setWindowOpacity
getWindowOpacity
getWindowDroppedFiles
pollEvents
setWindowTitle
getWindowTitle
setWindowIcon
getKeyState
getMouseButtonState
setCursorPosition
getCursorPositionX
getCursorPositionY
getMouseScrollOffsetX
getMouseScrollOffsetY
setCursorVisibility
isCursorVisible
getConnectedGamepads
getGamepadButtonState
getGamepadStickAxisX
getGamepadStickAxisY
getGamepadLeftTrigger
getGamepadRightTrigger
getGamepadName
getMonitorWidth
getMonitorHeight
getMonitorRefreshRate
getMonitorDisplayScaling
getWindowNativeHandle
getWindowNativeAdditionalInformation
NutshellEngine
Types
NetworkType
View page source
NetworkType
Declaration
enum
class
NetworkType
{
UDP
,
TCP
};