Scripts

[Scripts]

fn_init() : Void
To initialize the script should use this function.
Before using a different script, please use this script once.

fn_final() : Void
fn_init free.

fn_socket_make(Port, Limit, Space Number, Join Space) : Handle
Create a new server.
port : An integer of 1 to 65535.
limit : To limit the messages from the socket. (Byte)
If it fails, returns 0.

fn_socket_join(IP, Port, Limit, Join Space) : Handle
Join a server.
If it fails, returns 0.

fn_socket_close(Handle) : Void
Turn off the connection to the server.

fn_get_error_string() : Error String
If there is an error, returns it as a string.

This script is associated with the following script.
- fn_socket_make
- fn_socket_join
- fn_message_receive

fn_message_receive(Handle) : Void
Socket error check.
Player exit check.
New player allow.
Message check.

User Defined 0: occurs when a message is received.

User Defined 1: occurs when a player sent off. (only for server).
in this case,
fn_get_message_send_space() is return a exited player space.
fn_get_message_send_id() is return a exited player id.

User Defined 2: occurs when a server sent off. (only for player)

User Defined 3: occurs when a player moved space. (only for server).
in this case,
fn_get_message_send_space() is return the brfore player's space.
fn_get_message_id() is returns the current player's space.
fn_get_message_send_id() is return a space moved player id.

fn_get_receive_handle() : Handle
Return the message received handle.

fn_get_message_send_space() : Space
Get message send player space.

fn_get_message_id() : Message id
Get message id.

fn_get_message_send_id() : Player id
Get message send player id.

fn_message_break() : Void
in User Defined 0, exit without receiving the messages during 'in fn_message_receive'.
when "room_goto()" or "room_*", use this script.

fn_message_skip() : Void
in User Defined 0, This message skip. If you use this script, the message is stored in the receive buffer. So, next time, when you called fn_message_receive(), this receive buffer is called.

fn_message_send(Handle, To space, To player id, Message ID) : Void
Message send.
messageid : type is ushort. (0~65535)

To Space
-(number of space)
-to_my_space
-to_every_space
-to_other_space

To player id.
- (number of playerid), To player.
- send_server, To server.
- send_all, To all. (except own and server)
- send_all_server, To all. (except own)
- send_all_me, To all (except server).
- send_all_server_me, To all.
- send_other, To other player.

fn_get_my_space(Handle) : Space
Get my space.

fn_get_my_player_id(Handle) : Player id
Get my playerid.

fn_get_player_number(Handle) : Player Number
Get player number of server.
Only the server can use this script.

fn_get_space_player_number(Handle, Space) : Space Join Player Number
Get player number of space.
Only the server can use this script.

fn_get_space_player_ds_list(Handle, Space) : Ds_List id
Returns the ds_list id of participants that is connected to the handle. (Except the server)
Do not modify any data.
Only the server can use this script.

fn_get_player_ip_address(Handle, Player id) : IP Address
Get player IP address. (Except the server)
Only the server can use this script.

fn_set_my_space(Handle, Join Space) : Void
Set my space.

fn_set_player_accept_max(Handle, Max player number) : Void
Set max player of server.
If the -1 is not limited. The default value is -1.
Only the server can use this script.

[Buffers]

write_string_v2(fnv_send, String) : Void
String variables stored in the storage buffer. This script a little slower than direct write buffer function.

read_string_v2(fnv_message) : String
Returns a string in the message. This script a little slower than direct write buffer function.