unreal.MultiUserTakesFunctionLibrary
¶
- class unreal.MultiUserTakesFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BlueprintFunctionLibrary
Exposes some of the recorder settings to Blueprints to allow for more editor scripting capabilities.
C++ Source:
Plugin: MultiUserTakes
Module: ConcertTakeRecorder
File: MultiUserTakesFunctionLibrary.h
- classmethod get_record_on_client(client_endpoint_id) bool ¶
Gets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This function queries the state of any connected client. For the local client, you can also use GetRecordOnClientLocal.
- classmethod get_record_on_client_local() bool ¶
Gets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This is an utility for getting the local client’s value; GetRecordOnClient can also be used.
- Return type:
- classmethod get_synchronize_take_recorder_transactions(client_endpoint_id) bool ¶
Gets the value of the “SynchronizeTakeRecorderTransactions” checkbox in the settings displayed at the bottom of the “Take Recorder” tab. This function queries the state of any connected client. For the local client, you can also use GetSynchronizeTakeRecorderTransactionsLocal.
- classmethod get_synchronize_take_recorder_transactions_local() bool ¶
Gets the value of the “SynchronizeTakeRecorderTransactions” checkbox in the settings displayed at the bottom of the “Take Recorder” tab. This is an utility for getting the local client’s value; GetSynchronizeTakeRecorderTransactions can also be used.
- Return type:
- classmethod set_record_on_client(client_endpoint_id, new_value) None ¶
Sets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This function queries the state of any connected client. For the local client, you can also use SetRecordOnClientLocal.
- classmethod set_record_on_client_local(new_value) None ¶
Sets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This is an utility for setting the local client’s value; SetRecordOnClient can also be used.
- Parameters:
new_value (bool) –
- classmethod set_synchronize_take_recorder_transactions_local(new_value) None ¶
Sets the value of the “SynchronizeTakeRecorderTransactions” checkbox in the settings displayed at the bottom of the “Take Recorder” tab. note: Only the value of the local client can be set. Setting of remote clients is not implemented (no technical reason - there just never was a use-case).
- Parameters:
new_value (bool) –