Skip to content

Add clientside p2m functions to Starfall #74

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

Open
legokidlogan wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add clientside p2m functions to Starfall #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c47da4
Add clientside variants to applicable starfall functions
legokidlogan Feb 26, 2026
85c9aae
Don't replicate UV/Bump, they could desync uniqueID improperly
legokidlogan Feb 26, 2026
8eb750c
Improve docstring
legokidlogan Feb 26, 2026
249abaf
Add e2 and sf getters for pos and ang
legokidlogan Feb 26, 2026
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
16 changes: 16 additions & 0 deletions lua/entities/gmod_wire_expression2/core/custom/prop2mesh.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,22 @@ e2function vector4 entity:p2mGetColor(index)
local info = this.prop2mesh_controllers[index]
return {info.col.r, info.col.g, info.col.b, info.col.a}
end
e2function vector entity:p2mGetPos(index)
if not checkvalid(self, this, nil, index, nil) then
return {0,0,0}

@LengthenedGradient LengthenedGradient Aug 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be changed to return Vector(0,0,0).
Similarly for the other {0,0,0} in surrounding lines.
Otherwise E2 complains about unpacking issues.

end
local linkpos = this.prop2mesh_controllers[index].linkpos
if not linkpos then return {0,0,0} end
return {linkpos.x, linkpos.y, linkpos.z}
end
e2function angle entity:p2mGetAng(index)
if not checkvalid(self, this, nil, index, nil) then
return {0,0,0}
end
local linkang = this.prop2mesh_controllers[index].linkang
if not linkang then return {0,0,0} end
return {linkang.p, linkang.y, linkang.r}
end
e2function string entity:p2mGetMaterial(index)
if not checkvalid(self, this, nil, index, nil) then
return ""
Expand Down
128 changes: 102 additions & 26 deletions lua/entities/sent_prop2mesh/cl_init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ local Ent_SetColor = entMeta.SetColor
local Ent_GetTable = entMeta.GetTable
local Ent_DrawModel = entMeta.DrawModel
local Ent_GetAngles = entMeta.GetAngles
local Ent_GetParent = entMeta.GetParent
local Ent_SetParent = entMeta.SetParent
local Ent_SetAngles = entMeta.SetAngles
local Ent_SetMaterial = entMeta.SetMaterial
Expand Down Expand Up @@ -396,6 +397,39 @@ local function drawMesh(self)
return meshes and meshes.basic or empty
end

local function refreshSetColor(infoEnt, col)
local isOpaque = col.a == 255

Ent_SetColor(infoEnt, col)
Ent_SetRenderMode(infoEnt, isOpaque and RENDERMODE_NORMAL or RENDERMODE_TRANSCOLOR)
infoEnt.RenderGroup = isOpaque and RENDERGROUP_OPAQUE or RENDERGROUP_BOTH
end

local function refreshSetScale(infoEnt, scale)
if scale.x ~= 1 or scale.y ~= 1 or scale.z ~= 1 then
local matrix = Matrix()
matrix:SetScale(scale)
Ent_EnableMatrix(infoEnt, "RenderMultiply", matrix)
infoEnt.scale = scale
else
Ent_DisableMatrix(infoEnt, "RenderMultiply")
infoEnt.scale = nil
end
end

local function refreshSetPosAng(infoEnt, info, p2mEnt)
local linkEnt = info.linkent
local parent = IsValid(linkEnt) and linkEnt or p2mEnt
local pos, ang = LocalToWorld(info.linkpos or vecZero, info.linkang or angZero, Ent_GetPos(parent), Ent_GetAngles(parent))

if parent ~= Ent_GetParent(infoEnt) then
Ent_SetParent(infoEnt, parent)
end

Ent_SetPos(infoEnt, pos)
Ent_SetAngles(infoEnt, ang)
end

local function refresh(self, info)
local infoEnt = info.ent

Expand All @@ -411,33 +445,12 @@ local function refresh(self, info)
info.ent = infoEnt
end

local linkEnt = info.linkent
local parent = IsValid(linkEnt) and linkEnt or self
local pos, ang = LocalToWorld(info.linkpos or vecZero, info.linkang or angZero, Ent_GetPos(parent), Ent_GetAngles(parent))

Ent_SetParent(infoEnt, parent)
Ent_SetAngles(infoEnt, ang)
Ent_SetPos(infoEnt, pos)

local infoEntTable = Ent_GetTable(infoEnt)
local infoCol = info.col
local isOpaque = infoCol.a == 255

Ent_SetMaterial(infoEnt, info.mat)
Ent_SetColor(infoEnt, infoCol)
Ent_SetRenderMode(infoEnt, isOpaque and RENDERMODE_NORMAL or RENDERMODE_TRANSCOLOR)
infoEntTable.RenderGroup = isOpaque and RENDERGROUP_OPAQUE or RENDERGROUP_BOTH

local infoScale = info.scale
if infoScale.x ~= 1 or infoScale.y ~= 1 or infoScale.z ~= 1 then
local matrix = Matrix()
matrix:SetScale(infoScale)
Ent_EnableMatrix(infoEnt, "RenderMultiply", matrix)
infoEnt.scale = info.scale
else
Ent_DisableMatrix(infoEnt, "RenderMultiply")
infoEnt.scale = nil
end
refreshSetColor(infoEnt, info.col)
refreshSetScale(infoEnt, info.scale)
refreshSetPosAng(infoEnt, info, self)

local infoCrc = info.crc
local infoUniqueID = info.uniqueID
Expand Down Expand Up @@ -583,10 +596,72 @@ function ENT:GetDownloadProgress()
end


local kvpass = {}
local function applyPropertyWithKVPass(ent, index, key, val)
local info = ent.prop2mesh_controllers[index]
if not info then return end

local pass = kvpass[key]

if pass then
pass(self, info, val)
val = info[key] -- Get the modified result
else
info[key] = val
end

return val, info.ent
end

function ENT:SetControllerCol(index, col)
local infoEnt
col, infoEnt = applyPropertyWithKVPass(self, index, "col", col)
if col == nil then return end
if not IsValid(infoEnt) then return end

refreshSetColor(infoEnt, col)
end

function ENT:SetControllerPos(index, linkpos)
local infoEnt
linkpos, infoEnt = applyPropertyWithKVPass(self, index, "linkpos", linkpos)
if linkpos == nil then return end
if not IsValid(infoEnt) then return end

refreshSetPosAng(infoEnt, self.prop2mesh_controllers[index], self)
end

function ENT:SetControllerAng(index, linkang)
local infoEnt
linkang, infoEnt = applyPropertyWithKVPass(self, index, "linkang", linkang)
if linkang == nil then return end
if not IsValid(infoEnt) then return end

refreshSetPosAng(infoEnt, self.prop2mesh_controllers[index], self)
end

function ENT:SetControllerMat(index, mat)
local infoEnt
mat, infoEnt = applyPropertyWithKVPass(self, index, "mat", mat)
if mat == nil then return end
if not IsValid(infoEnt) then return end

Ent_SetMaterial(infoEnt, mat)
end

function ENT:SetControllerScale(index, scale)
local infoEnt
scale, infoEnt = applyPropertyWithKVPass(self, index, "scale", scale)
if scale == nil then return end
if not IsValid(infoEnt) then return end

refreshSetScale(infoEnt, scale)
end


--[[

]]
local kvpass = {}
kvpass.crc = function(self, info, val)
local crc = info.crc
info.crc = val
Expand Down Expand Up @@ -667,7 +742,8 @@ kvpass.mat = function(self, info, val)
end

kvpass.scale = function(self, info, val)
info.scale = Vector(unpack(val))
if type(val) == "table" then val = Vector(unpack(val)) end
info.scale = val
end

kvpass.clips = function(self, info, val)
Expand Down
20 changes: 20 additions & 0 deletions lua/entities/sent_prop2mesh/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,16 @@ function ENT:SetControllerLinkPos(index, val)
end
end

function ENT:GetControllerLinkPos(index)
local info = self.prop2mesh_controllers[index]
if not info then return end

local linkpos = info.linkpos
if not linkpos then return Vector() end

return Vector(linkpos.x, linkpos.y, linkpos.z)
end

function ENT:SetControllerLinkAng(index, val)
local info = self.prop2mesh_controllers[index]
if (info and isangle(val)) then
Expand All @@ -453,6 +463,16 @@ function ENT:SetControllerLinkAng(index, val)
end
end

function ENT:GetControllerLinkAng(index)
local info = self.prop2mesh_controllers[index]
if not info then return end

local linkang = info.linkang
if not linkang then return Angle() end

return Angle(linkang.p, linkang.y, linkang.r)
end

function ENT:SetControllerName(index, val)
local info = self.prop2mesh_controllers[index]
if (info and isstring(val)) and (info.name ~= val) then
Expand Down
124 changes: 122 additions & 2 deletions lua/starfall/libs_cl/prop2mesh.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,33 @@ return function( instance )
local p2m_library = instance.Libraries.p2m
local owrap, ounwrap = instance.WrapObject, instance.UnwrapObject
local ents_methods, wrap, unwrap = instance.Types.Entity.Methods, instance.Types.Entity.Wrap, instance.Types.Entity.Unwrap
local ang_meta, aunwrap = instance.Types.Angle, instance.Types.Angle.Unwrap
local vec_meta, vunwrap = instance.Types.Vector, instance.Types.Vector.Unwrap
local ang_meta, awrap, aunwrap = instance.Types.Angle, instance.Types.Angle.Wrap, instance.Types.Angle.Unwrap
local vec_meta, vwrap, vunwrap = instance.Types.Vector, instance.Types.Vector.Wrap, instance.Types.Vector.Unwrap
local col_meta, cwrap, cunwrap = instance.Types.Color, instance.Types.Color.Wrap, instance.Types.Color.Unwrap
local checkpermission = instance.player ~= SF.Superuser and SF.Permissions.check or function() end

local recycle = prop2mesh.recycle


local function getControllerInfo(ent, index)
CheckLuaType(index, TYPE_NUMBER)

local controllers = ent.prop2mesh_controllers
if not controllers then
SF.Throw("This function is limited to sf controllers!", 3)
return false
end

local info = controllers[index]
if not info then
SF.Throw(string.format("controller index %d does not exist on %s!", index, tostring(ent)), 3)
return false
end

return info
end


--- Manually sets controller info from a table clientside. It's important to note that this does not set the controller info serverside, so any modifications made to this P2M, dupe copying, etc. will not copy the inputted info
-- @param number index index of controller
-- @param table controllerData controller table to insert
Expand All @@ -59,4 +80,103 @@ return function( instance )
prop2mesh.handleDownload(dataCRC, controllerDataComp)
prop2mesh.refresh(ent, controller)
end

function ents_methods:p2mGetCount()
CheckType(self, ents_metatable)
local ent = unwrap(self)
local controllers = ent.prop2mesh_controllers
if not controllers then SF.Throw("This function is limited to sf controllers!", 2) end

return #controllers
end

function ents_methods:p2mSetColor(index, color)
CheckType(self, ents_metatable)
local ent = unwrap(self)
if not getControllerInfo(ent, index) then return end
checkpermission(instance, ent, "entities.setRenderProperty")

ent:SetControllerCol(index, cunwrap(color))
end

function ents_methods:p2mGetColor(index)
CheckType(self, ents_metatable)
local ent = unwrap(self)

return cwrap(getControllerInfo(ent, index).col)
end

function ents_methods:p2mSetAlpha(index, alpha)
CheckType(self, ents_metatable)
CheckLuaType(alpha, TYPE_NUMBER)
local ent = unwrap(self)
local info = getControllerInfo(ent, index)
if not info then return end
checkpermission(instance, ent, "entities.setRenderProperty")

info.col.a = alpha
ent:SetControllerCol(index, info.col)
end

function ents_methods:p2mSetPos(index, pos)
CheckType(self, ents_metatable)
local ent = unwrap(self)
if not getControllerInfo(ent, index) then return end
checkpermission(instance, ent, "entities.setRenderProperty")

ent:SetControllerPos(index, vunwrap(pos))
end

function ents_methods:p2mGetPos(index)
CheckType(self, ents_metatable)
local ent = unwrap(self)
local info = getControllerInfo(ent, index)
if not info then return end

return vwrap(info.linkpos or Vector())
end

function ents_methods:p2mSetAng(index, ang)
CheckType(self, ents_metatable)
local ent = unwrap(self)
if not getControllerInfo(ent, index) then return end
checkpermission(instance, ent, "entities.setRenderProperty")

ent:SetControllerAng(index, aunwrap(ang))
end

function ents_methods:p2mGetAng(index)
CheckType(self, ents_metatable)
local ent = unwrap(self)
local info = getControllerInfo(ent, index)
if not info then return end

return awrap(info.linkang or Angle())
end

function ents_methods:p2mSetMaterial(index, mat)
CheckType(self, ents_metatable)
CheckLuaType(mat, TYPE_STRING)
local ent = unwrap(self)
if not getControllerInfo(ent, index) then return end
checkpermission(instance, ent, "entities.setRenderProperty")

ent:SetControllerMat(index, mat)
end

function ents_methods:p2mGetMaterial(index)
CheckType(self, ents_metatable)
local ent = unwrap(self)

return getControllerInfo(ent, index).mat
end

function ents_methods:p2mSetScale(index, scale)
CheckType(self, ents_metatable)
local ent = unwrap(self)
if not getControllerInfo(ent, index) then return end
checkpermission(instance, ent, "entities.setRenderProperty")

ent:SetControllerScale(index, vunwrap(scale))
end
end
Loading