unreal.MultiUserClientStatics
¶
-
class
unreal.
MultiUserClientStatics
(outer=None, name='None')¶ Bases:
unreal.BlueprintFunctionLibrary
Multi User Client Statics
C++ Source:
Plugin: MultiUserClient
Module: MultiUserClientLibrary
File: MultiUserClientStatics.h
-
classmethod
concert_jump_to_presence
(other_user_name, transform_offset)¶ deprecated: ‘concert_jump_to_presence’ was renamed to ‘jump_to_multi_user_presence’.
-
classmethod
configure_multi_user_client
(client_config) → bool¶ Configure the Multi-User client.
- Parameters
client_config (MultiUserClientConfig) –
- Returns
- Return type
-
classmethod
get_concert_client_info_by_name
(client_name)¶ deprecated: ‘get_concert_client_info_by_name’ was renamed to ‘get_multi_user_client_info_by_name’.
-
classmethod
get_concert_connection_status
()¶ deprecated: ‘get_concert_connection_status’ was renamed to ‘get_multi_user_connection_status’.
-
classmethod
get_last_multi_user_connection_error
() → MultiUserConnectionError¶ Get the last Multi-User connection error that happened, if any
- Returns
- Return type
-
classmethod
get_local_concert_client_info
()¶ deprecated: ‘get_local_concert_client_info’ was renamed to ‘get_local_multi_user_client_info’.
-
classmethod
get_local_multi_user_client_info
() → MultiUserClientInfo¶ Get the local ClientInfo. Works when not connected to a session.
- Returns
- Return type
-
classmethod
get_multi_user_client_info_by_name
(client_name) → MultiUserClientInfo or None¶ Get the ClientInfo for any Multi-User participant by name. The local user is found even when not connected to a session. Returns false is no client was found.
- Parameters
client_name (str) –
- Returns
client_info (MultiUserClientInfo):
- Return type
-
classmethod
get_multi_user_connection_status
() → bool¶ Get Multi-User connection status. deprecated: ‘Get Multi-User Connection Status’ is deprecated. Please use ‘Get Multi-User Connection Status Detail’ instead.
- Returns
- Return type
-
classmethod
get_multi_user_connection_status_detail
() → MultiUserConnectionStatus¶ Get Multi-User connection status.
- Returns
- Return type
-
classmethod
get_multi_user_presence_transform
(client_endpoint_id) → Transform¶ Get the Presence Actor transform for the specified client endpoint id or identity if the client isn’t found
-
classmethod
get_remote_concert_client_infos
()¶ deprecated: ‘get_remote_concert_client_infos’ was renamed to ‘get_remote_multi_user_client_infos’.
-
classmethod
get_remote_multi_user_client_infos
() → Array(MultiUserClientInfo) or None¶ Get ClientInfos of current Multi-User participants except for the local user. Returns false is no remote clients were found.
- Returns
client_infos (Array(MultiUserClientInfo)):
- Return type
-
classmethod
jump_to_multi_user_presence
(other_user_name, transform_offset) → None¶ Teleport to another Multi-User user’s presence.
-
classmethod
persist_multi_user_session_changes
() → None¶ Persist the session changes and prepare the files for source control submission.
-
classmethod
persist_session_changes
()¶ deprecated: ‘persist_session_changes’ was renamed to ‘persist_multi_user_session_changes’.
-
classmethod
set_multi_user_presence_enabled
(is_enabled=True) → None¶ Set whether presence is currently enabled and should be shown (unless hidden by other settings)
- Parameters
is_enabled (bool) –
-
classmethod
set_multi_user_presence_visibility
(name, visibility, propagate_to_all=False) → None¶ Set Presence Actor Visibility by display name
-
classmethod
set_multi_user_presence_visibility_by_id
(client_endpoint_id, visibility, propagate_to_all=False) → None¶ Set Presence Actor Visibility by client id
-
classmethod
set_presence_enabled
(is_enabled=True)¶ deprecated: ‘set_presence_enabled’ was renamed to ‘set_multi_user_presence_enabled’.
-
classmethod
set_presence_visibility
(name, visibility, propagate_to_all=False)¶ deprecated: ‘set_presence_visibility’ was renamed to ‘set_multi_user_presence_visibility’.