Functions
	netUserGetItemValue (netstr, userstr, item)
	Get a user item value. More...

	netUserSetItemValue (netstr, userstr, item, val)
	Set a user item value. More...

	netRoomGetItemValue (netstr, item)
	Get a room item value. More...

	netRoomSetItemValue (netstr, item, val)
	Set a room item value. More...

	netUserGetLogin (userstr)
	Get a user login. More...

	netUserGetId (userstr)
	Get a user id. More...

	netGetUserByLogin (netstr, login)
	Get a user by it's login. More...

	netGetUserById (netstr, id)
	Get a user by it's id. More...

	netThisId (netstr)
	Get the current client user id. More...

	netThisUser (netstr)
	Get the current client user. More...

	netThisLogin (netstr)
	Get the current client login. More...

	netGetNbUsers (netstr)
	Get the number of actual users. More...

	netSendFile (netstr, userstr, flag, cmd, filename)
	Send a file. More...

	netGetFile (netstr, userstr, flag, cmd, filename)
	Request a file. More...

	netSendMessageExt (netstr, cmd, message, arg)
	Send a message to the server with arguments. More...

	netSendMessage (netstr, cmd, message)
	Send a message to the server. More...

	netSendBroadMessageSecure (netstr, cmd, message, reply)
	Broad a secure message to all users connected in the same room. More...

	netSendBroadMessage (netstr, cmd, message, reply)
	Broad a message to all users connected in the same room. More...

	netUpdateUserItem (netstr, item, val)
	Set a client item value. More...

	netUpdateRoomItem (netstr, item, val)
	Set a room item value. More...

	netSendRsaMessage (netstr, cmd, message)
	Send a RSA encrypted message to the server. More...

	netSendPrivateMessageSecure (netstr, userstr, cmd, message)
	Send a secure private message to another user. More...

	netSendPrivateMessage (netstr, userstr, cmd, message)
	Send a private message to another user. More...

	netKickUser (netstr, userstr)
	Send a request to kick a user from the server. The user will be kicked only if several other users send this request. More...

	netFormatMessage (netstr, userstr, message)
	Format a message and replace itemname% by the user item values. More...

	netIsConnected (netstr)
	Get the connection state. More...

	netDisconnect (netstr)
	Disconnect from the server. More...

	netCreateExt (server, port, script, env)
	Create a network structure to prepare the connection to a server with advanced parameters. More...

	netCreate (server, port)
	Create a network structure to prepare the connection to a server. More...

	netCreateMinimum ()
	Create an empty NetComm structure. More...

	netConnect (netstr)
	Connect to a server. More...

	netReconnect (netstr)
	Force a server re connection. More...

	netSetServer (netstr, server, port)
	Set a server url and port. More...

	netChangeLogin (netstr, login)
	Change the current user login. More...

	netChangeRoom (netstr, room)
	Change the current room. More...

Detailed Description

OpenSpace3D Network API

Function Documentation

◆ netUserGetItemValue()

netUserGetItemValue	(	netstr	,
		userstr	,
		item
	)

Get a user item value.

Prototype: fun [NetComm NetUser S] S

Parameters

NetComm	: the network structure
NetUser	: the user structure
S	: the item name

Returns: S : the item value, or nil if not found

◆ netUserSetItemValue()

netUserSetItemValue	(	netstr	,
		userstr	,
		item	,
		val
	)

Set a user item value.

Prototype: fun [NetComm NetUser S S] I

Parameters

NetComm	: the network structure
NetUser	: the user structure
S	: the item name
S	: the new item value

Returns: 0

◆ netRoomGetItemValue()

netRoomGetItemValue	(	netstr	,
		item
	)

Get a room item value.

Prototype: fun [NetComm S] S

Parameters

NetComm	: the network structure
S	: the item name

Returns: S : the item value, or nil if not found

◆ netRoomSetItemValue()

netRoomSetItemValue	(	netstr	,
		item	,
		val
	)

Set a room item value.

Prototype: fun [NetComm S S] I

Parameters

NetComm	: the network structure
S	: the item name
S	: the new item value

Returns: 0

◆ netUserGetLogin()

netUserGetLogin ( userstr )

Get a user login.

Prototype: fun [NetUser] S

Parameters

NetUser : the user structure

Returns: S : the user login

◆ netUserGetId()

netUserGetId ( userstr )

Get a user id.

Prototype: fun [NetUser] I

Parameters

NetUser : the user structure

Returns: I : the user id

◆ netGetUserByLogin()

netGetUserByLogin	(	netstr	,
		login
	)

Get a user by it's login.

Prototype: fun [NetComm S] NetUser

Parameters

NetComm	: the network structure
S	: the user login

Returns: NetUser : the user structure or nil if not found

◆ netGetUserById()

netGetUserById	(	netstr	,
		id
	)

Get a user by it's id.

Prototype: fun [NetComm I] NetUser

Parameters

NetComm	: the network structure
I	: the user id

Returns: NetUser : the user structure or nil if not found

◆ netThisId()

netThisId ( netstr )

Get the current client user id.

Prototype: fun [NetComm] I

Parameters

NetComm : the network structure

Returns: I : the client user id

◆ netThisUser()

netThisUser ( netstr )

Get the current client user.

Prototype: fun [NetComm] NetUser

Parameters

NetComm : the network structure

Returns: NetUser : the user structure

◆ netThisLogin()

netThisLogin ( netstr )

Get the current client login.

Prototype: fun [NetComm] S

Parameters

NetComm : the network structure

Returns: S : the current user login

◆ netGetNbUsers()

netGetNbUsers ( netstr )

Get the number of actual users.

Prototype: fun [NetComm] I

Parameters

NetComm : the network structure

Returns: I : the number of actual users

◆ netSendFile()

netSendFile	(	netstr	,
		userstr	,
		flag	,
		cmd	,
		filename
	)

Send a file.

Prototype: fun [NetComm NetUser I S S] I

Parameters

NetComm	: the network structure
NetUser	: the user structure, this can be nil to send it to all users
I	: message flags, nil for default
S	: command
S	: the file name to request

Returns: 0

◆ netGetFile()

netGetFile	(	netstr	,
		userstr	,
		flag	,
		cmd	,
		filename
	)

Request a file.

Prototype: fun [NetComm NetUser I S S] I

Parameters

NetComm	: the network structure
NetUser	: the user structure, this can be nil to request it from all users
I	: message flags, nil for default
S	: command
S	: the file name to request

Returns: 0

◆ netSendMessageExt()

netSendMessageExt	(	netstr	,
		cmd	,
		message	,
		arg
	)

Send a message to the server with arguments.

Prototype: fun [NetComm S S S] I

Parameters

NetComm	: the network structure
S	: command
S	: message
S	: arguments

Returns: 0

◆ netSendMessage()

netSendMessage	(	netstr	,
		cmd	,
		message
	)

Send a message to the server.

Prototype: fun [NetComm S S] I

Parameters

NetComm	: the network structure
S	: command
S	: message

Returns: 0

◆ netSendBroadMessageSecure()

netSendBroadMessageSecure	(	netstr	,
		cmd	,
		message	,
		reply
	)

Broad a secure message to all users connected in the same room.

Prototype: fun [NetComm S S S] I

Parameters

NetComm	: the network structure
S	: command
S	: message
S	: reply

Returns: 0

◆ netSendBroadMessage()

netSendBroadMessage	(	netstr	,
		cmd	,
		message	,
		reply
	)

Broad a message to all users connected in the same room.

Prototype: fun [NetComm S S I] I

Parameters

NetComm	: the network structure
S	: command
S	: message
I	: 1 if the client must receive his hown sent message, 0 otherwise

Returns: 0

◆ netUpdateUserItem()

netUpdateUserItem	(	netstr	,
		item	,
		val
	)

Set a client item value.

Prototype: fun [NetComm S S] I

Parameters

NetComm	: the network structure
S	: the item name
S	: the new item value

Returns: 0

◆ netUpdateRoomItem()

netUpdateRoomItem	(	netstr	,
		item	,
		val
	)

Set a room item value.

Prototype: fun [NetComm S S] I

Parameters

NetComm	: the network structure
S	: the item name
S	: the new item value

Returns: 0

◆ netSendRsaMessage()

netSendRsaMessage	(	netstr	,
		cmd	,
		message
	)

Send a RSA encrypted message to the server.

Prototype: fun [NetComm S S] I

Parameters

NetComm	: the network structure
S	: command
S	: message

Returns: 0

◆ netSendPrivateMessageSecure()

netSendPrivateMessageSecure	(	netstr	,
		userstr	,
		cmd	,
		message
	)

Send a secure private message to another user.

Prototype: fun [NetComm NetUser S S] I

Parameters

NetComm	: the network structure
NetUser	: the destination user structure
S	: command
S	: message

Returns: 0

◆ netSendPrivateMessage()

netSendPrivateMessage	(	netstr	,
		userstr	,
		cmd	,
		message
	)

Send a private message to another user.

Prototype: fun [NetComm NetUser S S] I

Parameters

NetComm	: the network structure
NetUser	: the destination user structure
S	: command
S	: message

Returns: 0

◆ netKickUser()

netKickUser	(	netstr	,
		userstr
	)

Send a request to kick a user from the server.
The user will be kicked only if several other users send this request.

Prototype: fun [NetComm NetUser] I

Parameters

NetComm	: the network structure
NetUser	: the user structure to kick

Returns: 0

◆ netFormatMessage()

netFormatMessage	(	netstr	,
		userstr	,
		message
	)

Format a message and replace itemname% by the user item values.

Prototype: fun [NetComm NetUser S] S

Parameters

NetComm	: the network structure
NetUser	: the user structure
S	: the message to format

Returns: S : the formated message

◆ netIsConnected()

netIsConnected ( netstr )

Get the connection state.

Prototype: fun [NetComm] I

Parameters

NetComm : the network structure

Returns: I : 1 if the connection is available, 0 if not

◆ netDisconnect()

netDisconnect ( netstr )

Disconnect from the server.

Prototype: fun [NetComm] I

Parameters

NetComm : the network structure

Returns: 0

◆ netCreateExt()

netCreateExt	(	server	,
		port	,
		script	,
		env
	)

Create a network structure to prepare the connection to a server with advanced parameters.

Prototype: fun [S I S Env] NetComm

Parameters

S	: the server name or ip address
I	: the server port
S	: the connection script
Env	: the scol environment

Returns: NetComm : the new network structure

◆ netCreate()

netCreate	(	server	,
		port
	)

Create a network structure to prepare the connection to a server.

Prototype: fun [S I] NetComm

Parameters

S	: the server name or ip address
I	: the server port

Returns: NetComm : the new network structure

◆ netCreateMinimum()

netCreateMinimum ( )

Create an empty NetComm structure.

Prototype: fun [] NetComm

Returns: NetComm : the new network structure

◆ netConnect()

netConnect ( netstr )

Connect to a server.

Prototype: fun [NetComm] I

Parameters

NetComm : the network structure

Returns: I : 1 if successful connected, 0 otherwise

◆ netReconnect()

netReconnect ( netstr )

Force a server re connection.

Prototype: fun [NetComm] I

Parameters

NetComm : the network structure

Returns: I : 1 if successful connected, 0 otherwise

◆ netSetServer()

netSetServer	(	netstr	,
		server	,
		port
	)

Set a server url and port.

Prototype: fun [NetComm S I] NetComm

Parameters

NetComm	: the network structure
S	: the server name or ip address
I	: the server port

Returns: NetComm : the same network structure

◆ netChangeLogin()

netChangeLogin	(	netstr	,
		login
	)

Change the current user login.

Prototype: fun [NetComm S] I

Parameters

NetComm	: the network structure
S	: the new requested login

Returns: 0

◆ netChangeRoom()

netChangeRoom	(	netstr	,
		room
	)

Change the current room.

Prototype: fun [NetComm S] I

Parameters

NetComm	: the network structure
S	: the new requested room

Returns: 0

Project

General

Profile

OpenSpace3D

Functions

Detailed Description

Function Documentation

◆ netUserGetItemValue()

◆ netUserSetItemValue()

◆ netRoomGetItemValue()

◆ netRoomSetItemValue()

◆ netUserGetLogin()

◆ netUserGetId()

◆ netGetUserByLogin()

◆ netGetUserById()

◆ netThisId()

◆ netThisUser()

◆ netThisLogin()

◆ netGetNbUsers()

◆ netSendFile()

◆ netGetFile()

◆ netSendMessageExt()

◆ netSendMessage()

◆ netSendBroadMessageSecure()

◆ netSendBroadMessage()

◆ netUpdateUserItem()

◆ netUpdateRoomItem()

◆ netSendRsaMessage()

◆ netSendPrivateMessageSecure()

◆ netSendPrivateMessage()

◆ netKickUser()

◆ netFormatMessage()

◆ netIsConnected()

◆ netDisconnect()

◆ netCreateExt()

◆ netCreate()

◆ netCreateMinimum()

◆ netConnect()

◆ netReconnect()

◆ netSetServer()

◆ netChangeLogin()

◆ netChangeRoom()