diff --git a/as3/server/clothing.md b/as3/server/clothing.md new file mode 100644 index 0000000..f126c7d --- /dev/null +++ b/as3/server/clothing.md @@ -0,0 +1,123 @@ +# Clothing +##### Messages that handle clothing updates of penguins in a room. +--- +### Update Color +Sent to all penguins in a room to show a penguin's new color when they change their current one. + +`upc` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upc%0%123%1%` + +### Update Head +Sent to all penguins in a room to show a penguin's new head item when they change their current one. + +`uph` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%uph%0%123%1%` + +### Update Face +Sent to all penguins in a room to show a penguin's new face item when they change their current one. + +`upf` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upf%0%123%1%` + +### Update Neck +Sent to all penguins in a room to show a penguin's new neck item when they change their current one. + +`upn` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upn%0%123%1%` + +### Update Body +Sent to all penguins in a room to show a penguin's new body item when they change their current one. + +`upb` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upb%0%123%1%` + +### Update Hands +Sent to all penguins in a room to show a penguin's new hand item when they change their current one. + +`upa` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upa%0%123%1%` + +### Update Feet +Sent to all penguins in a room to show a penguin's new feet item when they change their current one. + +`upe` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upe%0%123%1%` + +### Update Photo +Sent to all penguins in a room to show a penguin's new playercard photo/background when they change their current one. + +This has no visible changes on the client unless you have the penguin's playercard open at the time, but the client will keep track of it. + +`upp` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upp%0%123%1%` + +### Update Pin +Sent to all penguins in a room to show a penguin's new playercard pin when they change their current one. + +This has no visible changes on the client unless you have the penguin's playercard open at the time, but the client will keep track of it. + +`upl` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|itemID|Unsigned integer|No| + +##### Example +`%xt%upl%0%123%1%` diff --git a/as3/server/inventory.md b/as3/server/inventory.md new file mode 100644 index 0000000..c7d8f91 --- /dev/null +++ b/as3/server/inventory.md @@ -0,0 +1,71 @@ +# Inventory +##### Messages that pertain to users' items inventory functions. +--- +### Query Player Awards +Sent to clients when they request a penguin's awards. + +`qpa` + +|Argument|Type|Variadic?| +|---|---|---| +|awards|Array of awards information|Yes| + +##### `awards` Argument Table +Format: `awardID|creationDate|memberStatus` + +|Argument|Type| +|---|---| +|awardID|Unsigned integer| +|creationDate|Timestamp| +|memberStatus|Boolean integer (0, 1)| + +##### Example +`%xt%qpa%0%801|1151614800|0%802|1151614800|1%` + +### Query Player Pins +Sent to clients when they request a penguin's pins. + +`qpp` + +|Argument|Type|Variadic?| +|---|---|---| +|pins|Array of pins information|Yes| + +##### `pins` Argument Table +Format: `pinID|creationDate|memberStatus` + +|Argument|Type| +|---|---| +|pinID|Unsigned integer| +|creationDate|Timestamp| +|memberStatus|Boolean integer (0, 1)| + +##### Example +`%xt%qpp%0%550|1142553600|0%551|1143763200|1%` + +### Get Inventory +Sent to clients when they request their penguin's items. + +`gi` + +|Argument|Type|Variadic?| +|---|---|---| +|itemID|Unsigned integer|Yes| + +##### Example +`%xt%gi%0%413%414%567%` + +### Add Item +Sent to clients after an item gets added to their penguin's inventory. + +The new penguin's coin balance is sent for items that have a cost. + +`ai` + +|Argument|Type|Variadic?| +|---|---|---| +|itemID|Unsigned integer|No| +|newCoins|Unsigned integer|No| + +##### Example +`%xt%ai%0%413%5000%` diff --git a/as3/server/player.md b/as3/server/player.md new file mode 100644 index 0000000..1626535 --- /dev/null +++ b/as3/server/player.md @@ -0,0 +1,101 @@ +# Player +##### Messages pertaining to actions performed by penguin avatars. +--- +### Send Frame +Sent to all penguins in a room to update a player frame. + +`sf` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|frame|Unsigned integer|No| + +##### Example +`%xt%sf%0%123%5%` + +### Send Move +Sent to all penguins in a room to update a player location. +The client will animate moving the penguin from positionX to positionY. + +`sp` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|positionX|Unsigned integer|No| +|positionY|Unsigned integer|No| + +##### Example +`%xt%sp%0%123%0%0%` + +### Send Throw Snowball +Sent to all penguins in a room to show a snowball thrown by a penguin. + +The client will animate throwing a snowball from positionX to positionY. + +`sb` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|positionX|Unsigned integer|No| +|positionY|Unsigned integer|No| + +##### Example +`%xt%sb%0%123%0%0%` + + +### Send Emote +Sent to all penguins in a room to show an emote sent by a penguin. + +`se` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|emoteID|Unsigned integer|No| + +##### Example +`%xt%se%0%123%3%` + +### Send Joke +Sent to all penguins in a room to show a joke said by a penguin. + +`sj` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|jokeID|Unsigned integer|No| + +##### Example +`%xt%sj%0%123%3%` + + +### Send Message +Sent to all penguins in a room to show a message said by a penguin. + +`sm` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|message|String|No| + +##### Example +`%xt%sm%0%123%Hello%` + + +### Send Safe Message +Sent to all penguins in a room to show a safe message said by a penguin. + +`ss` + +|Argument|Type|Variadic?| +|---|---|---| +|penguinID|Unsigned integer|No| +|safeMessageID|Unsigned integer|No| + +##### Example +`%xt%ss%0%123%5%` diff --git a/as3/server/system.md b/as3/server/system.md new file mode 100644 index 0000000..362d904 --- /dev/null +++ b/as3/server/system.md @@ -0,0 +1,15 @@ +# System +##### Messages that take care of unseen background logic unknown to the user. +--- +### Heartbeat +Sent from the server in response to a client heartbeat/ping. +This message has no arguments, but the __internal room ID__ is still required. + +`h` + +|Argument|Type|Variadic?| +|---|---|---| +|None|N/A|N/A| + +##### Example +`%xt%h%0%`