TextChannel

Tampilkan yang Tidak Digunakan Lagi

*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

Mewakili channelobrolan teks. Berisi TextSources sebagai keturunan.

Untuk mengirim pesan obrolan ke TextChannel , hubungi TextChannel:SendAsync() dari LocalScript .Yang sesuai TextSource dari pengguna dengan TextSource.CanSend = true harus ada di channelitu.

Pesan dari berbagai Saluran Teks dapat dipisahkan menjadi tab berbeda di jendela obrolan menggunakan ChannelTabsConfiguration .

Untuk mempelajari lebih lanjut, lihat Obrolan Teks dalam Pengalaman.

Rangkuman

Properti

  • Hanya Baca
    Tidak Direplikasi
    Baca Paralel

    The TextChannel hanya akan mengirim pesan kepada pengguna yang dapat mengirim pesan langsung ke DirectChatRequester.

Metode

Acara

Callback

Properti

DirectChatRequester

Hanya Baca
Tidak Direplikasi
Baca Paralel

The TextChannel hanya akan mengirim pesan kepada pengguna yang dapat mengirim pesan langsung ke DirectChatRequester. Properti ini hanya dapat ditetapkan menggunakan SetDirectChatRequester().

Metode

DisplaySystemMessage

Menampilkan pesan sistem kepada pengguna.Hanya dapat digunakan di dalam LocalScript , atau di dalam Script dengan RunContext dari Enum.RunContext.Client .Pesan hanya terlihat oleh pengguna itu dan tidak secara otomatis disaring atau diterjemahkan.

Parameter

systemMessage: string

Pesan sistem yang dikirim ke TextChannel .

Nilai Default: ""
metadata: string

Gunakan untuk mengidentifikasi jenis pesan sistem, seperti pesan sistem default.

Nilai Default: ""

Memberikan nilai

A TextChatMessage dengan properti TextChatMessage.Status yang menunjukkan kondisi pesan.

SetDirectChatRequester

()

Mengatur DirectChatRequester untuk TextChannel. Metode ini hanya tersedia untuk digunakan dalam skrip server.

Gunakan API ini jika Anda bekerja dengan TextChatService dan memiliki implementasi khusus obrolan langsung di luar saluran teks default.

Ketika dipanggil pada TextChannel yang diberikan ke TextChatService dan tidak memiliki TextSources yang ada, SetDirectChatRequester menambahkan pengguna yang diminta sebagai TextSource dan mengatur properti DirectChatRequester untuk channel.

Saat DirectChatRequester diatur, hanya pesan antara pengguna yang dapat mengarahkan obrolan dengan DirectChatRequester dikirimkan.


local function createWhisperChannel(fromPlayer, toPlayer)
local whisperChannel = Instance.new("TextChannel")
whisperChannel:SetDirectChatRequester(fromPlayer)
whisperChannel:AddUserAsync(toPlayer.UserId)
-- Instansi TextChannel sekarang memiliki dua instansi Sumber Teks.
return whisperChannel
end

Parameter

requester: Player
Nilai Default: ""

Memberikan nilai

()

AddUserAsync

Hasil

Menambahkan TextSource ke TextChannel ID pengguna yang diberikan (dengan Player.UserId ). Hanya dapat digunakan di Script .

Jika sebuah TextSource mewakili pengguna tidak ada, ini menambahkan TextSource .

Jika sebuah TextSource mewakili pengguna ada, ini akan mengembalikan TextSource.

Jika pengguna tidak aktif atau tidak ada di server, ini akan mengembalikan tuple nil, false.

Parameter

userId: number

ID pengguna dari Player.

Nilai Default: ""

Memberikan nilai

Kembalikan dan jika pengguna baru dibuat untuk pengguna, dan jika ada yang ada, atau dan jika pengguna memiliki obrolan mati atau tidak ada di server ini.

Hasil

Mengirimkan TextChatMessage ke server. Hanya dapat digunakan di LocalScript , atau di Script dengan RunContext dari Enum.RunContext.Client .

Argumen metadata memiliki batas 200 karakter.Jika ini dipanggil dengan argumen metadata yang memiliki lebih dari 200 karakter, pesan tidak akan dikirim ke pengguna lain.Sebagai gantinya, pengirim akan menerima TextChatMessage dengan properti TextChatMessage.Metadata dan TextChatMessage.Text yang diatur ke string kosong.

Parameter

message: string

Pesan yang harus dikirim ke TextChannel .

Nilai Default: ""
metadata: string

metadata khusus untuk menempelkan ke pesan.

Nilai Default: ""

Memberikan nilai

A TextChatMessage dengan properti TextChatMessage.Status yang menunjukkan kondisi pesan.

Acara

MessageReceived

Seperti TextChatService.MessageReceived , terbakar saat TextChannel:DisplaySystemMessage() diaktifkan pada klien, atau saat klien menerima respons TextChannel:SendAsync() yang valid dari server.Acara ini hanya ditembak pada klien.

Jika properti server TextChannel.ShouldDeliverCallback terikat dan kembali false , klien tidak akan menembak TextChannel.MessageReceived .

Gunakan parameter TextChatMessage untuk mendapatkan TextSource dan teks pesan (dengan TextChatMessage.Text ).

Parameter TextChatMessage adalah hasil akhir dari fungsi apa pun yang terikat pada TextChatService.OnIncomingMessage atau TextChannel.OnIncomingMessage.

Parameter

incomingMessage: TextChatMessage

Yang diterima TextChatMessage .


Callback

OnIncomingMessage

Dipanggil ketika TextChannel menerima pesan masuk. Hanya dapat dilaksanakan pada klien.

Gunakan ini untuk menghias TextChatMessages .Jika panggilan balasan ini mengembalikan TextChatMessageProperties , properti tersebut digabungkan dengan parameter TextChatMessage untuk membuat baru TextChatMessage .

Saat terikat ke klien yang mengirim pesan, panggilan balik ini dijalankan dua kali; pertama ketika pesan awalnya dikirim dan diterima secara lokal, dan sekali lagi ketika klien menerima hasil pesan yang disaring dari server.

TextChannel.OnIncomingMessage panggilan balik selalu dijalankan setelah panggilan balik TextChatService.OnIncomingMessage.

Ini harus didefinisikan hanya sekali per TextChannel di kode sumber.Beberapa binding ke saluran yang sama akan saling menghapus dalam cara yang tidak pasti.

Ketika TextChatService:CreateDefaultTextChannels() benar, default TextChannels memiliki panggilan balik mereka TextChannel.OnIncomingMessage ditugaskan secara internal untuk menampilkan perilaku default khusus.

Parameter

Yang masuk TextChatMessage .


Memberikan nilai

Jika sebuah TextChatMessageProperties dikembalikan, properti tersebut digabungkan dengan parameter TextChatMessage untuk membuat baru TextChatMessage dengan properti tersebut.

ShouldDeliverCallback

Memanggil untuk setiap klien ketika TextChannel menerima pesan masuk untuk menentukan apakah harus dikirim ke klien itu atau tidak.Hanya dapat didefinisikan di server.

Setelah didefinisikan, panggilan balasan ini perlu untuk mengembalikan nilai yang benar seperti true , 1 , atau "hello" untuk mengirimkan pesan ke klien yang bersangkutan.Jika panggil balik mengembalikan sesuatu yang lain (termasuk nil ), pesan tidak akan dikirim ke klien itu, meskipun pengirim akan melihat pesan tersebut terlepas dari itu.

Pengirim dapat di referensikan oleh TextChatMessage.TextSource , sementara penerima adalah argumen textSource .Perhatikan bahwa pengirim dan penerima bisa sama, karena callback mengulang melalui semua penerima yang mungkin.Di Roblox Studio, Anda akan menjadi pengirim dan penerima pesan satu-satunya saat berada dalam mode solo Bermain .

Parameter

Pesan yang dikirim, yang juga berisi pengirim pesan.

textSource: TextSource

The TextSource dari pengguna yang akan menerima pesan.


Memberikan nilai