connected-spaces-platform.web 5.7.0 → 5.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Debug/ConnectedSpacesPlatform_WASM.js +229 -31
- package/Debug/ConnectedSpacesPlatform_WASM.wasm +0 -0
- package/Debug/ConnectedSpacesPlatform_WASM.wasm.debug.wasm +0 -0
- package/README.md +1 -1
- package/Release/ConnectedSpacesPlatform_WASM.js +1 -1
- package/Release/ConnectedSpacesPlatform_WASM.wasm +0 -0
- package/connectedspacesplatform.d.ts +717 -163
- package/connectedspacesplatform.js +2243 -1171
- package/connectedspacesplatform.js.map +1 -1
- package/connectedspacesplatform.ts +4376 -2449
- package/package.json +1 -1
|
@@ -205,7 +205,7 @@ export declare namespace Multiplayer {
|
|
|
205
205
|
Vector3 = 5,
|
|
206
206
|
Vector4 = 6,
|
|
207
207
|
Vector2 = 7,
|
|
208
|
-
|
|
208
|
+
StringMap = 8
|
|
209
209
|
}
|
|
210
210
|
}
|
|
211
211
|
export declare namespace Multiplayer {
|
|
@@ -283,7 +283,8 @@ export declare namespace Multiplayer {
|
|
|
283
283
|
IsARVisible = 11,
|
|
284
284
|
ThirdPartyComponentRef = 12,
|
|
285
285
|
IsShadowCaster = 13,
|
|
286
|
-
|
|
286
|
+
MaterialOverrides = 14,
|
|
287
|
+
Num = 15
|
|
287
288
|
}
|
|
288
289
|
}
|
|
289
290
|
export declare namespace Multiplayer {
|
|
@@ -782,7 +783,8 @@ export declare namespace Multiplayer {
|
|
|
782
783
|
IsARVisible = 7,
|
|
783
784
|
ThirdPartyComponentRef = 8,
|
|
784
785
|
IsShadowCaster = 9,
|
|
785
|
-
|
|
786
|
+
MaterialOverrides = 10,
|
|
787
|
+
Num = 11
|
|
786
788
|
}
|
|
787
789
|
}
|
|
788
790
|
export declare namespace Multiplayer {
|
|
@@ -944,7 +946,8 @@ export declare namespace Systems {
|
|
|
944
946
|
HOLOCAP_VIDEO = 6,
|
|
945
947
|
HOLOCAP_AUDIO = 7,
|
|
946
948
|
AUDIO = 8,
|
|
947
|
-
GAUSSIAN_SPLAT = 9
|
|
949
|
+
GAUSSIAN_SPLAT = 9,
|
|
950
|
+
MATERIAL = 10
|
|
948
951
|
}
|
|
949
952
|
}
|
|
950
953
|
export declare namespace Systems {
|
|
@@ -961,6 +964,36 @@ export declare namespace Systems {
|
|
|
961
964
|
SPACE_THUMBNAIL = 4
|
|
962
965
|
}
|
|
963
966
|
}
|
|
967
|
+
export declare namespace Systems {
|
|
968
|
+
/**
|
|
969
|
+
* @description Defines how to alpha value is interpreted
|
|
970
|
+
* The alpha value is taken from the fourth component of the base color for metallic-roughness material model
|
|
971
|
+
*/
|
|
972
|
+
enum EAlphaMode {
|
|
973
|
+
Opaque = 0,
|
|
974
|
+
Mask = 1,
|
|
975
|
+
Blend = 2
|
|
976
|
+
}
|
|
977
|
+
}
|
|
978
|
+
export declare namespace Systems {
|
|
979
|
+
/**
|
|
980
|
+
* @description Enum representing the shader type of a material. Currently not in use.
|
|
981
|
+
*/
|
|
982
|
+
enum EShaderType {
|
|
983
|
+
Standard = 0
|
|
984
|
+
}
|
|
985
|
+
}
|
|
986
|
+
export declare namespace Systems {
|
|
987
|
+
/**
|
|
988
|
+
* @description Enum representing the source type of the texture
|
|
989
|
+
* If Component is set, the data of the texture comes from the specified media component
|
|
990
|
+
* If ImageAsset is set, th data of the texture comes from the specified asset
|
|
991
|
+
*/
|
|
992
|
+
enum ETextureResourceType {
|
|
993
|
+
Component = 0,
|
|
994
|
+
ImageAsset = 1
|
|
995
|
+
}
|
|
996
|
+
}
|
|
964
997
|
export declare namespace Systems {
|
|
965
998
|
/**
|
|
966
999
|
@ingroup Event Ticketing System
|
|
@@ -3709,6 +3742,47 @@ export declare namespace Multiplayer {
|
|
|
3709
3742
|
setComponentName(value: string): void;
|
|
3710
3743
|
}
|
|
3711
3744
|
}
|
|
3745
|
+
export declare namespace Multiplayer {
|
|
3746
|
+
/**
|
|
3747
|
+
@ingroup Multiplayer
|
|
3748
|
+
* @description Handling of all network events.
|
|
3749
|
+
*/
|
|
3750
|
+
class EventBus extends NativeClassWrapper {
|
|
3751
|
+
/** @internal */
|
|
3752
|
+
constructor(pointer: NativePointer);
|
|
3753
|
+
/**
|
|
3754
|
+
* @description Sends a network event by EventName to all currently connected clients.
|
|
3755
|
+
* @param eventName - The identifying name for the event.
|
|
3756
|
+
* @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
|
|
3757
|
+
* @param callback - A callback with failure state.
|
|
3758
|
+
*/
|
|
3759
|
+
sendNetworkEvent(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>): Promise<Multiplayer.ErrorCode>;
|
|
3760
|
+
/**
|
|
3761
|
+
* @description Sends a network event by EventName, to TargetClientId.
|
|
3762
|
+
* @param eventName - The identifying name for the event.
|
|
3763
|
+
* @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
|
|
3764
|
+
* @param targetClientId - The client ID to send the event to.
|
|
3765
|
+
* @param callback - A callback with failure state.
|
|
3766
|
+
*/
|
|
3767
|
+
sendNetworkEventToClient(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>, targetClientId: bigint): Promise<Multiplayer.ErrorCode>;
|
|
3768
|
+
/**
|
|
3769
|
+
* @description Registers a callback to listen for the named event
|
|
3770
|
+
* @param eventName - The identifying name for the event to listen for.
|
|
3771
|
+
* @param callback - A callback to register for the event which contains the parameter payload data.
|
|
3772
|
+
*/
|
|
3773
|
+
listenNetworkEvent(eventName: string, callback: (arg1: boolean, arg2: Common.Array<Multiplayer.ReplicatedValue>) => void): void;
|
|
3774
|
+
/**
|
|
3775
|
+
* @description Stops the event bus from listening for a particular event, for any system or callback
|
|
3776
|
+
* @description that were registered.
|
|
3777
|
+
* @param eventName - The identifying name for the event to stop listening for.
|
|
3778
|
+
*/
|
|
3779
|
+
stopListenNetworkEvent(eventName: string): void;
|
|
3780
|
+
/**
|
|
3781
|
+
* @description Instructs the event bus to start listening to messages
|
|
3782
|
+
*/
|
|
3783
|
+
startEventMessageListening(): void;
|
|
3784
|
+
}
|
|
3785
|
+
}
|
|
3712
3786
|
export declare namespace Multiplayer {
|
|
3713
3787
|
/**
|
|
3714
3788
|
* @description Describes the changes an asset has undergone when the client application is connected to a space.
|
|
@@ -3794,6 +3868,20 @@ export declare namespace Multiplayer {
|
|
|
3794
3868
|
set newName(value: string);
|
|
3795
3869
|
}
|
|
3796
3870
|
}
|
|
3871
|
+
export declare namespace Multiplayer {
|
|
3872
|
+
class MaterialChangedParams extends NativeClassWrapper implements INativeResource {
|
|
3873
|
+
/** @internal */
|
|
3874
|
+
constructor(pointer: NativePointer);
|
|
3875
|
+
static create(): MaterialChangedParams;
|
|
3876
|
+
delete(): void;
|
|
3877
|
+
get materialCollectionId(): string;
|
|
3878
|
+
set materialCollectionId(value: string);
|
|
3879
|
+
get materialId(): string;
|
|
3880
|
+
set materialId(value: string);
|
|
3881
|
+
get changeType(): Multiplayer.EAssetChangeType;
|
|
3882
|
+
set changeType(value: Multiplayer.EAssetChangeType);
|
|
3883
|
+
}
|
|
3884
|
+
}
|
|
3797
3885
|
export declare namespace Multiplayer {
|
|
3798
3886
|
/**
|
|
3799
3887
|
@ingroup Multiplayer
|
|
@@ -3802,21 +3890,6 @@ export declare namespace Multiplayer {
|
|
|
3802
3890
|
class MultiplayerConnection extends NativeClassWrapper {
|
|
3803
3891
|
/** @internal */
|
|
3804
3892
|
constructor(pointer: NativePointer);
|
|
3805
|
-
/**
|
|
3806
|
-
* @description Sends a network event by EventName to all currently connected clients.
|
|
3807
|
-
* @param eventName - The identifying name for the event.
|
|
3808
|
-
* @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
|
|
3809
|
-
* @param callback - A callback with failure state.
|
|
3810
|
-
*/
|
|
3811
|
-
sendNetworkEvent(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>): Promise<Multiplayer.ErrorCode>;
|
|
3812
|
-
/**
|
|
3813
|
-
* @description Sends a network event by EventName, to TargetClientId.
|
|
3814
|
-
* @param eventName - The identifying name for the event.
|
|
3815
|
-
* @param args - An array of arguments (ReplicatedValue) to be passed as part of the event payload.
|
|
3816
|
-
* @param targetClientId - The client ID to send the event to.
|
|
3817
|
-
* @param callback - A callback with failure state.
|
|
3818
|
-
*/
|
|
3819
|
-
sendNetworkEventToClient(eventName: string, args: Common.Array<Multiplayer.ReplicatedValue>, targetClientId: bigint): Promise<Multiplayer.ErrorCode>;
|
|
3820
3893
|
/**
|
|
3821
3894
|
* @description Sets a callback for a disconnection event.
|
|
3822
3895
|
* @param callback - The callback for disconnection, contains a string with a reason for disconnection.
|
|
@@ -3833,43 +3906,6 @@ export declare namespace Multiplayer {
|
|
|
3833
3906
|
* @param callback - The callback for network interruption, contains a string showing failure.
|
|
3834
3907
|
*/
|
|
3835
3908
|
setNetworkInterruptionCallback(callback: (arg1: string) => void): void;
|
|
3836
|
-
/**
|
|
3837
|
-
* @description Sets a callback for an asset changed event.
|
|
3838
|
-
* @param callback - Callback to receive data for the asset that has been changed.
|
|
3839
|
-
*/
|
|
3840
|
-
setAssetDetailBlobChangedCallback(callback: (arg1: Multiplayer.AssetDetailBlobParams) => void): void;
|
|
3841
|
-
/**
|
|
3842
|
-
* @description Sets a callback for a conversation new message event.
|
|
3843
|
-
* @param callback - Callback to receive ConversationSystem Data when a message is sent.
|
|
3844
|
-
* Callback will have to reset the callback passed to the system to avoid "dangling objects" after use.
|
|
3845
|
-
*/
|
|
3846
|
-
setConversationSystemCallback(callback: (arg1: Multiplayer.ConversationSystemParams) => void): void;
|
|
3847
|
-
/**
|
|
3848
|
-
* @description Sets a callback for an access control changed event.
|
|
3849
|
-
* @param callback - Callback to receive data for the user permissions that has been changed.
|
|
3850
|
-
*/
|
|
3851
|
-
setUserPermissionsChangedCallback(callback: (arg1: Multiplayer.UserPermissionsParams) => void): void;
|
|
3852
|
-
/**
|
|
3853
|
-
* @description Sets a callback for a sequence changed event.
|
|
3854
|
-
* @param callback - Callback to receive data for the sequence that has been changed.
|
|
3855
|
-
*/
|
|
3856
|
-
setSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceChangedParams) => void): void;
|
|
3857
|
-
/**
|
|
3858
|
-
* @description Sets a callback to be fired when a hotspot sequence is changed.
|
|
3859
|
-
* @param callback - Callback to receive data for the hotspot sequence that has been changed.
|
|
3860
|
-
*/
|
|
3861
|
-
setHotspotSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceHotspotChangedParams) => void): void;
|
|
3862
|
-
/**
|
|
3863
|
-
* @description Registers a callback to listen for the named event.
|
|
3864
|
-
* @param eventName - The identifying name for the event to listen for.
|
|
3865
|
-
* @param callback - A callback to register for the event which contains the parameter payload data.
|
|
3866
|
-
*/
|
|
3867
|
-
listenNetworkEvent(eventName: string, callback: (arg1: boolean, arg2: Common.Array<Multiplayer.ReplicatedValue>) => void): void;
|
|
3868
|
-
/**
|
|
3869
|
-
* @description Stops the multiplayer connection from listening for a particular network event.
|
|
3870
|
-
* @param eventName - The identifying name for the event to stop listening for.
|
|
3871
|
-
*/
|
|
3872
|
-
stopListenNetworkEvent(eventName: string): void;
|
|
3873
3909
|
/**
|
|
3874
3910
|
* @description Requests the ClientID.
|
|
3875
3911
|
* @return Uint64_t the clientid for this connection.
|
|
@@ -3949,10 +3985,10 @@ export declare namespace Multiplayer {
|
|
|
3949
3985
|
*/
|
|
3950
3986
|
static create_vector4Value(vector4Value: Common.Vector4): ReplicatedValue;
|
|
3951
3987
|
/**
|
|
3952
|
-
* @description Construct a ReplicatedValue based on an csp::common::Map type.
|
|
3988
|
+
* @description Construct a ReplicatedValue based on an csp::common::Map type with a string value as the key.
|
|
3953
3989
|
* @param inMapValue - Initial value.
|
|
3954
3990
|
*/
|
|
3955
|
-
static create_mapValue(mapValue: Common.Map<
|
|
3991
|
+
static create_mapValue(mapValue: Common.Map<string, Multiplayer.ReplicatedValue>): ReplicatedValue;
|
|
3956
3992
|
/**
|
|
3957
3993
|
* @description Copy constructor
|
|
3958
3994
|
* @param other - The value to copy.
|
|
@@ -4058,15 +4094,16 @@ export declare namespace Multiplayer {
|
|
|
4058
4094
|
*/
|
|
4059
4095
|
getVector4(): Common.Vector4;
|
|
4060
4096
|
/**
|
|
4061
|
-
* @description Get a csp::common::Map value
|
|
4097
|
+
* @description Get a csp::common::Map value with a string value as the key.
|
|
4098
|
+
* This will assert if not a csp::common::Map type with a string value as the key.
|
|
4062
4099
|
* /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
|
|
4063
4100
|
* /// @return csp::common::Map
|
|
4064
4101
|
*/
|
|
4065
|
-
|
|
4102
|
+
getStringMap(): Common.Map<string, Multiplayer.ReplicatedValue>;
|
|
4066
4103
|
/**
|
|
4067
|
-
* @description Set a Map value for this replicated value from a csp::common::Map, will overwrite
|
|
4104
|
+
* @description Set a string Map value for this replicated value from a csp::common::Map, will overwrite any previous value.
|
|
4068
4105
|
*/
|
|
4069
|
-
|
|
4106
|
+
setStringMap(value: Common.Map<string, Multiplayer.ReplicatedValue>): void;
|
|
4070
4107
|
}
|
|
4071
4108
|
}
|
|
4072
4109
|
export declare namespace Multiplayer {
|
|
@@ -4650,98 +4687,6 @@ export declare namespace Multiplayer {
|
|
|
4650
4687
|
set edited(value: boolean);
|
|
4651
4688
|
}
|
|
4652
4689
|
}
|
|
4653
|
-
export declare namespace Multiplayer {
|
|
4654
|
-
/**
|
|
4655
|
-
@ingroup Conversation System
|
|
4656
|
-
* @description Public facing system that can handle conversations taking place between users of a space in the form of thread messages.
|
|
4657
|
-
*/
|
|
4658
|
-
class ConversationSystem extends NativeClassWrapper {
|
|
4659
|
-
/** @internal */
|
|
4660
|
-
constructor(pointer: NativePointer);
|
|
4661
|
-
/**
|
|
4662
|
-
* @description Constructs a conversation system instance that uses the given multiplayer connection.
|
|
4663
|
-
* @param inMultiPlayerConnection - The connection to be used.
|
|
4664
|
-
*/
|
|
4665
|
-
static create_multiPlayerConnection(multiPlayerConnection: Multiplayer.MultiplayerConnection): ConversationSystem;
|
|
4666
|
-
/**
|
|
4667
|
-
* @description Creates a new conversation with the initial message and provides the conversation ID to the given callback.
|
|
4668
|
-
* @param message - The message to be stored.
|
|
4669
|
-
* @param callback - Callback when asynchronous task finishes
|
|
4670
|
-
*/
|
|
4671
|
-
createConversation(message: string): Promise<Systems.StringResult>;
|
|
4672
|
-
/**
|
|
4673
|
-
* @description Adds a message to a brand new conversation or to an already existing one
|
|
4674
|
-
* /// Make sure that the user has entered a space through SpaceSystem::EnterSpace() before calling this.
|
|
4675
|
-
* Sends a network event acknowledgement that can be listened for called "ConversationSystem" containing:
|
|
4676
|
-
* {ConversationSystemParams of type ReplicatedType : ConversationMessageType::NewMessage, ConversationId of type ReplicatedType : String}.
|
|
4677
|
-
* /// @param ConversationId csp::common::String : A new message will be linked to the provided conversation id.
|
|
4678
|
-
* @param senderDisplayName - The display name of the message sender.
|
|
4679
|
-
* @param message - The message to be stored.
|
|
4680
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4681
|
-
*/
|
|
4682
|
-
addMessageToConversation(conversationId: string, senderDisplayName: string, message: string): Promise<Multiplayer.MessageResult>;
|
|
4683
|
-
/**
|
|
4684
|
-
* @description Retrieves messages that are linked to the provided Conversation ID.
|
|
4685
|
-
* @param conversationId - Conversation ID.
|
|
4686
|
-
* @param resultsSkipNumber - Optional parameter representing the number of result entries that will be skipped from the result.
|
|
4687
|
-
* For no skip pass nullptr.
|
|
4688
|
-
* @param resultsMaxNumber - Optional parameter representing the maximum number of result entries to be retrieved. For all
|
|
4689
|
-
* available result entries pass nullptr.
|
|
4690
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4691
|
-
*/
|
|
4692
|
-
getMessagesFromConversation(conversationId: string, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Multiplayer.MessageCollectionResult>;
|
|
4693
|
-
/**
|
|
4694
|
-
* @description Retrieves the conversation information.
|
|
4695
|
-
* @param conversationId - Conversation ID.
|
|
4696
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4697
|
-
*/
|
|
4698
|
-
getConversationInformation(conversationId: string): Promise<Multiplayer.ConversationResult>;
|
|
4699
|
-
/**
|
|
4700
|
-
* @description Sets the conversation information.
|
|
4701
|
-
* @param conversationId - Conversation ID.
|
|
4702
|
-
* @param conversationData - Conversation Data.
|
|
4703
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4704
|
-
*/
|
|
4705
|
-
setConversationInformation(conversationId: string, conversationData: Multiplayer.ConversationInfo): Promise<Multiplayer.ConversationResult>;
|
|
4706
|
-
/**
|
|
4707
|
-
* @description Retrieves one particular message.
|
|
4708
|
-
* @param messageId - ID of the message to be retrieved.
|
|
4709
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4710
|
-
*/
|
|
4711
|
-
getMessage(messageId: string): Promise<Multiplayer.MessageResult>;
|
|
4712
|
-
/**
|
|
4713
|
-
* @description Sets the message information.
|
|
4714
|
-
* @param messageId - ID of the message to be retrieved.
|
|
4715
|
-
* @param messageData - Message Data.
|
|
4716
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4717
|
-
*/
|
|
4718
|
-
setMessageInformation(messageId: string, messageData: Multiplayer.MessageInfo): Promise<Multiplayer.MessageResult>;
|
|
4719
|
-
/**
|
|
4720
|
-
* @description Retrieves the message information.
|
|
4721
|
-
* @param messageId - Message ID.
|
|
4722
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4723
|
-
*/
|
|
4724
|
-
getMessageInformation(messageId: string): Promise<Multiplayer.MessageResult>;
|
|
4725
|
-
/**
|
|
4726
|
-
* @description Deletes all the messages that are part of the conversation.
|
|
4727
|
-
* /// Sends a network event acknowledgement that can be listened for called "ConversationSystem" containing:
|
|
4728
|
-
* {ConversationSystemParams of type ReplicatedType : ConversationMessageType::DeleteConversation, ConversationId of type ReplicatedType :
|
|
4729
|
-
* String}.
|
|
4730
|
-
* /// @param ConversationId csp::common::String : ID of the conversation that will be deleted. After this operation finishes successful this ID will
|
|
4731
|
-
* not be valid anymore.
|
|
4732
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4733
|
-
*/
|
|
4734
|
-
deleteConversation(conversationId: string): Promise<Systems.NullResult>;
|
|
4735
|
-
/**
|
|
4736
|
-
* @description Deletes a particular message.
|
|
4737
|
-
* /// Sends a network event acknowledgement that can be listened for called "ConversationSystem" containing:
|
|
4738
|
-
* { ConversationSystemParams of type ReplicatedType : ConversationMessageType::DeleteMessage, MessageId of type ReplicatedType : String }.
|
|
4739
|
-
* /// @param MessageId csp::common::String : ID of the message that will be deleted.
|
|
4740
|
-
* @param callback - Callback when asynchronous task finishes.
|
|
4741
|
-
*/
|
|
4742
|
-
deleteMessage(messageId: string): Promise<Systems.NullResult>;
|
|
4743
|
-
}
|
|
4744
|
-
}
|
|
4745
4690
|
export declare namespace Multiplayer {
|
|
4746
4691
|
/**
|
|
4747
4692
|
* @description Manages the script attached to an Entity.
|
|
@@ -4833,11 +4778,28 @@ export declare namespace Multiplayer {
|
|
|
4833
4778
|
}
|
|
4834
4779
|
export declare namespace Systems {
|
|
4835
4780
|
/**
|
|
4836
|
-
* @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient instance in the constructor of each
|
|
4781
|
+
* @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient or EventBus instance in the constructor of each
|
|
4782
|
+
* System.
|
|
4837
4783
|
*/
|
|
4838
4784
|
class SystemBase extends NativeClassWrapper {
|
|
4839
4785
|
/** @internal */
|
|
4840
4786
|
constructor(pointer: NativePointer);
|
|
4787
|
+
/**
|
|
4788
|
+
* @description Destructor of the SystemBase base class.
|
|
4789
|
+
*/
|
|
4790
|
+
/**
|
|
4791
|
+
* @description Registers the system to listen for the default event.
|
|
4792
|
+
*/
|
|
4793
|
+
registerSystemCallback(): void;
|
|
4794
|
+
/**
|
|
4795
|
+
* @description Deregisters the system from listening for the default event.
|
|
4796
|
+
*/
|
|
4797
|
+
deregisterSystemCallback(): void;
|
|
4798
|
+
/**
|
|
4799
|
+
* @description Sets a callback for a default event.
|
|
4800
|
+
* @param callback - Callback to receive data for the system that has been changed.
|
|
4801
|
+
*/
|
|
4802
|
+
setSystemCallback(callback: (arg1: boolean, arg2: Common.Array<Multiplayer.ReplicatedValue>) => void): void;
|
|
4841
4803
|
}
|
|
4842
4804
|
}
|
|
4843
4805
|
export declare namespace Systems {
|
|
@@ -4941,6 +4903,7 @@ export declare namespace Systems {
|
|
|
4941
4903
|
getHotspotSequenceSystem(): Systems.HotspotSequenceSystem;
|
|
4942
4904
|
getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
|
|
4943
4905
|
getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
|
|
4906
|
+
getEventBus(): Multiplayer.EventBus;
|
|
4944
4907
|
}
|
|
4945
4908
|
}
|
|
4946
4909
|
export declare namespace Systems {
|
|
@@ -5214,10 +5177,157 @@ export declare namespace Systems {
|
|
|
5214
5177
|
constructor(pointer: NativePointer);
|
|
5215
5178
|
static create(): LODChain;
|
|
5216
5179
|
delete(): void;
|
|
5217
|
-
get assetCollectionId(): string;
|
|
5218
|
-
set assetCollectionId(value: string);
|
|
5219
|
-
get lODAssets(): Common.Array<Systems.LODAsset>;
|
|
5220
|
-
set lODAssets(value: Common.Array<Systems.LODAsset>);
|
|
5180
|
+
get assetCollectionId(): string;
|
|
5181
|
+
set assetCollectionId(value: string);
|
|
5182
|
+
get lODAssets(): Common.Array<Systems.LODAsset>;
|
|
5183
|
+
set lODAssets(value: Common.Array<Systems.LODAsset>);
|
|
5184
|
+
}
|
|
5185
|
+
}
|
|
5186
|
+
export declare namespace Systems {
|
|
5187
|
+
/**
|
|
5188
|
+
@ingroup Asset System
|
|
5189
|
+
* @description Base class for a material.
|
|
5190
|
+
*/
|
|
5191
|
+
class Material extends NativeClassWrapper implements INativeResource {
|
|
5192
|
+
/** @internal */
|
|
5193
|
+
constructor(pointer: NativePointer);
|
|
5194
|
+
/**
|
|
5195
|
+
* @description Gets the user-defined name of the material
|
|
5196
|
+
* @return Csp::common::string&
|
|
5197
|
+
*/
|
|
5198
|
+
getName(): string;
|
|
5199
|
+
/**
|
|
5200
|
+
* @description Gets the collection id for the material
|
|
5201
|
+
* @return Const csp::common::string&
|
|
5202
|
+
*/
|
|
5203
|
+
getMaterialCollectionId(): string;
|
|
5204
|
+
/**
|
|
5205
|
+
* @description Gets the id for the material
|
|
5206
|
+
* @return Const csp::common::string&
|
|
5207
|
+
*/
|
|
5208
|
+
getMaterialId(): string;
|
|
5209
|
+
/**
|
|
5210
|
+
* @description Constructor which links the material to an asset
|
|
5211
|
+
* @param name - The name of the material.
|
|
5212
|
+
* @param materialCollectionId - The asset collection where the material info is stored
|
|
5213
|
+
* @param materialId - The asset where the material info is stored
|
|
5214
|
+
*/
|
|
5215
|
+
static create_name_materialCollectionId_materialId(name: string, materialCollectionId: string, materialId: string): Material;
|
|
5216
|
+
static create(): Material;
|
|
5217
|
+
delete(): void;
|
|
5218
|
+
}
|
|
5219
|
+
}
|
|
5220
|
+
export declare namespace Systems {
|
|
5221
|
+
/**
|
|
5222
|
+
@ingroup Asset System
|
|
5223
|
+
* @description Data class which represents a texture.
|
|
5224
|
+
*/
|
|
5225
|
+
class TextureInfo extends NativeClassWrapper implements INativeResource {
|
|
5226
|
+
/** @internal */
|
|
5227
|
+
constructor(pointer: NativePointer);
|
|
5228
|
+
/**
|
|
5229
|
+
* @description Default constructor with SourceType set to ETextureResourceType::ImageAsset by default
|
|
5230
|
+
*/
|
|
5231
|
+
static create(): TextureInfo;
|
|
5232
|
+
/**
|
|
5233
|
+
* @description Constructor which associates a texture with an asset, using ETextureResourceType::ImageAsset as it's source type
|
|
5234
|
+
* @param assetCollectionId - The asset collection where the texture info is stored
|
|
5235
|
+
* @param assetId - The asset where the texture info is stored
|
|
5236
|
+
*/
|
|
5237
|
+
static create_assetCollectionId_assetId(assetCollectionId: string, assetId: string): TextureInfo;
|
|
5238
|
+
/**
|
|
5239
|
+
* @description Constructor which associates a texture with a media component, using ETextureResourceType::Component as it's source type
|
|
5240
|
+
* @param componentId - The component id used as the texture data source
|
|
5241
|
+
*/
|
|
5242
|
+
static create_componentId(componentId: string): TextureInfo;
|
|
5243
|
+
/**
|
|
5244
|
+
* @description Sets the textures asset collection id and asset id
|
|
5245
|
+
* Uses ETextureResourceType::ImageAsset as it's source type
|
|
5246
|
+
* @param assetCollectionId - The asset collection where the texture info is stored
|
|
5247
|
+
* @param assetId - The asset where the texture info is stored
|
|
5248
|
+
*/
|
|
5249
|
+
setCollectionAndAssetId(assetCollectionId: string, assetId: string): void;
|
|
5250
|
+
/**
|
|
5251
|
+
* @description Gets the asset collection id for the texture
|
|
5252
|
+
* @return Csp::common::string&
|
|
5253
|
+
*/
|
|
5254
|
+
getAssetCollectionId(): string;
|
|
5255
|
+
/**
|
|
5256
|
+
* @description Gets the asset id for the texture
|
|
5257
|
+
* @return Csp::common::string&
|
|
5258
|
+
*/
|
|
5259
|
+
getAssetId(): string;
|
|
5260
|
+
/**
|
|
5261
|
+
* @description Sets the textures entity component id
|
|
5262
|
+
* Format: {entity.id}-{component.id}
|
|
5263
|
+
* This can be obtained from ComponentBase::GetUniqueComponentId
|
|
5264
|
+
* @param componentId - Const csp::common::string&
|
|
5265
|
+
*/
|
|
5266
|
+
setEntityComponentId(componentId: string): void;
|
|
5267
|
+
/**
|
|
5268
|
+
* @description Gets the entity component id
|
|
5269
|
+
* @return Csp::common::string&
|
|
5270
|
+
*/
|
|
5271
|
+
getEntityComponentId(): string;
|
|
5272
|
+
/**
|
|
5273
|
+
* @description Gets the source type of this texture
|
|
5274
|
+
* This is set internally by constructors and SetCollectionAndAssetId/SetEntityComponentId
|
|
5275
|
+
* @return ETextureResourceType
|
|
5276
|
+
*/
|
|
5277
|
+
getSourceType(): Systems.ETextureResourceType;
|
|
5278
|
+
/**
|
|
5279
|
+
* @description Sets the uv offset of the texture
|
|
5280
|
+
* @param offset - Csp::common::vector2
|
|
5281
|
+
*/
|
|
5282
|
+
setUVOffset(offset: Common.Vector2): void;
|
|
5283
|
+
/**
|
|
5284
|
+
* @description Gets the uv offset of the texture
|
|
5285
|
+
* @return Csp::common::vector2
|
|
5286
|
+
*/
|
|
5287
|
+
getUVOffset(): Common.Vector2;
|
|
5288
|
+
/**
|
|
5289
|
+
* @description Gets the uv rotation of the texture
|
|
5290
|
+
* @param rotation - Float
|
|
5291
|
+
*/
|
|
5292
|
+
setUVRotation(rotation: number): void;
|
|
5293
|
+
/**
|
|
5294
|
+
* @description Gets the uv rotation of the texture
|
|
5295
|
+
* @return Float
|
|
5296
|
+
*/
|
|
5297
|
+
getUVRotation(): number;
|
|
5298
|
+
/**
|
|
5299
|
+
* @description Sets the uv scale of the texture
|
|
5300
|
+
* @param scale - Csp::common::vector2
|
|
5301
|
+
*/
|
|
5302
|
+
setUVScale(scale: Common.Vector2): void;
|
|
5303
|
+
/**
|
|
5304
|
+
* @description Gets the uv scale of the texture
|
|
5305
|
+
* @return Csp::common::vector2
|
|
5306
|
+
*/
|
|
5307
|
+
getUVScale(): Common.Vector2;
|
|
5308
|
+
/**
|
|
5309
|
+
* @description Sets The set index of texture's TEXCOORD attribute
|
|
5310
|
+
* used for texture coordinate mapping.
|
|
5311
|
+
* @param coord - Int
|
|
5312
|
+
*/
|
|
5313
|
+
setTexCoord(coord: number): void;
|
|
5314
|
+
/**
|
|
5315
|
+
* @description Gets the index of texture's TEXCOORD attribute
|
|
5316
|
+
* @return Int
|
|
5317
|
+
*/
|
|
5318
|
+
getTexCoord(): number;
|
|
5319
|
+
/**
|
|
5320
|
+
* @description True if this texture has been set for the current material
|
|
5321
|
+
* @return Bool
|
|
5322
|
+
*/
|
|
5323
|
+
isSet(): boolean;
|
|
5324
|
+
/**
|
|
5325
|
+
* @description Sets if this texture is active for the current material
|
|
5326
|
+
* This is true by default when a new texture is created
|
|
5327
|
+
* @param value - Bool
|
|
5328
|
+
*/
|
|
5329
|
+
setTexture(value: boolean): void;
|
|
5330
|
+
delete(): void;
|
|
5221
5331
|
}
|
|
5222
5332
|
}
|
|
5223
5333
|
export declare namespace Systems {
|
|
@@ -6293,6 +6403,25 @@ export declare namespace Multiplayer {
|
|
|
6293
6403
|
* @return The index of the currently active animation.
|
|
6294
6404
|
*/
|
|
6295
6405
|
setAnimationIndex(value: bigint): void;
|
|
6406
|
+
/**
|
|
6407
|
+
* @description Gets the material overrides of this component.
|
|
6408
|
+
* Should be in the format:
|
|
6409
|
+
* Key = Path to the model
|
|
6410
|
+
* Value = The material id
|
|
6411
|
+
* @return The material overrides on this component.
|
|
6412
|
+
*/
|
|
6413
|
+
getMaterialOverrides(): Common.Map<string, string>;
|
|
6414
|
+
/**
|
|
6415
|
+
* @description Adds a new material override to this component.
|
|
6416
|
+
* @param the - Path to the models material to override.
|
|
6417
|
+
* @param the - Id of the material to override with.
|
|
6418
|
+
*/
|
|
6419
|
+
addMaterialOverride(modelPath: string, materialAssetId: string): void;
|
|
6420
|
+
/**
|
|
6421
|
+
* @description Removes a material override from this component.
|
|
6422
|
+
* @param the - Path to the models material to override to be removed.
|
|
6423
|
+
*/
|
|
6424
|
+
removeMaterialOverride(modelPath: string): void;
|
|
6296
6425
|
/**
|
|
6297
6426
|
* \addtogroup IVisibleComponent
|
|
6298
6427
|
@{
|
|
@@ -8577,6 +8706,25 @@ export declare namespace Multiplayer {
|
|
|
8577
8706
|
* @param value - The ID of the asset collection associated with this component.
|
|
8578
8707
|
*/
|
|
8579
8708
|
setExternalResourceAssetCollectionId(value: string): void;
|
|
8709
|
+
/**
|
|
8710
|
+
* @description Gets the material overrides of this component.
|
|
8711
|
+
* Should be in the format:
|
|
8712
|
+
* Key = Path to the model
|
|
8713
|
+
* Value = The material id
|
|
8714
|
+
* @return The material overrides on this component.
|
|
8715
|
+
*/
|
|
8716
|
+
getMaterialOverrides(): Common.Map<string, string>;
|
|
8717
|
+
/**
|
|
8718
|
+
* @description Adds a new material override to this component.
|
|
8719
|
+
* @param the - Path to the models material to override.
|
|
8720
|
+
* @param the - Id of the material to override with.
|
|
8721
|
+
*/
|
|
8722
|
+
addMaterialOverride(modelPath: string, materialAssetId: string): void;
|
|
8723
|
+
/**
|
|
8724
|
+
* @description Removes a material override from this component.
|
|
8725
|
+
* @param the - Path to the models material to override to be removed.
|
|
8726
|
+
*/
|
|
8727
|
+
removeMaterialOverride(modelPath: string): void;
|
|
8580
8728
|
/**
|
|
8581
8729
|
* \addtogroup ITransformComponent
|
|
8582
8730
|
@{
|
|
@@ -9119,6 +9267,113 @@ export declare namespace Multiplayer {
|
|
|
9119
9267
|
delete(): void;
|
|
9120
9268
|
}
|
|
9121
9269
|
}
|
|
9270
|
+
export declare namespace Multiplayer {
|
|
9271
|
+
/**
|
|
9272
|
+
@ingroup Conversation System
|
|
9273
|
+
* @description Public facing system that can handle conversations taking place between users of a space in the form of thread messages.
|
|
9274
|
+
*/
|
|
9275
|
+
class ConversationSystem extends Systems.SystemBase {
|
|
9276
|
+
/** @internal */
|
|
9277
|
+
constructor(pointer: NativePointer);
|
|
9278
|
+
static fromSystemBase(baseInstance: Systems.SystemBase): Multiplayer.ConversationSystem;
|
|
9279
|
+
/**
|
|
9280
|
+
* @description Constructs a conversation system instance that uses the given multiplayer connection.
|
|
9281
|
+
* @param inMultiPlayerConnection - The connection to be used.
|
|
9282
|
+
*/
|
|
9283
|
+
static create_multiPlayerConnection(multiPlayerConnection: Multiplayer.MultiplayerConnection): ConversationSystem;
|
|
9284
|
+
/**
|
|
9285
|
+
* @description Creates a new conversation with the initial message and provides the conversation ID to the given callback.
|
|
9286
|
+
* @param message - The message to be stored.
|
|
9287
|
+
* @param callback - Callback when asynchronous task finishes
|
|
9288
|
+
*/
|
|
9289
|
+
createConversation(message: string): Promise<Systems.StringResult>;
|
|
9290
|
+
/**
|
|
9291
|
+
* @description Adds a message to a brand new conversation or to an already existing one
|
|
9292
|
+
* /// Make sure that the user has entered a space through SpaceSystem::EnterSpace() before calling this.
|
|
9293
|
+
* Sends a network event acknowledgement that can be listened for called "ConversationSystem" containing:
|
|
9294
|
+
* {ConversationSystemParams of type ReplicatedType : ConversationMessageType::NewMessage, ConversationId of type ReplicatedType : String}.
|
|
9295
|
+
* /// @param ConversationId csp::common::String : A new message will be linked to the provided conversation id.
|
|
9296
|
+
* @param senderDisplayName - The display name of the message sender.
|
|
9297
|
+
* @param message - The message to be stored.
|
|
9298
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9299
|
+
*/
|
|
9300
|
+
addMessageToConversation(conversationId: string, senderDisplayName: string, message: string): Promise<Multiplayer.MessageResult>;
|
|
9301
|
+
/**
|
|
9302
|
+
* @description Retrieves messages that are linked to the provided Conversation ID.
|
|
9303
|
+
* @param conversationId - Conversation ID.
|
|
9304
|
+
* @param resultsSkipNumber - Optional parameter representing the number of result entries that will be skipped from the result.
|
|
9305
|
+
* For no skip pass nullptr.
|
|
9306
|
+
* @param resultsMaxNumber - Optional parameter representing the maximum number of result entries to be retrieved. For all
|
|
9307
|
+
* available result entries pass nullptr.
|
|
9308
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9309
|
+
*/
|
|
9310
|
+
getMessagesFromConversation(conversationId: string, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Multiplayer.MessageCollectionResult>;
|
|
9311
|
+
/**
|
|
9312
|
+
* @description Retrieves the conversation information.
|
|
9313
|
+
* @param conversationId - Conversation ID.
|
|
9314
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9315
|
+
*/
|
|
9316
|
+
getConversationInformation(conversationId: string): Promise<Multiplayer.ConversationResult>;
|
|
9317
|
+
/**
|
|
9318
|
+
* @description Sets the conversation information.
|
|
9319
|
+
* @param conversationId - Conversation ID.
|
|
9320
|
+
* @param conversationData - Conversation Data.
|
|
9321
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9322
|
+
*/
|
|
9323
|
+
setConversationInformation(conversationId: string, conversationData: Multiplayer.ConversationInfo): Promise<Multiplayer.ConversationResult>;
|
|
9324
|
+
/**
|
|
9325
|
+
* @description Retrieves one particular message.
|
|
9326
|
+
* @param messageId - ID of the message to be retrieved.
|
|
9327
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9328
|
+
*/
|
|
9329
|
+
getMessage(messageId: string): Promise<Multiplayer.MessageResult>;
|
|
9330
|
+
/**
|
|
9331
|
+
* @description Sets the message information.
|
|
9332
|
+
* @param messageId - ID of the message to be retrieved.
|
|
9333
|
+
* @param messageData - Message Data.
|
|
9334
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9335
|
+
*/
|
|
9336
|
+
setMessageInformation(messageId: string, messageData: Multiplayer.MessageInfo): Promise<Multiplayer.MessageResult>;
|
|
9337
|
+
/**
|
|
9338
|
+
* @description Retrieves the message information.
|
|
9339
|
+
* @param messageId - Message ID.
|
|
9340
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9341
|
+
*/
|
|
9342
|
+
getMessageInformation(messageId: string): Promise<Multiplayer.MessageResult>;
|
|
9343
|
+
/**
|
|
9344
|
+
* @description Deletes all the messages that are part of the conversation.
|
|
9345
|
+
* /// Sends a network event acknowledgement that can be listened for called "ConversationSystem" containing:
|
|
9346
|
+
* {ConversationSystemParams of type ReplicatedType : ConversationMessageType::DeleteConversation, ConversationId of type ReplicatedType :
|
|
9347
|
+
* String}.
|
|
9348
|
+
* /// @param ConversationId csp::common::String : ID of the conversation that will be deleted. After this operation finishes successful this ID will
|
|
9349
|
+
* not be valid anymore.
|
|
9350
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9351
|
+
*/
|
|
9352
|
+
deleteConversation(conversationId: string): Promise<Systems.NullResult>;
|
|
9353
|
+
/**
|
|
9354
|
+
* @description Deletes a particular message.
|
|
9355
|
+
* /// Sends a network event acknowledgement that can be listened for called "ConversationSystem" containing:
|
|
9356
|
+
* { ConversationSystemParams of type ReplicatedType : ConversationMessageType::DeleteMessage, MessageId of type ReplicatedType : String }.
|
|
9357
|
+
* /// @param MessageId csp::common::String : ID of the message that will be deleted.
|
|
9358
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9359
|
+
*/
|
|
9360
|
+
deleteMessage(messageId: string): Promise<Systems.NullResult>;
|
|
9361
|
+
/**
|
|
9362
|
+
* @description Sets a callback for a conversation new message event.
|
|
9363
|
+
* @param callback - Callback to receive ConversationSystem Data when a message is sent.
|
|
9364
|
+
* Callback will have to reset the callback passed to the system to avoid "dangling objects" after use.
|
|
9365
|
+
*/
|
|
9366
|
+
setConversationSystemCallback(callback: (arg1: Multiplayer.ConversationSystemParams) => void): void;
|
|
9367
|
+
/**
|
|
9368
|
+
* @description Registers the system to listen for the named event.
|
|
9369
|
+
*/
|
|
9370
|
+
registerSystemCallback(): void;
|
|
9371
|
+
/**
|
|
9372
|
+
* @description Deregisters the system from listening for the named event.
|
|
9373
|
+
*/
|
|
9374
|
+
deregisterSystemCallback(): void;
|
|
9375
|
+
}
|
|
9376
|
+
}
|
|
9122
9377
|
export declare namespace Systems {
|
|
9123
9378
|
/**
|
|
9124
9379
|
* @description A result handler that is used to notify a user of an error.
|
|
@@ -9496,6 +9751,263 @@ export declare namespace Systems {
|
|
|
9496
9751
|
* @param callback - Callback when asynchronous task finishes
|
|
9497
9752
|
*/
|
|
9498
9753
|
registerAssetToLODChain(assetCollection: Systems.AssetCollection, asset: Systems.Asset, lODLevel: number, progressCallback: (requestProgress: number, responseProgress: number) => void): Promise<Systems.AssetResult>;
|
|
9754
|
+
/**
|
|
9755
|
+
* @description Creates a new material backed by an AssetCollection/Asset.
|
|
9756
|
+
* @param name - The name of the new material.
|
|
9757
|
+
* @param spaceId - The space id this material is associated with.
|
|
9758
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9759
|
+
*/
|
|
9760
|
+
createMaterial(name: string, spaceId: string): Promise<Systems.GLTFMaterialResult>;
|
|
9761
|
+
/**
|
|
9762
|
+
* @description Updates an existing material's properties.
|
|
9763
|
+
* The material should be retrieved through GetMaterials or GetMaterial.
|
|
9764
|
+
* If the material doesn't exist, EResultCode::Failed will be returned.
|
|
9765
|
+
* If the material hasn't changed, EResultCode::Success will still be returned.
|
|
9766
|
+
* @param material - The material to update
|
|
9767
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9768
|
+
*/
|
|
9769
|
+
updateMaterial(material: Systems.GLTFMaterial): Promise<Systems.NullResult>;
|
|
9770
|
+
/**
|
|
9771
|
+
* @description Deletes a given material.
|
|
9772
|
+
* The material should be retrieved through GetMaterials or GetMaterial.
|
|
9773
|
+
* @param material - The material to delete
|
|
9774
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9775
|
+
*/
|
|
9776
|
+
deleteMaterial(material: Systems.GLTFMaterial): Promise<Systems.NullResult>;
|
|
9777
|
+
/**
|
|
9778
|
+
* @description Gets all materials associated with the given space.
|
|
9779
|
+
* @param spaceId - The space id the material is associated with.
|
|
9780
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9781
|
+
*/
|
|
9782
|
+
getMaterials(spaceId: string): Promise<Systems.GLTFMaterialsResult>;
|
|
9783
|
+
/**
|
|
9784
|
+
* @description Gets a material using its AssetCollection and Asset Id.
|
|
9785
|
+
* @param assetCollectionId - The asset collection id this material is associated with.
|
|
9786
|
+
* @param assetId - The asset id this material is associated with.
|
|
9787
|
+
* @param callback - Callback when asynchronous task finishes.
|
|
9788
|
+
*/
|
|
9789
|
+
getMaterial(assetCollectionId: string, assetId: string): Promise<Systems.GLTFMaterialResult>;
|
|
9790
|
+
/**
|
|
9791
|
+
* @description Sets a callback for an asset changed event.
|
|
9792
|
+
* @param callback - Callback to receive data for the asset that has been changed.
|
|
9793
|
+
*/
|
|
9794
|
+
setAssetDetailBlobChangedCallback(callback: (arg1: Multiplayer.AssetDetailBlobParams) => void): void;
|
|
9795
|
+
/**
|
|
9796
|
+
* @description Sets a callback for a material changed event.
|
|
9797
|
+
* @param callback - Callback to receive data for the material that has been changed.
|
|
9798
|
+
*/
|
|
9799
|
+
setMaterialChangedCallback(callback: (arg1: Multiplayer.MaterialChangedParams) => void): void;
|
|
9800
|
+
/**
|
|
9801
|
+
* @description Registers the system to listen for the named event.
|
|
9802
|
+
*/
|
|
9803
|
+
registerSystemCallback(): void;
|
|
9804
|
+
/**
|
|
9805
|
+
* @description Deregisters the system from listening for the named event.
|
|
9806
|
+
*/
|
|
9807
|
+
deregisterSystemCallback(): void;
|
|
9808
|
+
}
|
|
9809
|
+
}
|
|
9810
|
+
export declare namespace Systems {
|
|
9811
|
+
/**
|
|
9812
|
+
@ingroup Asset System
|
|
9813
|
+
* @description Data class which represents a GLTF material.
|
|
9814
|
+
*/
|
|
9815
|
+
class GLTFMaterial extends Systems.Material implements INativeResource {
|
|
9816
|
+
/** @internal */
|
|
9817
|
+
constructor(pointer: NativePointer);
|
|
9818
|
+
static fromMaterial(baseInstance: Systems.Material): Systems.GLTFMaterial;
|
|
9819
|
+
/**
|
|
9820
|
+
* Sets how to alpha value is interpreted
|
|
9821
|
+
* @param mode - EAlphaMode
|
|
9822
|
+
*/
|
|
9823
|
+
setAlphaMode(mode: Systems.EAlphaMode): void;
|
|
9824
|
+
/**
|
|
9825
|
+
* Gets how to alpha value is interpreted
|
|
9826
|
+
* @return EAlphaMode
|
|
9827
|
+
*/
|
|
9828
|
+
getAlphaMode(): Systems.EAlphaMode;
|
|
9829
|
+
/**
|
|
9830
|
+
* @description Sets the alpha cutoff value
|
|
9831
|
+
* When alphaMode is set to MASK the alphaCutoff property specifies the cutoff threshold.
|
|
9832
|
+
* If the alpha value is greater than or equal to the alphaCutoff value then it is rendered as fully opaque,
|
|
9833
|
+
* otherwise, it is rendered as fully transparent. alphaCutoff value is ignored for other modes.
|
|
9834
|
+
* @param cutoff - Float
|
|
9835
|
+
*/
|
|
9836
|
+
setAlphaCutoff(cutoff: number): void;
|
|
9837
|
+
/**
|
|
9838
|
+
* Gets the alpha cutoff value
|
|
9839
|
+
* @return Float
|
|
9840
|
+
*/
|
|
9841
|
+
getAlphaCutoff(): number;
|
|
9842
|
+
/**
|
|
9843
|
+
* @description Sets the doubleSided property which specifies whether the material is double sided.
|
|
9844
|
+
* When this value is false, back - face culling is enabled, i.e., only front-facing triangles are rendered.
|
|
9845
|
+
* When this value is true, back - face culling is disabled and double sided lighting is enabled.
|
|
9846
|
+
* @param doubleSided - Bool
|
|
9847
|
+
*/
|
|
9848
|
+
setDoubleSided(doubleSided: boolean): void;
|
|
9849
|
+
/**
|
|
9850
|
+
* @description Gets the double sided value
|
|
9851
|
+
* @return Bool
|
|
9852
|
+
*/
|
|
9853
|
+
getDoubleSided(): boolean;
|
|
9854
|
+
/**
|
|
9855
|
+
* @description Sets the factors for the base color of the material.
|
|
9856
|
+
* This value defines linear multipliers for the sampled texels of the base color texture.
|
|
9857
|
+
* @param factor - Const csp::common::vector4&
|
|
9858
|
+
*/
|
|
9859
|
+
setBaseColorFactor(factor: Common.Vector4): void;
|
|
9860
|
+
/**
|
|
9861
|
+
* @description Gets the factor of the base color texture
|
|
9862
|
+
* @return Csp::common::vector4&
|
|
9863
|
+
*/
|
|
9864
|
+
getBaseColorFactor(): Common.Vector4;
|
|
9865
|
+
/**
|
|
9866
|
+
* @description Sets the factor for the metalness of the material.
|
|
9867
|
+
* This value defines a linear multiplier for the sampled metalness values of the metallic-roughness texture.
|
|
9868
|
+
* @param factor - Float
|
|
9869
|
+
*/
|
|
9870
|
+
setMetallicFactor(factor: number): void;
|
|
9871
|
+
/**
|
|
9872
|
+
* @description Gets the factor of the metallic texture
|
|
9873
|
+
* @return Float
|
|
9874
|
+
*/
|
|
9875
|
+
getMetallicFactor(): number;
|
|
9876
|
+
/**
|
|
9877
|
+
* @description Sets the factor for the roughness of the material.
|
|
9878
|
+
* This value defines a linear multiplier for the sampled roughness values of the metallic-roughness texture.
|
|
9879
|
+
* @param factor - Float
|
|
9880
|
+
*/
|
|
9881
|
+
setRoughnessFactor(factor: number): void;
|
|
9882
|
+
/**
|
|
9883
|
+
* @description Gets the factor of the roughness texture
|
|
9884
|
+
* @return Float
|
|
9885
|
+
*/
|
|
9886
|
+
getRoughnessFactor(): number;
|
|
9887
|
+
/**
|
|
9888
|
+
* @description Sets factors for the emissive color of the material.
|
|
9889
|
+
* This value defines linear multipliers for the sampled texels of the emissive texture.
|
|
9890
|
+
* @param factor - Const csp::common::vector3&
|
|
9891
|
+
*/
|
|
9892
|
+
setEmissiveFactor(factor: Common.Vector3): void;
|
|
9893
|
+
/**
|
|
9894
|
+
* @description Gets the factor of the emissive color texture
|
|
9895
|
+
* @return Csp::common::vector3&
|
|
9896
|
+
*/
|
|
9897
|
+
getEmissiveFactor(): Common.Vector3;
|
|
9898
|
+
/**
|
|
9899
|
+
* @description Sets the base color texture. The first three components (RGB) MUST be encoded with the sRGB transfer function.
|
|
9900
|
+
* They specify the base color of the material.
|
|
9901
|
+
* If the fourth component (A) is present, it represents the linear alpha coverage of the material.
|
|
9902
|
+
* Otherwise, the alpha coverage is equal to 1.0. The material.alphaMode property specifies how alpha is interpreted.
|
|
9903
|
+
* The stored texels MUST NOT be premultiplied.
|
|
9904
|
+
* When undefined, the texture MUST be sampled as having 1.0 in all components.
|
|
9905
|
+
* @param texture - Const textureinfo&
|
|
9906
|
+
*/
|
|
9907
|
+
setBaseColorTexture(texture: Systems.TextureInfo): void;
|
|
9908
|
+
/**
|
|
9909
|
+
* @description Gets the base color texture
|
|
9910
|
+
* @return Const textureinfo&
|
|
9911
|
+
*/
|
|
9912
|
+
getBaseColorTexture(): Systems.TextureInfo;
|
|
9913
|
+
/**
|
|
9914
|
+
* @description Sets the metallic-roughness texture.
|
|
9915
|
+
* The metalness values are sampled from the B channel.
|
|
9916
|
+
* The roughness values are sampled from the G channel.
|
|
9917
|
+
* These values MUST be encoded with a linear transfer function.
|
|
9918
|
+
* If other channels are present (R or A), they MUST be ignored for metallic-roughness calculations.
|
|
9919
|
+
* When undefined, the texture MUST be sampled as having 1.0 in G and B components.
|
|
9920
|
+
* @param texture - Const textureinfo&
|
|
9921
|
+
*/
|
|
9922
|
+
setMetallicRoughnessTexture(texture: Systems.TextureInfo): void;
|
|
9923
|
+
/**
|
|
9924
|
+
* @description Gets the metallic-roughness texture
|
|
9925
|
+
* @return Const textureinfo&
|
|
9926
|
+
*/
|
|
9927
|
+
getMetallicRoughnessTexture(): Systems.TextureInfo;
|
|
9928
|
+
/**
|
|
9929
|
+
* @description Sets the tangent space normal texture.
|
|
9930
|
+
* The texture encodes RGB components with linear transfer function.
|
|
9931
|
+
* Each texel represents the XYZ components of a normal vector in tangent space.
|
|
9932
|
+
* The normal vectors use the convention +X is right and +Y is up. +Z points toward the viewer.
|
|
9933
|
+
* If a fourth component (A) is present, it MUST be ignored. When undefined, the material does not have a tangent space normal texture.
|
|
9934
|
+
* @param texture - Const textureinfo&
|
|
9935
|
+
*/
|
|
9936
|
+
setNormalTexture(texture: Systems.TextureInfo): void;
|
|
9937
|
+
/**
|
|
9938
|
+
* @description Gets the tangent space normal texture.
|
|
9939
|
+
* @return Const textureinfo&
|
|
9940
|
+
*/
|
|
9941
|
+
getNormalTexture(): Systems.TextureInfo;
|
|
9942
|
+
/**
|
|
9943
|
+
* @description Sets the occlusion texture.
|
|
9944
|
+
* The occlusion values are linearly sampled from the R channel.
|
|
9945
|
+
* Higher values indicate areas that receive full indirect lighting and lower values indicate no indirect lighting.
|
|
9946
|
+
* If other channels are present (GBA), they MUST be ignored for occlusion calculations.
|
|
9947
|
+
* When undefined, the material does not have an occlusion texture.
|
|
9948
|
+
* @param texture - Const textureinfo&
|
|
9949
|
+
*/
|
|
9950
|
+
setOcclusionTexture(texture: Systems.TextureInfo): void;
|
|
9951
|
+
/**
|
|
9952
|
+
* @description Gets the occlusion texture
|
|
9953
|
+
* @return Const textureinfo&
|
|
9954
|
+
*/
|
|
9955
|
+
getOcclusionTexture(): Systems.TextureInfo;
|
|
9956
|
+
/**
|
|
9957
|
+
* @description Sets the emissive texture.
|
|
9958
|
+
* It controls the color and intensity of the light being emitted by the material.
|
|
9959
|
+
* This texture contains RGB components encoded with the sRGB transfer function.
|
|
9960
|
+
* If a fourth component (A) is present, it MUST be ignored.
|
|
9961
|
+
* When undefined, the texture MUST be sampled as having 1.0 in RGB components.
|
|
9962
|
+
* @param texture - Const textureinfo&
|
|
9963
|
+
*/
|
|
9964
|
+
setEmissiveTexture(texture: Systems.TextureInfo): void;
|
|
9965
|
+
/**
|
|
9966
|
+
* @description Gets the emissive texture
|
|
9967
|
+
* @return Const textureinfo&
|
|
9968
|
+
*/
|
|
9969
|
+
getEmissiveTexture(): Systems.TextureInfo;
|
|
9970
|
+
/**
|
|
9971
|
+
* @description Constructor which links the material to an asset
|
|
9972
|
+
* @param name - The name of the material.
|
|
9973
|
+
* @param assetCollectionId - The asset collection where the material info is stored
|
|
9974
|
+
* @param assetId - The asset where the material info is stored
|
|
9975
|
+
*/
|
|
9976
|
+
static create_name_assetCollectionId_assetId(name: string, assetCollectionId: string, assetId: string): GLTFMaterial;
|
|
9977
|
+
static create(): GLTFMaterial;
|
|
9978
|
+
delete(): void;
|
|
9979
|
+
}
|
|
9980
|
+
}
|
|
9981
|
+
export declare namespace Systems {
|
|
9982
|
+
/**
|
|
9983
|
+
@ingroup Asset System
|
|
9984
|
+
* @description Data class used to contain information when attempting to download material data.
|
|
9985
|
+
*/
|
|
9986
|
+
class GLTFMaterialResult extends Systems.ResultBase implements INativeResource {
|
|
9987
|
+
/** @internal */
|
|
9988
|
+
constructor(pointer: NativePointer);
|
|
9989
|
+
static fromResultBase(baseInstance: Systems.ResultBase): Systems.GLTFMaterialResult;
|
|
9990
|
+
/**
|
|
9991
|
+
* @description Retreives the GLTFMaterial from the result.
|
|
9992
|
+
*/
|
|
9993
|
+
getGLTFMaterial(): Systems.GLTFMaterial;
|
|
9994
|
+
delete(): void;
|
|
9995
|
+
}
|
|
9996
|
+
}
|
|
9997
|
+
export declare namespace Systems {
|
|
9998
|
+
/**
|
|
9999
|
+
@ingroup Asset System
|
|
10000
|
+
* @description Data class used to contain information when attempting to download a collection of material data.
|
|
10001
|
+
*/
|
|
10002
|
+
class GLTFMaterialsResult extends Systems.ResultBase implements INativeResource {
|
|
10003
|
+
/** @internal */
|
|
10004
|
+
constructor(pointer: NativePointer);
|
|
10005
|
+
static fromResultBase(baseInstance: Systems.ResultBase): Systems.GLTFMaterialsResult;
|
|
10006
|
+
/**
|
|
10007
|
+
* @description Retreives the GLTFMaterial from the result.
|
|
10008
|
+
*/
|
|
10009
|
+
getGLTFMaterials(): Common.Array<Systems.GLTFMaterial>;
|
|
10010
|
+
delete(): void;
|
|
9499
10011
|
}
|
|
9500
10012
|
}
|
|
9501
10013
|
export declare namespace Systems {
|
|
@@ -9924,7 +10436,7 @@ export declare namespace Systems {
|
|
|
9924
10436
|
/** @internal */
|
|
9925
10437
|
constructor(pointer: NativePointer);
|
|
9926
10438
|
static fromSystemBase(baseInstance: Systems.SystemBase): Systems.HotspotSequenceSystem;
|
|
9927
|
-
static
|
|
10439
|
+
static create_sequenceSystem_spaceSystem_eventBus(sequenceSystem: Systems.SequenceSystem, spaceSystem: Systems.SpaceSystem, eventBus: Multiplayer.EventBus): HotspotSequenceSystem;
|
|
9928
10440
|
/**
|
|
9929
10441
|
* @description Create a Hotspot group
|
|
9930
10442
|
* @param groupName - The unique grouping name
|
|
@@ -9971,6 +10483,19 @@ export declare namespace Systems {
|
|
|
9971
10483
|
* @param callback - Callback to call when a response is received
|
|
9972
10484
|
*/
|
|
9973
10485
|
removeItemFromGroups(itemName: string): Promise<Systems.NullResult>;
|
|
10486
|
+
/**
|
|
10487
|
+
* @description Sets a callback to be fired when a hotspot sequence is changed.
|
|
10488
|
+
* @param callback - Callback to receive data for the hotspot sequence that has been changed.
|
|
10489
|
+
*/
|
|
10490
|
+
setHotspotSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceHotspotChangedParams) => void): void;
|
|
10491
|
+
/**
|
|
10492
|
+
* @description Registers the system to listen for the named event.
|
|
10493
|
+
*/
|
|
10494
|
+
registerSystemCallback(): void;
|
|
10495
|
+
/**
|
|
10496
|
+
* @description Deregisters the system from listening for the named event.
|
|
10497
|
+
*/
|
|
10498
|
+
deregisterSystemCallback(): void;
|
|
9974
10499
|
}
|
|
9975
10500
|
}
|
|
9976
10501
|
export declare namespace Systems {
|
|
@@ -10408,6 +10933,19 @@ export declare namespace Systems {
|
|
|
10408
10933
|
* @param callback - Callback to call when a response is received
|
|
10409
10934
|
*/
|
|
10410
10935
|
deleteSequences(sequenceKeys: Common.Array<string>): Promise<Systems.NullResult>;
|
|
10936
|
+
/**
|
|
10937
|
+
* @description Sets a callback for a sequence changed event.
|
|
10938
|
+
* @param callback - Callback to receive data for the sequence that has been changed.
|
|
10939
|
+
*/
|
|
10940
|
+
setSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceChangedParams) => void): void;
|
|
10941
|
+
/**
|
|
10942
|
+
* @description Registers the system to listen for the named event.
|
|
10943
|
+
*/
|
|
10944
|
+
registerSystemCallback(): void;
|
|
10945
|
+
/**
|
|
10946
|
+
* @description Deregisters the system from listening for the named event.
|
|
10947
|
+
*/
|
|
10948
|
+
deregisterSystemCallback(): void;
|
|
10411
10949
|
}
|
|
10412
10950
|
}
|
|
10413
10951
|
export declare namespace Systems {
|
|
@@ -11259,7 +11797,8 @@ export declare namespace Systems {
|
|
|
11259
11797
|
* @description Retrieves an array with all the Points of Interest that are located inside the circular area defined by the parameters..
|
|
11260
11798
|
* @param originLocation - The latitude and longitude coordinates of origin of the search location.
|
|
11261
11799
|
* @param areaRadius - The Radius of the circular area to search around the provided origin.
|
|
11262
|
-
* @param type - The type of POI to search for. If none is specified, all types will be included in
|
|
11800
|
+
* @param type - The type of POI to search for. If none is specified, all types will be included in
|
|
11801
|
+
* the returned set.
|
|
11263
11802
|
* @param callback - Callback when asynchronous task finishes.
|
|
11264
11803
|
*/
|
|
11265
11804
|
getPOIsInArea(originLocation: Systems.GeoLocation, areaRadius: number, type: Systems.EPointOfInterestType | null): Promise<Systems.POICollectionResult>;
|
|
@@ -11539,6 +12078,19 @@ export declare namespace Systems {
|
|
|
11539
12078
|
* @param callback - Callback that contains the checkout session url of the tier
|
|
11540
12079
|
*/
|
|
11541
12080
|
getCheckoutSessionUrl(tier: Systems.TierNames): Promise<Systems.StringResult>;
|
|
12081
|
+
/**
|
|
12082
|
+
* @description Sets a callback for an access control changed event.
|
|
12083
|
+
* @param callback - Callback to receive data for the user permissions that has been changed.
|
|
12084
|
+
*/
|
|
12085
|
+
setUserPermissionsChangedCallback(callback: (arg1: Multiplayer.UserPermissionsParams) => void): void;
|
|
12086
|
+
/**
|
|
12087
|
+
* @description Registers the system to listen for the named event.
|
|
12088
|
+
*/
|
|
12089
|
+
registerSystemCallback(): void;
|
|
12090
|
+
/**
|
|
12091
|
+
* @description Deregisters the system from listening for the named event.
|
|
12092
|
+
*/
|
|
12093
|
+
deregisterSystemCallback(): void;
|
|
11542
12094
|
}
|
|
11543
12095
|
}
|
|
11544
12096
|
export declare namespace Common {
|
|
@@ -11557,6 +12109,7 @@ export declare namespace Common {
|
|
|
11557
12109
|
static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
|
|
11558
12110
|
static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
|
|
11559
12111
|
static ofcsp_systems_EAssetType(): Array<Systems.EAssetType>;
|
|
12112
|
+
static ofcsp_systems_GLTFMaterial(): Array<Systems.GLTFMaterial>;
|
|
11560
12113
|
static ofcsp_systems_LODAsset(): Array<Systems.LODAsset>;
|
|
11561
12114
|
static ofcsp_systems_VariantOptionInfo(): Array<Systems.VariantOptionInfo>;
|
|
11562
12115
|
static ofcsp_systems_ProductVariantInfo(): Array<Systems.ProductVariantInfo>;
|
|
@@ -11600,6 +12153,7 @@ export declare namespace Common {
|
|
|
11600
12153
|
static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
|
|
11601
12154
|
static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;
|
|
11602
12155
|
static ofcsp_systems_EAssetType_number(size: number): Array<Systems.EAssetType>;
|
|
12156
|
+
static ofcsp_systems_GLTFMaterial_number(size: number): Array<Systems.GLTFMaterial>;
|
|
11603
12157
|
static ofcsp_systems_LODAsset_number(size: number): Array<Systems.LODAsset>;
|
|
11604
12158
|
static ofcsp_systems_VariantOptionInfo_number(size: number): Array<Systems.VariantOptionInfo>;
|
|
11605
12159
|
static ofcsp_systems_ProductVariantInfo_number(size: number): Array<Systems.ProductVariantInfo>;
|
|
@@ -11676,13 +12230,13 @@ export declare namespace Common {
|
|
|
11676
12230
|
private TValueTypeFactory;
|
|
11677
12231
|
private TValueTypeName;
|
|
11678
12232
|
static ofUInt32Andcsp_multiplayer_ReplicatedValue(): Map<number, Multiplayer.ReplicatedValue>;
|
|
11679
|
-
static
|
|
12233
|
+
static ofStringAndcsp_multiplayer_ReplicatedValue(): Map<string, Multiplayer.ReplicatedValue>;
|
|
11680
12234
|
static ofUInt16Andcsp_multiplayer_ComponentBase(): Map<number, Multiplayer.ComponentBase>;
|
|
11681
12235
|
static ofStringAndString(): Map<string, string>;
|
|
11682
12236
|
static ofStringAndcsp_common_Map_String_String(): Map<string, Common.Map<string, string>>;
|
|
11683
12237
|
static ofStringAndcsp_common_Array_String(): Map<string, Common.Array<string>>;
|
|
11684
12238
|
static ofUInt32Andcsp_multiplayer_ReplicatedValue_Map(other: Common.Map<number, Multiplayer.ReplicatedValue>): Map<number, Multiplayer.ReplicatedValue>;
|
|
11685
|
-
static
|
|
12239
|
+
static ofStringAndcsp_multiplayer_ReplicatedValue_Map(other: Common.Map<string, Multiplayer.ReplicatedValue>): Map<string, Multiplayer.ReplicatedValue>;
|
|
11686
12240
|
static ofUInt16Andcsp_multiplayer_ComponentBase_Map(other: Common.Map<number, Multiplayer.ComponentBase>): Map<number, Multiplayer.ComponentBase>;
|
|
11687
12241
|
static ofStringAndString_Map(other: Common.Map<string, string>): Map<string, string>;
|
|
11688
12242
|
static ofStringAndcsp_common_Map_String_String_Map(other: Common.Map<string, Common.Map<string, string>>): Map<string, Common.Map<string, string>>;
|