stingray.PsnRoomBrowser object reference

Description

The PsnRoomBrowser provides access to the list of game rooms available on the PlayStation Network (PSN).

Call refresh() to refresh the list.

Call num_rooms() to get the number of available rooms, and call room() to retrieve detailed information about each of those rooms. You can use these details to determine if you want to join the room, and the room ID needed in order to connect.

Constructors and accessors

stingray.PsnClient.room_browser()

Other related reference items

PSN

Functions

is_refreshing ( self ) : boolean Indicates whether or not the room browser is currently refreshing its internal list of available rooms on the PlayStation Network.

Parameters

self :

stingray.PsnRoomBrowser

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

boolean

Returns true if the room browser is currently refreshing its list, or false otherwise.

If this function returns true, calling refresh() will have no effect.

num_rooms ( self ) : integer Returns the number of available rooms found on the PlayStation Network.

Parameters

self :

stingray.PsnRoomBrowser

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

integer

The number of available rooms.

refresh ( self ) Refreshes the list of available game rooms on the PlayStation Network.

Parameters

self :

stingray.PsnRoomBrowser

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

Other related reference items

stingray.PsnRoomBrowser.is_refreshing()

room ( self, index ) : network_psn_room_info Returns details about the specified room, including the ID that you must use to connect to the room.

Parameters

self :	stingray.PsnRoomBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
index :	integer	The index number of the room to retrieve from the list maintained by the room browser.

Returns

network_psn_room_info

A table that contains detailed information about the specified room.

Other related reference items

	network_psn_room_info
	stingray.Network.join_psn_room() stingray.PsnRoom.set_data() stingray.PsnRoom.set_name()