Scaleform

ฟังก์ชันฝั่ง Client สำหรับแสดง UI แบบ Scaleform (ข้อความกลางจอ, Breaking News, Popup Warning ฯลฯ) ผ่าน `ESX.Scaleform.*`

Scaleform (Client)

หน้านี้รวมฟังก์ชันสำหรับแสดง Scaleform เพื่อทำ UI เชิง cinematic ภายในเกม

เรียกใช้งานผ่าน ESX.Scaleform.*

ก่อนเริ่ม (แนะนำ)

• ตั้งค่าการเรียกใช้ Framework ให้ถูกต้องตาม Framework Usage

• เรียกฟังก์ชันกลุ่มนี้ใน CreateThread เสมอ

ฟังก์ชัน Scaleform เป็นแบบ blocking และจะบล็อก thread ตามเวลาที่กำหนดไว้ หากเรียกใน main flow อาจทำให้ระบบอื่นค้างหรือกระตุกได้

---

ESX.Scaleform.ShowBreakingNews

แสดง Scaleform แบบ “Breaking News” พร้อมแถบ ticker วิ่ง

รูปแบบการใช้งาน (Syntax)

ESX.Scaleform.ShowBreakingNews(title, msg, bottom, sec)

พารามิเตอร์ (Parameters)

Name	Type	Description
title	string	ข้อความ ticker (แถบบน)
msg	string	ข้อความหลัก
bottom	string	ข้อความด้านล่าง
sec	number	ระยะเวลาแสดงผล (วินาที)

ตัวอย่างการใช้งาน (Example)

example.lua

CreateThread(function()
    ESX.Scaleform.ShowBreakingNews('BREAKING NEWS', 'A major event has occurred', 'Live Coverage', 5)
end)

---

ESX.Scaleform.ShowFreemodeMessage

แสดงข้อความขนาดใหญ่ตรงกลางจอ สไตล์ Freemode (เช่น WASTED / MISSION PASSED)

รูปแบบการใช้งาน (Syntax)

ESX.Scaleform.ShowFreemodeMessage(title, msg, sec)

พารามิเตอร์ (Parameters)

Name	Type	Description
title	string	หัวข้อหลัก (ตัวใหญ่)
msg	string	ข้อความรอง
sec	number	ระยะเวลาแสดงผล (วินาที)

ตัวอย่างการใช้งาน (Example)

example.lua

CreateThread(function()
    ESX.Scaleform.ShowFreemodeMessage('MISSION PASSED', 'Well done!', 3)
end)

---

ESX.Scaleform.ShowPopupWarning

แสดงหน้าต่างแจ้งเตือน (Popup Warning) สไตล์ GTA พร้อมพื้นหลังมืด

รูปแบบการใช้งาน (Syntax)

ESX.Scaleform.ShowPopupWarning(title, msg, bottom, sec)

พารามิเตอร์ (Parameters)

Name	Type	Description
title	string	หัวข้อคำเตือน
msg	string	เนื้อหาคำเตือน
bottom	string	ข้อความคำแนะนำด้านล่าง
sec	number	ระยะเวลาแสดงผล (วินาที)

ตัวอย่างการใช้งาน (Example)

example.lua

CreateThread(function()
    ESX.Scaleform.ShowPopupWarning('WARNING', 'You are entering a restricted area', 'Press any key to continue', 5)
end)

---

ESX.Scaleform.ShowTrafficMovie

แสดงเอฟเฟกต์ Scaleform สไตล์กล้องจราจร (Traffic Camera)

รูปแบบการใช้งาน (Syntax)

ESX.Scaleform.ShowTrafficMovie(sec)

พารามิเตอร์ (Parameters)

Name	Type	Description
sec	number	ระยะเวลาแสดงผล (วินาที)

ตัวอย่างการใช้งาน (Example)

example.lua

CreateThread(function()
    ESX.Scaleform.ShowTrafficMovie(3)
end)

---

ESX.Scaleform.Utils.RequestScaleformMovie

โหลด Scaleform movie ตามชื่อที่ระบุ พร้อมรองรับ timeout

รูปแบบการใช้งาน (Syntax)

ESX.Scaleform.Utils.RequestScaleformMovie(scaleformName, timeout)

พารามิเตอร์ (Parameters)

Name	Type	Description
scaleformName	string	ชื่อ scaleform movie ที่ต้องการโหลด
timeout	number	(ไม่บังคับ) timeout เป็นจำนวน tick (ค่าเริ่มต้น: 500)

ค่าที่ส่งคืน (Returns)

Type	Description
number	Handle ของ scaleform movie

ตัวอย่างการใช้งาน (Example)

example.lua

local scaleform = ESX.Scaleform.Utils.RequestScaleformMovie('MP_BIG_MESSAGE_FREEMODE')
-- Use scaleform methods...
SetScaleformMovieAsNoLongerNeeded(scaleform)

ควรเรียกภายใน coroutine/thread เพื่อให้กลไก timeout ทำงานได้ถูกต้อง

หลังใช้งาน ควรคืน resource ด้วย SetScaleformMovieAsNoLongerNeeded(scaleform) เพื่อลดการใช้หน่วยความจำ