Forum

Extending native functions

Forums overview CS2D overview Scripts overview Log in to reply

Extending native functions

28 replies

To the start

Previous

1 2

Next

To the start

Extending native functions

Livia
User Off

Offline

20.09.13 07:13:36 pm

Hello,

I'm one of those who hate using player(id,value) function. It just makes my code ugly and unreadable. My solution for this is more object-like approach which simplifies the code a lot. Let me give you an example on what we can do with it:

1
2
3
4
5
6
7
8
9
10
11
12

Hook('say', 'say')
function say(ply, message)

    if message == "cheat" then
        ply.health = 100
        ply.speedmod = 20
        ply.money = ply.money + 1000
        ply.name = ply.name .. " is cheating"
        ply:msg("Have fun ;)")
        return 1
    end
end

You can also assign custom data to player objects because they are really just tables with a common metatable. Even though it has the player(id) constructor, it is still 100% compatible with the old player(id,value) method.

What do you think?

Edit:
Source code: https://github.com/tarjoilija/lapi

edited 3×, last 22.09.13 11:05:27 pm

Re: Extending native functions

Infinite Rain
Reviewer Off

Offline

20.09.13 07:35:59 pm

Very very useful, but I think that you have uploaded it before.

Re: Extending native functions

Livia
User Off

Offline

20.09.13 08:17:44 pm

@

user

Infinite Rain: Yes, I uploaded similar script a long time ago but then for some unknown reason I decided to remove it. However I think this one is better.

Re: Extending native functions

Avo
User

Offline

20.09.13 08:22:17 pm

So upload it one more time. US.de needs good files these days.

Re: Extending native functions

Livia
User Off

Offline

20.09.13 09:55:48 pm

@

user

Avo: It's actually included in my message but I'm afraid there's not many people making use of it. I'm also too lazy to write any kind of instructions on how it works.

Re: Extending native functions

EngiN33R
Moderator Off

Offline

20.09.13 10:07:32 pm

Well, I was trying to find this in the File Archive a while ago to include it in my modding API, and because I didn't find it I wrote a similar system myself. Nice to see this again! It's a really nice script in the spirit of Lua's syntactic sugar.

Also, now that I know why I couldn't find it, and now that it's available again, I'd like to ask you if you would give your permission to include this in my modding API (link one, link two).

Re: Extending native functions

Livia
User Off

Offline

20.09.13 10:28:55 pm

Your modding API looks really promising and I think many people could find use for that (if it has dumb-proof video instructions included). My code snippets are always free as in speech and free as in beer so go ahead and spread the love.

Re: Extending native functions

MikuAuahDark
User Off

Offline

20.09.13 11:11:35 pm

You should only return the address of the table so it can to be edited again by a hook( cs2d lua hook

cs2d lua hook

cs2d lua hook

hit,etc.)

EDIT: i am creating a similar function but the table doesn't updated when event occurs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

function Player.Exists(id)
	return (id~=nil and player(id,"exists"))
end

function Player.Name(id)
	return player(id,"name")
end

function Player.IP(id,returnasdecimal)
	if returnasdecimal then
		for a1,a2,a3,a4 in player(id,"ip"):gmatch("(%d+).(%d+).(%d+).(%d+)") do
			return a1*16777216+a2*65536+a3*256+a4
		end
	end
	return player(id,"ip")
end

function Player.Port(id)
	return player(id,"port")
end

function Player.USGN(id)
	return player(id,"usgn")
end

function Player.Idle(id)
	return player(id,"idle")
end

function Player.Bot(id)
	return player(id,"bot")
end

function Player.Team(id)
	return player(id,"team")
end

function Player.Skin(id)
	return player(id,"look")
end

function Player.X(id)
	return player(id,"x")
end

function Player.Y(id)
	return player(id,"y")
end

function Player.Rot(id,returnasrad)
	if returnasrad then
		return math.rad(player(id,"rot"))
	end
	return player(id,"rot")
end

function Player.TileX(id)
	return player(id,"tilex")
end

function Player.TileY(id)
	return player(id,"tiley")
end

function Player.Health(id)
	return player(id,"health")
			
function Player.MaxHealth(id)
	return player(id,"maxhealth")
end

function Player.Armor(id)
	return player(id,"armor")
end

function Player.Money(id)
	return player(id,"money")
end

function Player.Kills(id)
	return player(id,"score")
end
Player.Score=Player.Kills

function Player.Deaths(id)
	return player(id,"deaths")
end

function Player.Weapon(id)
	return player(id,"weapon")
end

function Player.WeaponList(id)
	return playerweapons(id)
end

function Player.Nightvision(id)
	return player(id,"nightvision")
end

function Player.Defusekit(id)
	return player(id,"defusekit")
end

function Player.Gasmask(id)
	return player(id,"gasmask")
end

function Player.Bomb(id)
	return player(id,"bomb")
end

function Player.Flag(id)
	return player(id,"flag")
end

function Player.Reloading(id)
	return player(id,"reloading")
end

function Player.Process(id)
	return player(id,"process")
end

function Player.Votekick(id)
	return player(id,"votekick")
end

function Player.Votemap(id)
	return player(id,"votemap")
end

function Player.Speedmod(id)
	return player(id,"speedmod")
end

function Player.RCon(id)
	return player(id,"rcon")
end

setmetatable(Player,{
__call=function(_,id)
	if id then
		local tmp={}
		for n,v in pairs(_) do
			tmp[n]=v(id)
		end
		return tmp
	else
		local tmp1={}
		for _,pl in pairs(player(0,"table")) do
			local tmp2={}
			for n,v in pairs(_) do
				tmp2[n]=v(id)
			end
			tmp1[pl]=tmp2
		end
		return tmp1
	end
end
})

It has all argument type of cs2d lua cmd

cs2d lua cmd

player

And at user

user

Livia code, there is a code-writing mistakes at here:

1
2
3
4
5
6
7
8
9
10
11

elseif key == 'x' then
        self:setpos(value, self.y)
    elseif key == 'tilex' then
        self:setpos(value * 16, self.y)
    elseif key == 'y' then
        self:setpos(self.x, value)
    elseif key == 'tiley' then
        self:setpos(self.x, value * 16)
    else
        rawset(self, key, value)
    end

He/she just put X as Y and Y as X

edited 2×, last 20.09.13 11:56:27 pm

Re: Extending native functions

Livia
User Off

Offline

21.09.13 01:05:59 am

user

MikuAuahDark has written

You should only return the address of the table so it can to be edited again by a hook(cs2d lua hook always,cs2d lua hook hit,etc.)

Which table? Which return?

user

MikuAuahDark has written

He/she just put X as Y and Y as X

Are you sure? Everything worked fine for me.

Re: Extending native functions

MikuAuahDark
User Off

Offline

21.09.13 07:53:27 am

user

Livia has written

Which table? Which return?

A table that can be updated by CS2D when special event occurs. Example for health and armor table changing:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

PlayerListTables={}

-- Let's use ID 5 for this simulation
PlayerListTables[5]={100,100}	-- Health 100 and armor 100

addhook("hit","change_table_value_by_address")
function change_table_value_by_address(id,pl,w,hp,ap)
	PlayerListTables[id][1]=player(id,"health")-hp
	PlayerListTables[id][2]=player(id,"armor")-ap
end

-- Let's try
PHealth=PlayerListTables[5]
print(PHealth[1].." "..PHealth[2])	-- 100 100
change_table_value_by_address(5,1,45,5,2)	-- Player with ID 5 is hit. His health and armor decreased by 5 and 2
print(PHealth[1].." "..PHealth[2])	-- 95 98

Code above is still use variable PHealth but it change the table value by cs2d lua hook

cs2d lua hook

hit. the table address is stored at PlayerListTables[5] and it's same as PHealth table. So changing value of PHealth variable(not re-create the table) also changing value of PlayerListTables[5] variable.
At-least you doesn't change the table. example for wrong hit code

1
2
3
4

addhook("hit","change_table_value_by_address")
function change_table_value_by_address(id,pl,w,hp,ap)
	PlayerListTables[id]={player(id,"health")-hp,player(id,"armor")-ap}
end

Code above will invalid and doesn't change the values when someone is hit.

user

Livia has written

Are you sure? Everything worked fine for me.

Nevermind about this. I am doesn't read the code correctly. Now i get it.

Re: Extending native functions

Livia
User Off

Offline

21.09.13 10:15:46 am

Storing custom data to player objects was actually implemented in the older version. The code was holding player_data table and returning players from there instead of creating a new table every time. However this leaded to at least one problem: who should make sure that custom data is erased when player disconnects? I decided not to use any kind of hooks in my code.
However your point is good. It would be better if it had one table maintaining every player. See the example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

dofile("sys/lua/player.lua")

addhook('join', 'join')
function join(id)
    local p = player(id)
    
    p.isAdmin = false -- custom variable is set here
end

addhook('say', 'say')
function say(id, message)
    local p = player(id)
    
    if message == "admin" then
        p.isAdmin = true
        p:msg("admin powa")
        return 1
    end
    
    if message == "cheat" and p.isAdmin then
        p.health = 100
        p.money = p.money + 1000
        p.x = p.x + 5
        p.name = p.name .. " IS CHEATER!!!"
        p:msg("Have fun ;)")
        return 1
    end
end

updated source code here

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

--[[

x
    kick(reason)
    spawn()
    strip(wpn)
    slap()
    kill()
    msg(message)
    setpos(x, y)

rw
    name
    team
    x
    y
    tilex
    tiley
    health
    armor
    money
    score
    deaths
    speedmod
    maxhealth

r
    exists
    ip
    port
    usgn
    ping
    idle
    bot
    look
    rot
    teamkills
    hostagekills
    teambuildingkills
    weapontype
    nightvision
    defusekit
    gasmask
    bomb
    flag
    reloading
    process
    sprayname
    spraycolor
    votekick
    votemap
    favteam
    rcon
    ai_flash

]]

_player = player

player = {}
player.mt = {}
player.data = {}
player.indextable = {
    armor = 'setarmor',
    health = 'sethealth',
    speedmod = 'speedmod',
    score = 'setscore',
    deaths = 'setdeaths',
    maxhealth = 'setmaxhealth',
    score = 'setscore',
    money = 'setmoney'
}

setmetatable(player, {
    __call = function(_, id, str)
        if str then
            return _player(id, str)
        elseif player.data[id] then
            return player.data[id]
        else
            local p = setmetatable({id = id}, player.mt)
            player.data[id] = p
            return p
        end
    end
})

function player.mt:__index(key)
    local m = rawget(player.mt, key)
    if m == nil then
        return _player(self.id, key)
    else
        return m
    end
end

function player.mt:__newindex(key, value)
    if player.indextable[key] ~= nil then
        parse(player.indextable[key] .. ' ' .. self.id .. ' ' .. value)
    elseif key == 'name' then
        parse('setname ' .. self.id .. ' "' .. value .. '" 1')
    elseif key == 'team' then
        if value == 1 then
            parse('maket ' .. self.id)
        elseif value == 2 then
            parse('makect ' .. self.id)
        else
            parse('makespec ' .. self.id)
        end
    elseif key == 'x' then
        self:setpos(value, self.y)
    elseif key == 'tilex' then
        self:setpos(value * 16, self.y)
    elseif key == 'y' then
        self:setpos(self.x, value)
    elseif key == 'tiley' then
        self:setpos(self.x, value * 16)
    else
        rawset(self, key, value)
    end
end

function player.mt:setpos(x, y)
   parse('setpos ' .. self.id .. ' ' .. x .. ' ' .. y) 
end

function player.mt:kick(reason)
    parse('kick ' .. self.id .. ' ' .. reason)
end

function player.mt:spawn(x, y)
    parse('spawnplayer ' .. self.id .. ' ' .. x .. ' ' .. y)
end

function player.mt:strip(wpn)
    parse('strip ' .. self.id .. ' ' .. wpn)
end

function player.mt:slap()
    parse('slap ' .. self.id)
end

function player.mt:kill()
    parse('killplayer ' .. self.id)
end

function player.mt:msg(message)
    msg2(self.id, message)
end

Re: Extending native functions

MikuAuahDark
User Off

Offline

21.09.13 11:04:54 am

Well, i am creating a function similar to it. It's uses 1 table address everytime

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

Player={}

for v=1,32 do
	local temp={}
	temp.msg=function(m)
		msg2(v,m)
	end
	temp.equip=function(w)
		parse("equip "..v.." "..w)
	end
	temp.strip=function(w)
		parse("strip "..v.." "..w)
	end
	temp.spawn=function()
		local t=player(v,"team")
		if t>0 then
			if t==3 then t=2 end
			local x,y=randomentity(player(v,"team")-1)
			parse("spawnplayer "..v.." "..(x*32+16).." "..(y*32+16))
		end
	end
	temp.kick=function(r)
		parse("kick "..v.." \""..r.."\"")
	end
	temp.kill=function()
		parse("killplayer "..v)
	end
	temp.
	setmetatable(temp,{
		__index=function(_,var)
			return player(v,var)
		end,
		__newindex=function(_,var,val)
			if var=="name" then parse("setname "..v.." "..val)
			elseif var=="team" then
				if val==0 then
					parse("makespec "..v)
				elseif val==1 then
					parse("maket "..v)
				elseif val==2 or val==3 then
					parse("makect "..v)
				end
			elseif var=="x" then parse("setpos "..v.." "..val.." "..player(v,"y"))
			elseif var=="y" then parse("setpos "..v.." "..player(v,"x").." "..val)
			elseif var=="tilex" then parse("setpos "..v.." "..(val*32+16).." "..(math.floor(player(v,"y")/32)*32+16))
			elseif var=="tiley" then parse("setpos "..v.." "..(math.floor(player(v,"x")/32)*32+16).." "..(val*32+16))
			elseif var=="health" then parse("sethealth "..v.." "..val)
			elseif var=="armor" then parse("setarmor "..v.." "..val)
			elseif var=="money" then parse("setmoney "..v.." "..val)
			elseif var=="score" then parse("setscore "..v.." "..val)
			elseif var=="deaths" then parse("setdeaths "..v.." "..val)
			elseif var=="speedmod" then parse("speedmod "..v.." "..val)
			elseif var=="maxhealth" then
				local health=player(v,"health")
				parse("setmaxhealth "..v.." "..val)
				parse("sethealth "..v.." "..health)
			end
		end
	})
	Player[v]=temp
end

setmetatable(Player,{
__call=function(_,id)
	if _[id].exists then
		return _[id]
	end
end
})

It's only uses 1 table address/player, not to create the table anytime. So it uses 32 static table. When player disconnects, the table doesn't erased.

Example for static table address:

1
2
3

AuahDark=Player(1)
print(AuahDark)	-- table: xxxxxxxx
print(AuahDark==Player(1))	-- true

user

Livia has written

who should make sure that custom data is erased when player disconnects?

You don't need to erase it. That's why cs2d lua cmd

cs2d lua cmd

player(id,"exists") is useful for this.

Re: Extending native functions

VADemon
User Off

Offline

21.09.13 11:32:43 am

@

user

MikuAuahDark: Don't forget that most usernames contain special characters.

Re: Extending native functions

MikuAuahDark
User Off

Offline

21.09.13 11:33:48 am

What's wrong with the special characters?

Re: Extending native functions

VADemon
User Off

Offline

21.09.13 11:41:53 am

I misunderstood you and thought that you're going to use player names as table names

Re: Extending native functions

Livia
User Off

Offline

21.09.13 05:13:15 pm

Now it's getting interesting. I've continued working on the player class and so far you can easily return tables of player objects.

Edit: Here's some more cool stuff!
Edit2: Also added custom hook wrapper which will call functions with player objects instead of player ids.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

dofile('sys/lua/lapi/lapi.lua')

Hook.add('join', 'hook_join')
function hook_join(p)
    p.is_admin = false              -- custom data added to player object
end

Hook.add('say', 'hook_say')
function hook_say(p, message)

    if message == 'admin' then
        p.is_admin = true
        p:msg("Admin :3")
        return 1
    end
    
    if message == 'I am poor' then
        p.money = p.money + 1000
    end
    
    if message == 'arm' and p.is_admin then
        p.weapons = {3, 45, 51, 32} -- automatically strip and equip weapons
        p.weapon = 45               -- switch current weapon
        p.speedmod = 100            -- cheat
        p:msg('Laser power!')       -- send message to the player
        return 1
    end

    if message == "kill_t" then
        local tbl = Player.team1living -- returns a table with all living terrorists
        for k,v in pairs(tbl) do
            v:kill()
        end
        p:msg("You just killed "..#tbl.." terrorists!")
        return 1
    end
end

Source code: https://github.com/tarjoilija/lapi/
Documentation: https://github.com/tarjoilija/lapi/blob/master/DOCUMENTATION

edited 5×, last 22.09.13 04:59:51 pm

Re: Extending native functions

Infinite Rain
Reviewer Off

Offline

22.09.13 01:21:15 pm

Dude, it's epic! Expecting more work from you. Do the same to objects!

Re: Extending native functions

Livia
User Off

Offline

22.09.13 05:50:52 pm

user

Infinite Rain has written

Dude, it's epic! Expecting more work from you. Do the same to objects!

Do you mean something like this?

Re: Extending native functions

Infinite Rain
Reviewer Off

Offline

22.09.13 06:11:36 pm

@

user

Livia:
Yep, just like that. You're genius.

Re: Extending native functions

Livia
User Off

Offline

23.09.13 02:18:34 pm

Yet another update. Here's a simple hat script for you showing plenty of the features of Love API.

Edit: Added file saving/loading plugin.

Edit2: Okay, I had to add hat plugin too

Always up-to-date source code here.

edited 3×, last 23.09.13 10:39:46 pm

To the start

Previous

1 2

Next

To the start

Log in to reply Scripts overview CS2D overview Forums overview