<commit_before>.. include:: ./vars.rst

Embeds
======

Embeds are parts of Messages that are sort-of like a preview. They are created serverside by Discord, so in real-time they would come through as part of a `messageUpdate` event. When grabbing messages from logs, they will already be embedded as part of the array ``message.embeds``.

All the Embed classes extend ``Discord.Embed``.

Link Embed
----------

A Link Embed is an embed showing a preview of any linked site in a message.

Attributes
~~~~~~~~~~

.. code-block:: js

	{
		url, // the URL of the link
		type : "link",
		title, // title of the embed/URL
		thumbnail : {
			width, // the width of the thumbnail in pixels
			height, // the height of the thumbnail in pixels
			url, // the direct URL to the thumbnail
			proxy_url, // a proxy URL to the thumbnail
		},
		provider : {
			url, // ???
			name, // ???
		},
		description, // description of the embed
		author : {
			url, // URL to the author (if any)
			name // name of the author (if any)
		}
	}
	

Image Embed
-----------

An Image Embed shows an image of a referenced link

Attributes
~~~~~~~~~~

.. code-block:: js

	{
		url, // the URL of the image
		type : "image",
		title, // title of the embed/image
		thumbnail : {
			width, // the width of the thumbnail in pixels
			height, // the height of the thumbnail in pixels
			url, // the direct URL to the thumbnail
			proxy_url, // a proxy URL to the thumbnail
		},
		provider : {
			url, // ???
			name, // ???
		},
		description, // description of the embed
		author : {
			url, // URL to the author (if any)
			name // name of the author (if any)
		}
	}
	

Video Embed
-----------

A Video Embed embeds videos (e.g. youtube)

Attributes
~~~~~~~~~~

.. code-block:: js

	{
		url, // the URL of the image
		type : "image",
		title, // title of the embed/image
		thumbnail : {
			width, // the width of the thumbnail in pixels
			height, // the height of the thumbnail in pixels
			url, // the direct URL to the thumbnail
			proxy_url, // a proxy URL to the thumbnail
		},
		provider : {
			url, // ???
			name, // ???
		},
		description, // description of the embed
		author : {
			url, // URL to the author (if any)
			name // name of the author (if any)
		},
		video : {
			width, // the width of the embedded video player
			height, // the height of the embedded video player
			url // the URL of the embedded play
		}
	}<commit_msg>Fixed embed docs<commit_after>.. include:: ./vars.rst

Embeds
======

Embeds are parts of Messages that are sort-of like a preview. They are created serverside by Discord, so in real-time they would come through as part of a `messageUpdate` event. When grabbing messages from logs, they will already be embedded as part of the array ``message.embeds``.

All the Embed classes extend ``Discord.Embed``.

Link Embed
----------

A Link Embed is an embed showing a preview of any linked site in a message.

Attributes
~~~~~~~~~~

.. code-block:: js

	{
		url, // the URL of the link
		type : "link",
		title, // title of the embed/URL
		thumbnail : {
			width, // the width of the thumbnail in pixels
			height, // the height of the thumbnail in pixels
			url, // the direct URL to the thumbnail
			proxy_url, // a proxy URL to the thumbnail
		},
		provider : {
			url, // ???
			name, // ???
		},
		description, // description of the embed
		author : {
			url, // URL to the author (if any)
			name // name of the author (if any)
		}
	}
	

Image Embed
-----------

An Image Embed shows an image of a referenced link

Attributes
~~~~~~~~~~

.. code-block:: js

	{
		url, // the URL of the image
		type : "image",
		title, // title of the embed/image
		thumbnail : {
			width, // the width of the thumbnail in pixels
			height, // the height of the thumbnail in pixels
			url, // the direct URL to the thumbnail
			proxy_url, // a proxy URL to the thumbnail
		},
		provider : {
			url, // ???
			name, // ???
		},
		description, // description of the embed
		author : {
			url, // URL to the author (if any)
			name // name of the author (if any)
		}
	}
	

Video Embed
-----------

A Video Embed embeds videos (e.g. youtube)

Attributes
~~~~~~~~~~

.. code-block:: js

	{
		url, // the URL of the video
		type : "video",
		title, // title of the embed/video
		thumbnail : {
			width, // the width of the thumbnail in pixels
			height, // the height of the thumbnail in pixels
			url, // the direct URL to the thumbnail
			proxy_url, // a proxy URL to the thumbnail
		},
		provider : {
			url, // ???
			name, // ???
		},
		description, // description of the embed
		author : {
			url, // URL to the author (if any)
			name // name of the author (if any)
		},
		video : {
			width, // the width of the embedded video player
			height, // the height of the embedded video player
			url // the URL of the embedded play
		}
	}
{'fraction_non_alphanumeric': 0.12833781825708962, 'fraction_numerical': 0.0, 'mean_word_length': 2.330117160578911, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3581255', 'n_tokens_mistral': 1676, 'n_tokens_neox': 1473, 'n_words': 660}