Skip to content

Send messages from ForceScript #564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 13, 2025
+55 −0
Merged

Send messages from ForceScript #564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a1963e
Enable sending messages to a sector via forcescript
jerethk Apr 13, 2025
80c9876
Enable sending message to object
jerethk Sep 12, 2025
3bd99a4
Move the message enum to gs_game
jerethk Sep 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions TheForceEngine/TFE_DarkForces/Scripting/gs_game.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ namespace TFE_DarkForces
{
ScriptClassBegin("Game", "game", api);
{
// Enums
ScriptEnumRegister("MessageType");
ScriptEnum("M_TRIGGER", MSG_TRIGGER);
ScriptEnum("NEXT_STOP", MSG_NEXT_STOP);
ScriptEnum("PREV_STOP", MSG_PREV_STOP);
// ScriptEnum("GOTO_STOP", MSG_GOTO_STOP); // GOTO_STOP requires a parameter, not yet implemented
ScriptEnum("DONE", MSG_DONE);
ScriptEnum("WAKEUP", MSG_WAKEUP);
ScriptEnum("MASTER_ON", MSG_MASTER_ON);
ScriptEnum("MASTER_OFF", MSG_MASTER_OFF);
ScriptEnum("CRUSH", MSG_CRUSH);

// Functions
ScriptObjMethod("float getGameTime()", getGameTime);
ScriptObjMethod("int random(int)", scriptRandom);
Expand Down
10 changes: 10 additions & 0 deletions TheForceEngine/TFE_DarkForces/Scripting/scriptObject.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include <TFE_DarkForces/pickup.h>
#include <TFE_DarkForces/player.h>
#include <TFE_DarkForces/mission.h>
#include <TFE_DarkForces/Actor/actor.h>
#include <TFE_ForceScript/forceScript.h>
#include <TFE_ForceScript/scriptAPI.h>
#include <TFE_Jedi/Level/levelData.h>
Expand Down Expand Up @@ -277,6 +278,14 @@ namespace TFE_DarkForces
if (s_nightVisionActive) { disableNightVision(); }
}

void sendMessageToObject(MessageType messageType, ScriptObject* sObject)
{
if (!doesObjectExist(sObject)) { return; }

SecObject* obj = TFE_Jedi::s_objectRefList[sObject->m_id].object;
message_sendToObj(obj, messageType, actor_messageFunc);
}

void ScriptObject::registerType()
{
s32 res = 0;
Expand Down Expand Up @@ -314,5 +323,6 @@ namespace TFE_DarkForces
ScriptObjFunc("void delete()", deleteObject);
ScriptObjFunc("void addLogic(string)", addLogicToObject);
ScriptObjFunc("void setCamera()", setCamera);
ScriptObjFunc("void sendMessage(int)", sendMessageToObject)
}
}
33 changes: 33 additions & 0 deletions TheForceEngine/TFE_DarkForces/Scripting/scriptSector.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#include <TFE_Jedi/Level/levelData.h>
#include <TFE_Jedi/Level/rwall.h>
#include <TFE_Jedi/Level/rsector.h>
#include <TFE_Jedi/InfSystem/message.h>
#include <angelscript.h>

using namespace TFE_Jedi;
Expand Down Expand Up @@ -169,6 +170,33 @@ namespace TFE_DarkForces
}
}

// Message with event and arg, eg. GOTO_STOP 131072 2
void sendMessageToSector(MessageType messageType, u32 evt, u32 msgArg1, ScriptSector* sSector)
{
if (!isScriptSectorValid(sSector))
{
return;
}

// TODO: investigate how to do this safely
// s_msgArg1 = msgArg1;

RSector* sector = &s_levelState.sectors[sSector->m_id];
message_sendToSector(sector, nullptr, evt, messageType);
}

// Message with no event and no arg, eg. NEXT_STOP
void sendMessageToSector1(MessageType messageType, ScriptSector* sSector)
{
sendMessageToSector(messageType, 0, 0, sSector);
}

// Message with event, eg. NEXT_STOP 131072
void sendMessageToSector2(MessageType messageType, u32 evt, ScriptSector* sSector)
{
sendMessageToSector(messageType, evt, 0, sSector);
}

void ScriptSector::registerType()
{
s32 res = 0;
Expand All @@ -185,6 +213,11 @@ namespace TFE_DarkForces
ScriptObjFunc("void setFlag(int, uint)", setSectorFlag);
ScriptObjFunc("float2 getCenterXZ()", getCenterXZ);
ScriptObjFunc("Wall getWall(int)", getWall);

ScriptObjFunc("void sendMessage(int)", sendMessageToSector1);
ScriptObjFunc("void sendMessage(int, uint)", sendMessageToSector2);
//ScriptObjFunc("void sendMessage(int, uint, uint)", sendMessageToSector); // For now do not expose the ability to pass an arg

// Properties
ScriptPropertyGetFunc("float get_floorHeight()", getFloorHeight);
ScriptPropertyGetFunc("float get_ceilHeight()", getCeilHeight);
Expand Down