Goonstation 13 - Modules - TypesVar Details - Proc Details

/client

Vars

applied_keybind_stylesList on each client containing the styles we've applied so we don't double-apply.
refresh_varedit_onchangecontrols whether or not the varedit page is refreshed after altering variables
saturation_matrixsaturation_matrix: the client's game saturation color_matrix: the client's game color (tint)
tgui_windowsglobal

Procs

TestMarketReqProc to test a standard market contract for functionality. Test special orders with random event trigger instead.
apply_keybind
apply_keys
build_listIteratively build a new list, then return it.
check_newbeemarks a player as a newbee if they are below the newbee rounds threshold. Grants them various new player indicators.
cmd_admin_show_player_statsA bunch of procs for showing admins player data from the central API databases
enable_waterflowmob/EnteredAirborneFluid(obj/fluid/F as obj, atom/oldloc)
getDefaultVolumeReturns the default volume for a channel, unattenuated for the master channel (0-1)
getMasterVolumeReturns the master volume (0-1)
getRealVolumeReturns the true volume for a channel, unattenuated for the master channel (0-1)
getVolumeReturns the volume to set /sound/var/volume to for the given channel(so 0-100)
getVolumeChannelDescriptionGet the friendly description for a specific sound channel.
getVolumeDescriptionsReturns a list of friendly descriptions for available sound channels
getVolumeNamesReturns a list of friendly names for available sound channels
get_keybind_style_datum
has_login_notice_pendingReturns 1 if a login message is pending, 0 otherwise
input_dataFor inputting data for things like edit-variables, proccall, etc Generally you should only use the associated defines for allowed_types. However, you CAN display anything as a choice for the user, allowing for custom prompts for specific cases. Just make sure the caller can handle the case! @param allowed_types The types of input which are allowed, which the user selects from. The selected type is returned as part of the data_input_result @param custom_title If not null, set as the title for the input @param custom_text If not null, set as the text for the input @param default The default value, if default_type is chosen as the input type @param default_type The default input type @param custom_type_title If not null, set as the title for input type selection @param custom_type_message If not null, set as the text for input type selection @return A data_input_result with the parsed input and the selected input type, or both null if we didn't get any data
playAmbience
setVolumeSets and applies the volume for a channel (0-1)
show_login_noticeShows a login notice, if one exists
suggest_input_typeGet a suggested input type based on the thing you're editing @param var_value The value to evaluate @param varname The name of the variable @return Suggested input type for input_data()
uicloseverb
viewnewvote/mob/verb/vote_new() set name = "Initiate Vote"
vpn_bonkboots player and displays VPN message

Var Details

applied_keybind_styles

List on each client containing the styles we've applied so we don't double-apply.

refresh_varedit_onchange

controls whether or not the varedit page is refreshed after altering variables

saturation_matrix

saturation_matrix: the client's game saturation color_matrix: the client's game color (tint)

tgui_windows

global

Tracks open windows for a user.

Proc Details

TestMarketReq

Proc to test a standard market contract for functionality. Test special orders with random event trigger instead.

Will add the contract to requisitions list and pin the contract, ignoring the one-pin limit or any contract type pin restrictions. Don't use this in live rounds, pin behavior will be wonky.

apply_keybind

apply_keys

build_list

Iteratively build a new list, then return it.

check_newbee

marks a player as a newbee if they are below the newbee rounds threshold. Grants them various new player indicators.

cmd_admin_show_player_stats

A bunch of procs for showing admins player data from the central API databases

Verbs

enable_waterflow

mob/EnteredAirborneFluid(obj/fluid/F as obj, atom/oldloc)

getDefaultVolume

Returns the default volume for a channel, unattenuated for the master channel (0-1)

getMasterVolume

Returns the master volume (0-1)

getRealVolume

Returns the true volume for a channel, unattenuated for the master channel (0-1)

getVolume

Returns the volume to set /sound/var/volume to for the given channel(so 0-100)

getVolumeChannelDescription

Get the friendly description for a specific sound channel.

getVolumeDescriptions

Returns a list of friendly descriptions for available sound channels

getVolumeNames

Returns a list of friendly names for available sound channels

get_keybind_style_datum

has_login_notice_pending

Returns 1 if a login message is pending, 0 otherwise

input_data

For inputting data for things like edit-variables, proccall, etc Generally you should only use the associated defines for allowed_types. However, you CAN display anything as a choice for the user, allowing for custom prompts for specific cases. Just make sure the caller can handle the case! @param allowed_types The types of input which are allowed, which the user selects from. The selected type is returned as part of the data_input_result @param custom_title If not null, set as the title for the input @param custom_text If not null, set as the text for the input @param default The default value, if default_type is chosen as the input type @param default_type The default input type @param custom_type_title If not null, set as the title for input type selection @param custom_type_message If not null, set as the text for input type selection @return A data_input_result with the parsed input and the selected input type, or both null if we didn't get any data

playAmbience

* Client part of the Area Ambience Project

* Calling this proc is handled by the Area our client is in, see [area/proc/Exited()] and [area/proc/Entered()]

* LOOPING channel sound will keep playing until fed a pass_volume of 0 (done automagically)
* For FX sounds, they will play once.

* FX_1 is area-specific background noise handled by area/pickAmbience(), FX_2 is more noticeable stuff directly triggered, normally shorter

setVolume

Sets and applies the volume for a channel (0-1)

show_login_notice

Shows a login notice, if one exists

suggest_input_type

Get a suggested input type based on the thing you're editing @param var_value The value to evaluate @param varname The name of the variable @return Suggested input type for input_data()

uiclose

verb

Called by UIs when they are closed. Must be a verb so winset() can call it.

required uiref ref The UI that was closed.

viewnewvote

/mob/verb/vote_new() set name = "Initiate Vote"

//if(!config.allow_vote_restart && !config.allow_vote_mode && !src.client.holder)
//	boutput(src, SPAN_ALERT("Player voting disabled."))
//	return
if(!ticker)
	boutput(src, SPAN_ALERT("Can not start votes before the game starts."))
	return
if(!vote_manager) return //shits hitting the fan at ludicrous speeds
if(vote_manager.active_vote) vote_manager.show_vote(src.client)
else
	if(src.ckey in vote_log)
		if(vote_log[src.ckey] < max_votes_per_round)
			if(vote_manager.show_vote_selection(src.client)) vote_log[src.ckey]++
		else
			boutput(src, SPAN_ALERT("You may not start any more votes this round. (Maximum reached : [max_votes_per_round])"))
	else
		if(vote_manager.show_vote_selection(src.client)) vote_log[src.ckey] = 1

vpn_bonk

boots player and displays VPN message