Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Character asset names documentation #573

Open
GoldenGnu opened this issue Sep 26, 2017 · 3 comments
Open

Character asset names documentation #573

GoldenGnu opened this issue Sep 26, 2017 · 3 comments

Comments

@GoldenGnu
Copy link
Member

GoldenGnu commented Sep 26, 2017

Route

https://esi.tech.ccp.is/latest/#!/Assets/post_characters_character_id_assets_names

Example returns

Any item that can not have a name in-game (modules, packaged ships, etc.):

[
  {
    "item_id": 1000527721812,
    "name": "None"
  }
]

Any item that can have a in-game name, but, does not have a name set

[
  {
    "item_id": 1004329142345,
    "name": ""
  }
]

Any item that have a in-game name, will return the name.

[
  {
    "item_id": 120677503,
    "name": "GoldenGnu's Amarr Shuttle"
  }
]

Note: GoldenGnu's Amarr Shuttle is an example value

Reference:

This is all the asset types I know works:

(asset.group == "Audit Log Secure Container"
|| asset.group == "Cargo Container"
|| asset.group == "Freight Container"
|| asset.group == "Secure Cargo Container"
|| asset.group == "Biomass"
|| asset.category == "Deployable"
|| asset.category == "Ship"
|| asset.category == "Structure")
&& asset.isSingleton() //Only unpacked assets can have a name, this is true for all the groups and categories
@aquarhead aquarhead self-assigned this Sep 26, 2017
@aquarhead
Copy link

Let me think about this a bit...

@aquarhead aquarhead added the TODO label Sep 26, 2017
@aquarhead aquarhead changed the title https://esi.tech.ccp.is/latest/#!/Assets/post_characters_character_id_assets_names documentation Character asset names documentation Sep 26, 2017
@Aidansavage
Copy link

Would it be easier to have it return "Cannot have a name" for those that cannot be given names, and "Name not set" for things that can be given names?

That being said, unless TechCo wants people to be able to hide containers and the like by purposely naming them something that matches the "cant have a name" return, it might be worth also adding another return that specifies whether the item's nameable as a true/false value. This would let people read through assets for the "is_nameable" return, and then pull out the names, rather than reading off the "name" field and hoping players arent getting creative with names.

@GoldenGnu
Copy link
Member Author

GoldenGnu commented Sep 26, 2017

The best options for me:

  1. Make name optional and only return it if the item have a name set in-game
  2. Do not return anything for items that does not have a name set in-game (no itemID and no name)
  3. Do not change the endpoint (it may not be perfect, but, it works just fine, if you only use it for stuff that can have names: unpacked containers and ships, the “” (empty string) return is perfect for stuff that does not have a name)

@aquarhead aquarhead removed their assignment Oct 22, 2017
@CarbonAlabel CarbonAlabel added in-backlog Issue has been accepted, but is considered low priority. and removed TODO labels May 22, 2018
@steven-noorbergen steven-noorbergen removed the in-backlog Issue has been accepted, but is considered low priority. label Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants