Since we'll be using our own module for data communication and player-information stuff, there are quite a number of commands associated with it. This topics provides you with an overview of the added commands and some basic information on how they should be used. Various less-used commands, to register/unregister the player in the core for example, aren't documented as good because there is no need for them to be.
int registerPlayerOnJoin ( player thePlayer )
This command will be used in the Core to register the player with the Core itself, so we get a player ID assigned. The ID number is returned as the first return parameter, and can be used for various LVP-related functions.
nil unregisterPlayerOnQuit ( player thePlayer )
Ofcourse, whenthe player is done with playing on Las Venturas Playground we have to unregister him/her to make space for another player. That's what this function is here to do. Be sure that this is the absolute last thing done before he/she disconnects.
int getPlayerID ( player thePlayer )
Can be used throughout the script to get the ID of a specific player, identified by the first argument. This will be used with our own chat, ban, user, private-message etc. commands, so we don't have to type full player names. Purely for convenience.
bool isPlayerRadarBlipVisible ( player thePlayer )
This function can be used to check whether the blip of a specific player on the radar is visible or not. If it's not visible, do NOT make it visible again unless you were the one who made it invisible. Except for player fixage commands ofcourse.
nil togglePlayerRadarBlip ( player thePlayer )
This command can be used to toggle the blip of a specific player on the radar. Be sure to clean this up, as other features should not change this setting unless it's properly visible, as will be the case on default.
nil echoMessage ( string message )
This command will send a message directly to IRC for the bots to handle. Be sure that this must be in the proper IRC Echo syntax, which will be documented in another topic. No mIRC-colour-codes should be used in this function at all, as formatting must be handled by the Nuwani sisters.
int logPlayerIn ( player thePlayer )
A command which must only be used in the core, that can login players when their autorisation has been successfull. Password checking has already been done in prior stages in the login-process, so we don't have to worry about that. Returned is the Skin he/she needs to spawn with, or -1 if there is no default skin selected.
int registerPlayerOnJoin ( player thePlayer )
This command will be used in the Core to register the player with the Core itself, so we get a player ID assigned. The ID number is returned as the first return parameter, and can be used for various LVP-related functions.
nil unregisterPlayerOnQuit ( player thePlayer )
Ofcourse, whenthe player is done with playing on Las Venturas Playground we have to unregister him/her to make space for another player. That's what this function is here to do. Be sure that this is the absolute last thing done before he/she disconnects.
int getPlayerID ( player thePlayer )
Can be used throughout the script to get the ID of a specific player, identified by the first argument. This will be used with our own chat, ban, user, private-message etc. commands, so we don't have to type full player names. Purely for convenience.
bool isPlayerRadarBlipVisible ( player thePlayer )
This function can be used to check whether the blip of a specific player on the radar is visible or not. If it's not visible, do NOT make it visible again unless you were the one who made it invisible. Except for player fixage commands ofcourse.
nil togglePlayerRadarBlip ( player thePlayer )
This command can be used to toggle the blip of a specific player on the radar. Be sure to clean this up, as other features should not change this setting unless it's properly visible, as will be the case on default.
nil echoMessage ( string message )
This command will send a message directly to IRC for the bots to handle. Be sure that this must be in the proper IRC Echo syntax, which will be documented in another topic. No mIRC-colour-codes should be used in this function at all, as formatting must be handled by the Nuwani sisters.
int logPlayerIn ( player thePlayer )
A command which must only be used in the core, that can login players when their autorisation has been successfull. Password checking has already been done in prior stages in the login-process, so we don't have to worry about that. Returned is the Skin he/she needs to spawn with, or -1 if there is no default skin selected.