Tutorial:Lua Conversion Guide - Revision history

Imbion: Imbion moved page Lua Conversion Guide to Tutorial:Lua Conversion Guide

2025-10-16T15:46:02Z

Imbion moved page Lua Conversion Guide to Tutorial:Lua Conversion Guide

← Older revision	Revision as of 15:46, 16 October 2025
(No difference)

Trio: /* List */

2023-08-30T23:26:07Z

List

← Older revision		Revision as of 23:26, 30 August 2023
Line 89:		Line 89:
	Lua:		Lua:
	<pre>		<pre>
			ListType = luanet.import_type('System.Collections.Generic.List`1')
	MobSpawnType = luanet.import_type('RogueEssence.LevelGen.MobSpawn')		MobSpawnType = luanet.import_type('RogueEssence.LevelGen.MobSpawn')
	local all_spawns = LUA_ENGINE:MakeGenericType( ListType, { MobSpawnType }, { })		local all_spawns = LUA_ENGINE:MakeGenericType( ListType, { MobSpawnType }, { })

Trio: /* List */

2023-08-30T23:25:24Z

List

← Older revision		Revision as of 23:25, 30 August 2023
Line 89:		Line 89:
	Lua:		Lua:
	<pre>		<pre>
			MobSpawnType = luanet.import_type('RogueEssence.LevelGen.MobSpawn')
	local all_spawns = LUA_ENGINE:MakeGenericType( ListType, { MobSpawnType }, { })		local all_spawns = LUA_ENGINE:MakeGenericType( ListType, { MobSpawnType }, { })
	</pre>		</pre>

Trio at 21:48, 30 August 2023

2023-08-30T21:48:13Z

← Older revision		Revision as of 21:48, 30 August 2023
Line 18:		Line 18:
	</pre>		</pre>

	* Notice how RogueElements is prepended in the Lua implementation. This is because it is located under the RogueElements [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Dirs.cs#L11, namespace]		* Notice how RogueElements is prepended in the Lua implementation. This is because it is located under the RogueElements [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Dirs.cs#L11, namespace]. '''This is essential to keep notice when working with the engine's C# classes.'''

	=== Creating C# Class ===		=== Creating C# Class ===

Trio at 00:21, 11 July 2023

2023-07-11T00:21:05Z

← Older revision		Revision as of 00:21, 11 July 2023
Line 75:		Line 75:
	<pre>		<pre>
	TargetAtkBoostType = luanet.import_type('PMDC.Dungeon.TargetAtkBoost')		TargetAtkBoostType = luanet.import_type('PMDC.Dungeon.TargetAtkBoost')
	local context_val = context:GetContextStateInt(TargetAtkBoostType, 0)		local context_val = context:GetContextStateInt(luanet.ctype(TargetAtkBoostType), 0)
	</pre>		</pre>

Trio at 22:08, 10 July 2023

2023-07-10T22:08:35Z

← Older revision		Revision as of 22:08, 10 July 2023
Line 66:		Line 66:
	* It is also important to note that PMDC.Dungeon is prepended because [https://github.com/PMDCollab/PMDC/blob/266ea426dbc5243432bc0d45a4992b88985a09dc/PMDC/Dungeon/GameEffects/ContextState.cs#L440, AbilityLearnContext] is located at under the namespace [https://github.com/PMDCollab/PMDC/blob/266ea426dbc5243432bc0d45a4992b88985a09dc/PMDC/Dungeon/GameEffects/ContextState.cs#L9C4-L9C4, here].		* It is also important to note that PMDC.Dungeon is prepended because [https://github.com/PMDCollab/PMDC/blob/266ea426dbc5243432bc0d45a4992b88985a09dc/PMDC/Dungeon/GameEffects/ContextState.cs#L440, AbilityLearnContext] is located at under the namespace [https://github.com/PMDCollab/PMDC/blob/266ea426dbc5243432bc0d45a4992b88985a09dc/PMDC/Dungeon/GameEffects/ContextState.cs#L9C4-L9C4, here].

			==== [https://github.com/RogueCollab/RogueEssence/blob/54b9be4cc0354dcbb0e4c8a9d021d3dac93f5be9/RogueEssence/Dungeon/GameEffects/GameContext.cs#L52-L63, GameContext::GetContextStateInt<T>(int)] ====
			C#
			<pre>
			int contextVal = context.GetContextStateInt<TargetAtkBoost>(0);
			</pre>

			Lua
			<pre>
			TargetAtkBoostType = luanet.import_type('PMDC.Dungeon.TargetAtkBoost')
			local context_val = context:GetContextStateInt(TargetAtkBoostType, 0)
			</pre>

	=== Create a Generic C# Class===		=== Create a Generic C# Class===

Trio at 15:01, 4 July 2023

2023-07-04T15:01:02Z

← Older revision		Revision as of 15:01, 4 July 2023
Line 202:		Line 202:
	return		return
	else		else
	local seeddmg = math.max(1, ~~math.floor(~~context.User.MaxHP / 12))		local seeddmg = math.max(1, context.User.MaxHP / 12)
	_DUNGEON:LogMsg(STRINGS:Format(RogueEssence.StringKey("MSG_LEECH_SEED"):ToLocal(), context.User:GetDisplayName(false)))		_DUNGEON:LogMsg(STRINGS:Format(RogueEssence.StringKey("MSG_LEECH_SEED"):ToLocal(), context.User:GetDisplayName(false)))
	SOUND:PlayBattleSE('DUN_Hit_Neutral')		SOUND:PlayBattleSE('DUN_Hit_Neutral')

Trio at 14:55, 4 July 2023

2023-07-04T14:55:09Z

← Older revision		Revision as of 14:55, 4 July 2023
Line 17:		Line 17:
	local dir = RogueElements.Dir8.DownLeft		local dir = RogueElements.Dir8.DownLeft
	</pre>		</pre>

			* Notice how RogueElements is prepended in the Lua implementation. This is because it is located under the RogueElements [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Dirs.cs#L11, namespace]

	=== Creating C# Class ===		=== Creating C# Class ===
Line 25:		Line 27:
	<pre>		<pre>
	Loc origin = new Loc(10, 10);		Loc origin = new Loc(10, 10);
			Loc origin2 = new Loc(25);
			Console.WriteLine(origin.X);
			Console.WriteLine(Loc.Dot(origin, origin2));
			Console.WriteLine(origin2.ToString());
	</pre>		</pre>

Line 30:		Line 36:
	<pre>		<pre>
	local origin = RogueElements.Loc(10, 10)		local origin = RogueElements.Loc(10, 10)
			local origin2 = RogueElements.Loc(25)
			PrintInfo(tostring(origin.X))
			PrintInfo(tostring(RogueElements.Loc.Dot(origin, origin2)))
			PrintInfo(origin:ToString())
	</pre>		</pre>

			* Note that you can call any of the class's [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Loc.cs#L21-L31, constructor]
			* In Lua, you can access a class [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Loc.cs#L18, member variable] through the "." operator
			* You also use the "." operator for [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Loc.cs#L119C27-L119C30, static methods]
			* To call a [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Loc.cs#L188C32-L188C42, class method] (not static) is different. You use the ":" operator in Lua instead

Trio at 04:15, 4 July 2023

2023-07-04T04:15:11Z

← Older revision		Revision as of 04:15, 4 July 2023
Line 4:		Line 4:

	Below are some C# to Lua conversion cases you might encounter:		Below are some C# to Lua conversion cases you might encounter:

			=== Calling C# Enum ===

			==== [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Dirs.cs#L36, Dir8] ====
			C#:
			<pre>
			Dir8 dir = Dir8.DownLeft;
			</pre>

			Lua:
			<pre>
			local dir = RogueElements.Dir8.DownLeft
			</pre>

			=== Creating C# Class ===

			==== [https://github.com/audinowho/RogueElements/blob/225fc028d31b285c609d4b7cbf3b4deb88045e02/RogueElements/Loc.cs#L11, Loc] ====

			C#:
			<pre>
			Loc origin = new Loc(10, 10);
			</pre>

			Lua:
			<pre>
			local origin = RogueElements.Loc(10, 10)
			</pre>


	=== Calling C# Generic Method ===		=== Calling C# Generic Method ===

Trio: Created page with "While writing your own custom Lua scripts, there could be several instances where you might replicate the engine source code and modify it from there. However, it can be tricky translating C# into Lua, especially with C# methods and classes involving generics. == Examples == Below are some C# to Lua conversion cases you might encounter: === Calling C# Generic Method === ==== [https://github.com/RogueCollab/RogueEssence/blob/9d86c78c282f1104038582be9e789655b323a55d/R..."

2023-07-04T03:55:59Z

Created page with "While writing your own custom Lua scripts, there could be several instances where you might replicate the engine source code and modify it from there. However, it can be tricky translating C# into Lua, especially with C# methods and classes involving generics. == Examples == Below are some C# to Lua conversion cases you might encounter: === Calling C# Generic Method === ==== [https://github.com/RogueCollab/RogueEssence/blob/9d86c78c282f1104038582be9e789655b323a55d/R..."

New page

While writing your own custom Lua scripts, there could be several instances where you might replicate the engine source code and modify it from there. However, it can be tricky translating C# into Lua, especially with C# methods and classes involving generics.

== Examples ==

Below are some C# to Lua conversion cases you might encounter:

=== Calling C# Generic Method ===

==== [https://github.com/RogueCollab/RogueEssence/blob/9d86c78c282f1104038582be9e789655b323a55d/RogueEssence/Dungeon/GameEffects/StateCollection.cs#L38, StateCollections::GetWithDefault<K>] ====

C#:
<pre>
AbilityLearnContext learn = context.ContextStates.GetWithDefault<AbilityLearnContext>();
</pre>

Lua:
<pre>
AbilityLearnContextType = luanet.import_type('PMDC.Dungeon.AbilityLearnContext')
local learn = context.ContextStates:GetWithDefault(luanet.ctype(AbilityLearnContextType))
</pre>

* Notice that in Lua, you have to import the type directly using luanet.import_type.
* It is also important to note that PMDC.Dungeon is prepended because [https://github.com/PMDCollab/PMDC/blob/266ea426dbc5243432bc0d45a4992b88985a09dc/PMDC/Dungeon/GameEffects/ContextState.cs#L440, AbilityLearnContext] is located at under the namespace [https://github.com/PMDCollab/PMDC/blob/266ea426dbc5243432bc0d45a4992b88985a09dc/PMDC/Dungeon/GameEffects/ContextState.cs#L9C4-L9C4, here].

=== Create a Generic C# Class===

==== [https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1.-ctor?view=net-7.0, List<T>] ====

C#:
<pre>
List<MobSpawn> allSpawns = new List<MobSpawn>();
</pre>

Lua:
<pre>
local all_spawns = LUA_ENGINE:MakeGenericType( ListType, { MobSpawnType }, { })
</pre>

==== [https://github.com/RogueCollab/RogueEssence/blob/9d86c78c282f1104038582be9e789655b323a55d/RogueEssence/LevelGen/Spawning/PlaceMobsStep/PlaceEntranceMobsStep.cs#L14C18-L14C18, PlaceEntranceMobsStep<T, TEntrance>] ====

C#:
<pre>
SpecificTeamSpawner specificTeam = SpecificTeamSpawner();
MobSpawn postMob = MobSpawn();
postMob.BaseForm = MonsterID("oshawott", 0, "normal", Gender.Unknown);
postMob.Tactic = "boss";
mostMob.Level = RandRange(50);
specificTeam.Spawns.Add(postMob);
PresetMultiTeamSpawner picker = new PresetMultiTeamSpawner<MapGenContext>();
picker.Spawns.Add(specificTeam);
PlaceEntranceMobsStep mobPlacement = new PlaceEntranceMobsStep<MapGenContext, MapGenEntrance>(picker);
</pre>

Lua:
<pre>
PresetMultiTeamSpawnerType = luanet.import_type('RogueEssence.LevelGen.PresetMultiTeamSpawner`1')
EntranceType = luanet.import_type('RogueEssence.LevelGen.MapGenEntrance')
PlaceEntranceMobsStepType = luanet.import_type('RogueEssence.LevelGen.PlaceEntranceMobsStep`2')
MapGenContextType = luanet.import_type('RogueEssence.LevelGen.ListMapGenContext')

local specific_team = RogueEssence.LevelGen.SpecificTeamSpawner()
local post_mob = RogueEssence.LevelGen.MobSpawn()
post_mob.BaseForm = RogueEssence.Dungeon.MonsterID("oshawott", 0, "normal", Gender.Unknown)
post_mob.Tactic = "boss"
post_mob.Level = RogueElements.RandRange(50)
specific_team.Spawns:Add(post_mob)
local picker = LUA_ENGINE:MakeGenericType(PresetMultiTeamSpawnerType, { MapGenContextType }, { })
picker.Spawns:Add(specific_team)
local mob_placement = LUA_ENGINE:MakeGenericType(PlaceEntranceMobsStepType, { MapGenContextType, EntranceType }, { picker })
</pre>

* Notice the `1 and `2 appended at the end of the import_type. These represent how many generics the class requires.
* The [https://github.com/RogueCollab/RogueEssence/blob/9d86c78c282f1104038582be9e789655b323a55d/RogueEssence/Lua/LuaEngine.cs#L1624, LUA_ENGINE:MakeGenericType] method takes in three parameters:
** The 1st parameter is what generic type to create
** The 2nd parameter is a table of types necessary to create the generic type
** The 3rd parameter is a table of values that is called with the constructor of the generic type

== Source Code Conversion Example ==
=== [https://github.com/PMDCollab/PMDC/blob/266ea426dbc5243432bc0d45a4992b88985a09dc/PMDC/Dungeon/GameEffects/SingleCharEvent.cs#L1820, LeechSeedEvent] ===

C#:
<pre>
public override IEnumerator<YieldInstruction> Apply(GameEventOwner owner, Character ownerChar, SingleCharContext context)
{
if (context.User.CharStates.Contains<MagicGuardState>())
yield break;

//check for someone within 4 tiles away; if there's no one, then remove the status
List<Character> targets = AreaAction.GetTargetsInArea(context.User, context.User.CharLoc, Alignment.Foe, 4);
int lowestDist = Int32.MaxValue;
Character target = null;
for (int ii = 0; ii < targets.Count; ii++)
{
int newDist = (targets[ii].CharLoc - context.User.CharLoc).DistSquared();
if (newDist < lowestDist)
{
target = targets[ii];
lowestDist = newDist;
}
}

if (target == null)
yield return CoroutineManager.Instance.StartCoroutine(context.User.RemoveStatusEffect(((StatusEffect)owner).ID));
else
{
int seeddmg = Math.Max(1, context.User.MaxHP / 12);

DungeonScene.Instance.LogMsg(Text.FormatGrammar(new StringKey("MSG_LEECH_SEED").ToLocal(), context.User.GetDisplayName(false)));

GameManager.Instance.BattleSE("DUN_Hit_Neutral");
if (!context.User.Unidentifiable)
{
SingleEmitter endEmitter = new SingleEmitter(new AnimData("Hit_Neutral", 3));
endEmitter.SetupEmit(context.User.MapLoc, context.User.MapLoc, context.User.CharDir);
DungeonScene.Instance.CreateAnim(endEmitter, DrawLayer.NoDraw);
}

yield return CoroutineManager.Instance.StartCoroutine(context.User.InflictDamage(seeddmg, false));

if (context.User.CharStates.Contains<DrainDamageState>())
{
GameManager.Instance.BattleSE("DUN_Toxic");
DungeonScene.Instance.LogMsg(Text.FormatGrammar(new StringKey("MSG_LIQUID_OOZE").ToLocal(), target.GetDisplayName(false)));
yield return CoroutineManager.Instance.StartCoroutine(target.InflictDamage(seeddmg * 4, false));
}
else if (target.HP < target.MaxHP)
{
yield return CoroutineManager.Instance.StartCoroutine(target.RestoreHP(seeddmg, false));
}
}
}
</pre>

Lua:
<pre>
SINGLE_CHAR_SCRIPT = {}
DrainDamageStateType = luanet.import_type('PMDC.Dungeon.DrainDamageState')
MagicGuardStateType = luanet.import_type('PMDC.Dungeon.MagicGuardState')

function SINGLE_CHAR_SCRIPT.LeechSeedEvent(owner, ownerChar, context, args)
if context.User.CharStates:Contains(luanet.ctype(MagicGuardStateType)) then
return
end

local targets = RogueEssence.Dungeon.AreaAction.GetTargetsInArea(context.User, context.User.CharLoc, RogueEssence.Dungeon.Alignment.Foe, 4)
local lowestDist = 10000
local target = nil
for ii = 0, targets.Count - 1, 1 do
local newDist = (targets[ii].CharLoc - context.User.CharLoc):DistSquared()
if newDist < lowestDist then
target = targets[ii]
lowestDist = newDist
end
end

if target == nil then
TASK:WaitTask(context.User:RemoveStatusEffect(owner:GetID()))
return
else
local seeddmg = math.max(1, math.floor(context.User.MaxHP / 12))
_DUNGEON:LogMsg(STRINGS:Format(RogueEssence.StringKey("MSG_LEECH_SEED"):ToLocal(), context.User:GetDisplayName(false)))
SOUND:PlayBattleSE('DUN_Hit_Neutral')
if not context.User.Unidentifiable then
local endEmitter = RogueEssence.Content.SingleEmitter(RogueEssence.Content.AnimData("Hit_Neutral", 3))
endEmitter:SetupEmit(context.User.MapLoc, context.User.MapLoc, context.User.CharDir)
_DUNGEON:CreateAnim(endEmitter, RogueEssence.Content.DrawLayer.NoDraw)
end

TASK:WaitTask(context.User:InflictDamage(seeddmg, false))
if context.User.CharStates:Contains(luanet.ctype(MagicGuardStateType)) then
SOUND:PlayBattleSE('DUN_Toxic')
_DUNGEON:LogMsg(STRINGS:Format(RogueEssence.StringKey("MSG_LIQUID_OOZE"):ToLocal(), target:GetDisplayName(false)))
TASK:WaitTask(target:InflictDamage(seeddmg * 4, false))
elseif target.HP < target.MaxHP then
TASK:WaitTask(target:RestoreHP(seeddmg, false))
end
end
end
</pre>

This concludes converting Lua to C# code! Knowing how and when to call and use the source engine's classes, methods, and enums allows you write more complex battle events beyond the Dev menu!

[[Category:Modding Data]]