I3DHError.h File Reference

I3DHError.h File Reference#

instant3Dhub: I3DHError.h File Reference

instant3Dhub

#include "CoreMinimal.h"
#include "I3DHError.generated.h"

Include dependency graph for I3DHError.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Detailed Description

Copyright: (C) Threedy GmbH

Enumerations

enum class EI3DHErrorCode : uint32 {
Success = 0 , InvalidObjectId = 1 , InvalidProperty = 2 , InvalidValueType = 3 ,
InvalidValue = 4 , PropertyNotSet = 5 , NoSessionConnection = 6 , SerializationError = 0x00010000 ,
JavascriptError = 0x00010000 + 1 , Aborted = 0x00010000 + 2 , NotImplementedInBackend = 0x00010000 + 3 , ActorSpawnError = 0x00010000 + 4 ,
NotSupportedOnCurrentHubVersion = 0x00010000 + 5 , SpaceAlreadyExists = 0x00010000 + 6 , InternalError01 = 0x00020000 , InternalError02 ,
InternalError03 , InternalError04 , InternalError05 , InternalError06 ,
InternalError07 , InternalError08 , InternalError09 , InternalError10 ,
InternalError11 , InternalError12 , InternalError13 , InternalError14 ,
InternalError15 , InternalError16 , UnknownError = 0x80000000
}

Functions
FString	I3DHStringFromErrorCode (EI3DHErrorCode ErrorCode)

Enumeration Type Documentation

◆ EI3DHErrorCode

enum class EI3DHErrorCode : uint32

strong

Enumeration of Error Codes returned from various instant3Dhub API Calls.

Enumerator
Success	Success. Operation was successful.
InvalidObjectId	Invalid object Identifier.
InvalidProperty	Invalid property.
InvalidValueType	Invalid value type.
InvalidValue	Invalid value.
PropertyNotSet	Property not set.
NoSessionConnection	No session connection.
SerializationError	Serialization error.
JavascriptError	Operation failed because of a JavaScript error. See log file for more information.
Aborted	Operation was aborted. Status is unknown (e.g. commands may have already been sent to the session), but should be treated like the operation failed if necessary. Typically caused by disconnection.
NotImplementedInBackend	Operation is not implemented in the active backend.
ActorSpawnError	Failed to spawn an actor. Check the Unreal logs for details. If a ClassOverride was specified, check that the class is valid and spawnable.
NotSupportedOnCurrentHubVersion	Operation is not supported on the version of the instant3Dhub to which we are currently connected. Please check the documentation for compatibility notes.
SpaceAlreadyExists	Operation failed because a 3D space with the given ID already exists. See also FI3DHSpaceAPI::CloneIntoNewSpace
UnknownError	Unknown error.

Function Documentation

◆ I3DHStringFromErrorCode()

FString I3DHStringFromErrorCode ( EI3DHErrorCode ErrorCode )

Converts an ErrorCode to a human-readable String.

Parameters

ErrorCode The error code.

Returns: String of the ErrorCode.