Update ProceduralEffect

Author: frto027

changelog.txt

@@ -66,6 +66,10 @@ Additions:
 * PlayerHUD:
 	- GetIndex
 	- GetLayout
+* ProceduralEffect
+	- Fix fartScale.
+	- GetScore
+	- GetTriggerChanceScale
 * Room:
 	- TriggerOutput(RoomEventOutput GroupIdx)
 * RoomConfig:

docs/docs/ProceduralEffect.md

@@ -83,9 +83,20 @@ ___
 #### [ProceduralEffectConditionType](enums/ProceduralEffectConditionType.md) GetConditionType ( ) {: .copyable aria-label='Functions' }
 Returns the timing when the effect was triggered.
 
+___
+### GetScore () {: aria-label='Functions' }
+#### float GetScore ( ) {: .copyable aria-label='Functions' }
+
+The score is used to generate the `ProceduralItem`. Each `ProceduralItem` has a score limit when generating its effects. If the limit is reached, no more effect will be added.
 ___
 ### GetTriggerChance () {: aria-label='Functions' }
 #### float GetTriggerChance ( ) {: .copyable aria-label='Functions' }
 
-Values range from `0` to `1`.
+This is the actual change that the game actually uses. In most cases, this value ranges from `0` to `1`. This is the value that the result of `GetTriggerChanceScale` has been applied.
+
+___
+### GetTriggerChanceScale () {: aria-label='Functions' }
+#### float GetTriggerChanceScale ( ) {: .copyable aria-label='Functions' }
+
+In most cases, this value should be `1`.
 ___

libzhl/functions/ProceduralEffect.zhl

@@ -83,5 +83,6 @@ struct ProceduralEffect depends (
 }}
     int effectConditionType : 0x0;
     int effectActionType : 0x4;
-    float triggerChance : 0x30;
-} : 0x60;
+    float triggerChanceScale : 0x30;
+    float score : 0x60;
+} : 0x68;

repentogon/LuaInterfaces/ProcedualItems/LuaProceduralEffect.cpp

@@ -69,7 +69,7 @@ LUA_FUNCTION(Lua_PEGetActionProperty) {
 		lua_setfield(L, -2, "flags2");
 		break;
 	case ProceduralEffect::ACTION_FART:
-		lua_pushnumber(L, pi->GetActionData()->fart.fartScale);
+		lua_pushnumber(L, pi->GetActionData()->fart.fartScale * 6);
 		lua_setfield(L, -2, "scale");
 		lua_pushnumber(L, pi->GetActionData()->fart.radius * 6.f / 85.f);
 		lua_setfield(L, -2, "radius");
@@ -78,11 +78,10 @@ LUA_FUNCTION(Lua_PEGetActionProperty) {
 	return 1;
 }
 
-
 LUA_FUNCTION(Lua_PEGetTriggerChance) {
 	ProceduralEffect* pi = *lua::GetRawUserdata<ProceduralEffect**>(L, 1, lua::metatables::ProceduralEffectMT);
-	float chance = pi->triggerChance;
-	//manually fix the chance from 0 ~ 1 to the actual rate.
+	float chance = pi->triggerChanceScale;
+	/* Note: the chance is hard coded in the game program. */
 	switch (pi->effectConditionType)
 	{
 	case ProceduralEffect::CONDITION_TEAR_FIRE:
@@ -100,13 +99,27 @@ LUA_FUNCTION(Lua_PEGetTriggerChance) {
 	return 1;
 }
 
+LUA_FUNCTION(Lua_PEGetTriggerChanceScale) {
+	ProceduralEffect* pi = *lua::GetRawUserdata<ProceduralEffect**>(L, 1, lua::metatables::ProceduralEffectMT);
+	lua_pushnumber(L, pi->triggerChanceScale);
+	return 1;
+}
+
+LUA_FUNCTION(Lua_PEGetScore) {
+	ProceduralEffect* pi = *lua::GetRawUserdata<ProceduralEffect**>(L, 1, lua::metatables::ProceduralEffectMT);
+	lua_pushnumber(L, pi->score);
+	return 1;
+}
+
 static void RegisterProceduralItem(lua_State* L) {
 	luaL_Reg functions[] = {
 		{"GetConditionType", Lua_PEGetConditionType},
 		{"GetActionType", Lua_PEGetActionType},
 		{"GetConditionProperty", Lua_PEGetConditionProperty},
 		{"GetActionProperty", Lua_PEGetActionProperty},
 		{"GetTriggerChance", Lua_PEGetTriggerChance},
+		{"GetTriggerChanceScale", Lua_PEGetTriggerChanceScale},
+		{"GetScore", Lua_PEGetScore},
 		{ NULL, NULL }
 	};
 	lua::RegisterNewClass(L, lua::metatables::ProceduralEffectMT, lua::metatables::ProceduralEffectMT, functions);