BroadcastMessage.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/LocalMessage.h"
#include "ProjectX.h"
#include "BroadcastMessage.generated.h"
 
class AProjectXPlayerController;
 
UCLASS(Blueprintable)
class PROJECTX_API UBroadcastMessage : public ULocalMessage
{
    GENERATED_UCLASS_BODY()
 
//~ Begin ULocaLMessage Interface
public:
    virtual void ClientReceive(const FClientReceiveData& ClientData) const override;
//~ End ULocalMessage Interface
 
protected:
    //NOTE: This object has no world context. Do not GetWorld() directly - instead call GetWorld() on a valid UObject that was passed.
    UFUNCTION()
    virtual void ReceiveMessage(AProjectXPlayerController* PlayerController, int32 Data, APlayerState* PlayerStateA, APlayerState* PlayerStateB, UObject* Object) const;
    
    UFUNCTION(BlueprintImplementableEvent, Category = LocalMessage, meta = (DisplayName = "Receive Message", ScriptName = "ReceiveMessage"))
    void K2_ReceiveMessage(AProjectXPlayerController* PlayerController, int32 Data, APlayerState* PlayerStateA, APlayerState* PlayerStateB, UObject* Object) const;
 
public:
    //Sends a local message to all connected clients. To send a message to a specific client, use SendServerMessage.
    UFUNCTION(BlueprintCallable, BlueprintAuthorityOnly, Category = LocalMessage, meta = (WorldContext = "WorldContextObject", CallableWithoutWorldContext))
    static void BroadcastServerMessage(const UObject* WorldContextObject, TSubclassOf<class ULocalMessage> Message, const int32 Data, APlayerState* PlayerStateA, APlayerState* PlayerStateB, UObject* Object);
    //Alternate version of BroadcastServerMessage. Used to send specific clients messages rather than sending one to all connected clients.
    UFUNCTION(BlueprintCallable, BlueprintAuthorityOnly, Category = LocalMessage, meta = (WorldContext = "WorldContextObject", CallableWithoutWorldContext))
    static void SendServerMessage(APlayerController* PlayerController, TSubclassOf<class ULocalMessage> Message, const int32 Data, APlayerState* PlayerStateA, APlayerState* PlayerStateB, UObject* Object);
};