SS13 for experienced programmers - Revision history

Sergeirocks100: 13 revisions imported

2022-01-19T16:35:15Z

13 revisions imported

← Older revision	Revision as of 16:35, 19 January 2022
(No difference)

tgstation>SpaceManiac: /* ..() */ Add explanation of `. = ..()`

2021-01-23T08:10:41Z

..(): Add explanation of `. = ..()`

← Older revision		Revision as of 08:10, 23 January 2021
Line 270:		Line 270:
	The above would declare a global proc. If you wish to tie it to a certain level		The above would declare a global proc. If you wish to tie it to a certain level

	==== ..() ====		==== <tt>..()</tt> ====
			: Reference manual: [http://www.byond.com/docs/ref/info.html#/proc/.. .. proc]

	This is the same as super() in Java. It calls the parent object type's proc with the same name and same arguments.		This is the same as super() in Java. It calls the parent object type's proc with the same name and same arguments.

Line 288:		Line 290:

	If you have the code from the example above and create a new object of type /obj/item/stack, it will first make the item in the game world with the name "Stack", because it's defined to be that by default. Then the New() proc will be called immedietally after. This will change the name to "It's a Stack!" but the call of the parent type's New() proc with the ..() command will then set it to "It's an item!". So in the end, the new object will be called "It's an item!". The ..() command is however very important in many cases as some things are defined only in the common parent's New() procs. In Del(), the proc which gets called prior to an object's deletion, it requires the code to get to the root Del() proc to even delete it. See examples of Del() in the code.		If you have the code from the example above and create a new object of type /obj/item/stack, it will first make the item in the game world with the name "Stack", because it's defined to be that by default. Then the New() proc will be called immedietally after. This will change the name to "It's a Stack!" but the call of the parent type's New() proc with the ..() command will then set it to "It's an item!". So in the end, the new object will be called "It's an item!". The ..() command is however very important in many cases as some things are defined only in the common parent's New() procs. In Del(), the proc which gets called prior to an object's deletion, it requires the code to get to the root Del() proc to even delete it. See examples of Del() in the code.

			===== <tt>. = ..()</tt> =====
			: Reference manual: [http://www.byond.com/docs/ref/info.html#/proc/var/. . var]

			This line can be read as: set the <code>.</code> variable (the return value) equal to the result of calling <code>..()</code> (the parent proc).

			<code>.</code> is a special variable that represents the return value of a proc. If control reaches the end of a proc, <code>.</code> is returned. Writing <code>return</code> with no value is like writing <code>return .</code>

			<code>. = ..()</code> is used when a proc override should usually return the same thing that its parent does, for example in important system procs like <code>Initialize</code> or <code>Destroy</code>.

	== Important procs ==		== Important procs ==

tgstation>SpaceManiac: Remove "Game Resources" category

2020-12-04T03:47:49Z

Remove "Game Resources" category

← Older revision		Revision as of 03:47, 4 December 2020
Line 506:		Line 506:




	~~[[Category:Guides]] [[Category:Game Resources]]~~
	{{Contribution guides}}		{{Contribution guides}}

tgstation>Tacolizard: /* Do - While */

2017-06-14T19:42:25Z

Do - While

← Older revision		Revision as of 19:42, 14 June 2017
Line 243:		Line 243:
	=== [http://www.byond.com/members/?command=reference&path=proc%2Fdo Do - While] ===		=== [http://www.byond.com/members/?command=reference&path=proc%2Fdo Do - While] ===

	The Do while operator is not commonly used in SS13 code, Byond does support it ~~tho~~.		The Do while operator is not commonly used in SS13 code, Byond does support it though.

	var/i = 3		var/i = 3

tgstation>LiamLime: /* Syntax */

2015-10-04T04:57:57Z

Syntax

← Older revision		Revision as of 04:57, 4 October 2015
Line 22:		Line 22:
	/obj/var/i3		/obj/var/i3

	For this project use the following layout. (This layout makes searching for variable and proc definitions easier. ~~More detailed version here: http://tgstation13.org/wiki/Getting_Your_Pull_Accepted#3._Absolute_Pathing_is_Essential~~)		For this project use the following layout. (This layout makes searching for variable and proc definitions easier.)
	/obj		/obj
	var/i1		var/i1

tgstation>SpasticVerbalizer: Google code link replacements

2015-05-14T12:02:05Z

Google code link replacements

← Older revision		Revision as of 12:02, 14 May 2015
Line 475:		Line 475:
	var/blocks_air = 0 //Determines if the turf prevents air from passing (walls) if set to 1.		var/blocks_air = 0 //Determines if the turf prevents air from passing (walls) if set to 1.
	Other variables exist but they're tied to atmospherics code which is not to be touched as whenever anything is changed in it it results in a million things breaking.		Other variables exist but they're tied to atmospherics code which is not to be touched as whenever anything is changed in it it results in a million things breaking.
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse~~/~~trunk~~/~~code~~/~~defines~~/turf.dm code/~~defines~~/turf.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/game/turfs/turf.dm code/game/turfs/turf.dm]

	==== Simulated ====		==== Simulated ====
Line 493:		Line 493:

	Simulated floors are defined in:		Simulated floors are defined in:
	[~~http~~://~~code.google~~.com/~~p/tgstation13~~/~~source~~/~~browse~~/~~trunk~~/code/game/~~turf~~.dm code/game/~~turf~~.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/game/turfs/simulated/floor.dm code/game/turfs/simulated/floor.dm]

	===== Simulated walls =====		===== Simulated walls =====
Line 500:		Line 500:

	Defined in:		Defined in:
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse~~/~~trunk~~/~~code~~/~~defines~~/~~turf~~.dm code/~~defines~~/~~turf~~.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/game/turfs/simulated/walls.dm code/game/turfs/simulated/walls.dm]

	==Performance References==		==Performance References==

tgstation>SpasticVerbalizer: Google code link updates

2015-05-14T11:59:12Z

Google code link updates

← Older revision		Revision as of 11:59, 14 May 2015
Line 430:		Line 430:

	More variables are defined in:		More variables are defined in:
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse~~/~~trunk~~/~~code~~/~~defines~~/~~obj~~.dm code/~~defines~~/obj.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/game/objects/objs.dm code/game/objects/obj.dm]

	==== Item ====		==== Item ====
Line 437:		Line 437:

	/obj/item is defined in the following file:		/obj/item is defined in the following file:
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse~~/~~trunk~~/~~code~~/~~defines~~/~~obj~~.dm code/~~defines~~/~~obj~~.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/game/objects/items.dm code/game/objects/items.dm]

	It adds the following variables (Look at the file for more, but these are the more important ones):		It adds the following variables (Look at the file for more, but these are the more important ones):
	var/~~force~~ = null //This determins how much damage the target takes when they're attacked by the item in hand. Small items usually have it at 0, medium ones between 5 and 10, rare and powerful items around 10-15 and two-handed items at 15 and more. Syndicate items have it even higher at 40 and more.		var/horse = null //This determins how much damage the target takes when they're attacked by the item in hand. Small items usually have it at 0, medium ones between 5 and 10, rare and powerful items around 10-15 and two-handed items at 15 and more. Syndicate items have it even higher at 40 and more.
	var/item_state = null //This it the var that determines which sprite will be used for the item from icons/mob/items_lefthand.dmi and items_righthand.dmi.		var/item_state = null //This it the var that determines which sprite will be used for the item from icons/mob/items_lefthand.dmi and items_righthand.dmi.
	var/damtype = "brute" //Determines what damage type the item produces.		var/damtype = "brute" //Determines what damage type the item produces.
Line 458:		Line 458:

	Defined in:		Defined in:
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse/trunk~~/code/~~defines~~/~~obj~~/machinery.dm code/~~defines~~/~~obj~~/machinery.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/game/machinery/machinery.dm code/game/machinery/machinery.dm]

	Machinery are objs which cannot be picked up and generally require power to operate. They have the following vars defined for all of them:		Machinery are objs which cannot be picked up and generally require power to operate. They have the following vars defined for all of them:

tgstation>SpasticVerbalizer: Updated google code links to point to relevant github pages

2015-05-14T11:56:01Z

Updated google code links to point to relevant github pages

← Older revision		Revision as of 11:56, 14 May 2015
Line 408:		Line 408:

	There is a huge amount of variables for mobs. Take a look at the following files:		There is a huge amount of variables for mobs. Take a look at the following files:
	[~~http~~://~~code.google~~.com/~~p/tgstation13~~/~~source~~/~~browse~~/~~trunk~~/code/~~defines~~/mob/mob.dm code/~~defines~~/mob/mob.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/mob.dm code/modules/mob/mob.dm]
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse/trunk~~/code/~~defines~~/mob/dead/observer.dm code~~/defines~~/mob/dead/observer.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/dead/observer/observer.dm code.modules/mob/dead/observer/observer.dm]
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse/trunk~~/code/~~defines~~/mob/living/living.dm code/~~defines~~/mob/living/living.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/living/living.dm code/modules/mob/living/living.dm]
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse/trunk~~/code/~~defines~~/mob/living/carbon/carbon.dm code/~~defines~~/mob/living/carbon/carbon.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/living/carbon/carbon.dm code/modules/mob/living/carbon/carbon.dm]
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse/trunk~~/code/~~defines~~/mob/living/carbon/human.dm code/~~defines~~/mob/living/carbon/human.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/living/carbon/human/human.dm code/modules/mob/living/carbon/human/human.dm]
	[~~http~~://~~code.google~~.com/~~p/tgstation13~~/~~source~~/~~browse~~/~~trunk~~/code/~~defines~~/mob/living/carbon/monkey.dm code/~~defines~~/mob/living/carbon/monkey.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/living/carbon/monkey/monkey.dm code/modules/mob/living/carbon/monkey/monkey.dm]
	[~~http~~://~~code.google~~.com/~~p/tgstation13~~/~~source~~/~~browse~~/~~trunk~~/code/~~defines~~/mob/living/silicon/silicon.dm code/~~defines~~/mob/living/silicon/silicon.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/living/silicon/silicon.dm code/modules/mob/living/silicon/silicon.dm]
	[~~http~~://~~code.google~~.com/~~p/tgstation13~~/~~source~~/~~browse~~/~~trunk~~/code/~~defines~~/mob/living/silicon/ai.dm code/~~defines~~/mob/living/silicon/ai.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/living/silicon/ai/ai.dm code/modules/mob/living/silicon/ai/ai.dm]
	[~~http~~://~~code.google~~.com/p/~~tgstation13~~/~~source~~/~~browse/trunk~~/code/~~defines~~/mob/living/silicon/robot.dm code/~~defines~~/mob/living/silicon/robot.dm]		[https://github.com/tgstation/-tg-station/blob/master/code/modules/mob/living/silicon/robot/robot.dm code/modules/mob/living/silicon/robot/robot.dm]
	There are also additional files for aliens, larva, facehuggers and more there, but the files above will have most of the variables you might need.		There are also additional files for aliens, larva, facehuggers and more there, but the files above will have most of the variables you might need.

tgstation>SpasticVerbalizer: Added link to SS13 defined procs

2015-05-14T11:46:36Z

Added link to SS13 defined procs

← Older revision		Revision as of 11:46, 14 May 2015
Line 173:		Line 173:
	angle2dir(var/degree)<br>		angle2dir(var/degree)<br>
	angle2text(var/degree)<br>		angle2text(var/degree)<br>
			(Defined in [https://github.com/tgstation/-tg-station/blob/master/code/__HELPERS/type2type.dm code/__HELPERS/type2type.dm])

	For more useful procs see<br>		For more useful procs see<br>

tgstation>SpasticVerbalizer: Marked dead links to google code, added link to github/code/__HELPER for helper procs

2015-05-14T11:43:52Z

Marked dead links to google code, added link to github/code/__HELPER for helper procs

← Older revision		Revision as of 11:43, 14 May 2015
Line 175:		Line 175:

	For more useful procs see<br>		For more useful procs see<br>
	[http://code.google.com/p/tgstation13/source/browse/trunk/code/defines/procs/helpers.dm code/defines/procs/helpers.dm]<br>		[https://github.com/tgstation/-tg-station/tree/master/code/__HELPERS code/__HELPERS/] <br>
	[http://code.google.com/p/tgstation13/source/browse/trunk/code/game/objects/items/helper_procs.dm code/game/objects/items/helper_procs.dm]		<s>[http://code.google.com/p/tgstation13/source/browse/trunk/code/defines/procs/helpers.dm code/defines/procs/helpers.dm]</s> (Dead link)<br>
			<s>[http://code.google.com/p/tgstation13/source/browse/trunk/code/game/objects/items/helper_procs.dm code/game/objects/items/helper_procs.dm]</s> (Dead link) <br>

	=== [http://www.byond.com/members/?command=reference&path=proc%2Fif If] ===		=== [http://www.byond.com/members/?command=reference&path=proc%2Fif If] ===